schemacrawler.tools.lint

Class AbstractLinter

java.lang.Object

schemacrawler.tools.executable.BaseCommand<LinterConfig,Void>

schemacrawler.tools.lint.AbstractLinter

All Implemented Interfaces:

Callable<Void>, Command<LinterConfig,Void>, Linter

Direct Known Subclasses:

BaseLinter

public abstract class AbstractLinter
extends BaseCommand<LinterConfig,Void>
implements Linter

Evaluates a catalog and creates lints. This base class has core functionality for maintaining state, but not for visiting a catalog. Includes code for dispatching a linter.

Method Summary

Modifier and Type	Method and Description
void	configure(LinterConfig linterConfig)
boolean	exceedsThreshold()
String	getDescription()
int	getLintCount() Gets the number of lints produced by this linter.
String	getLinterId() Gets the identification of the linter.
String	getLinterInstanceId() Gets the identification of this linter instance.
LintSeverity	getSeverity() Gets the severity of the lints produced by this linter.
abstract String	getSummary() Gets a brief summary of this linter.
String	toString()

Methods inherited from class schemacrawler.tools.executable.BaseCommand

getCatalog, getCommandName, getConnection, initialize, setCatalog, setConnection

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface schemacrawler.tools.executable.Command

getCatalog, getCommandName, getConnection, initialize, setCatalog, setConnection, usesConnection

Methods inherited from interface java.util.concurrent.Callable

call

Method Detail

configure

public void configure(LinterConfig linterConfig)

Specified by:

configure in interface Command<LinterConfig,Void>

Overrides:

configure in class BaseCommand<LinterConfig,Void>

exceedsThreshold

public final boolean exceedsThreshold()

Specified by:

exceedsThreshold in interface Linter

getDescription

public String getDescription()

Specified by:

getDescription in interface Linter

getLintCount

public final int getLintCount()

Description copied from interface: Linter

Gets the number of lints produced by this linter.

Specified by:

getLintCount in interface Linter

Returns:

Lint counts

getLinterId

public String getLinterId()

Description copied from interface: Linter

Gets the identification of the linter. A linter can be instantiated multiple times with different configuration.

Specified by:

getLinterId in interface Linter

Returns:

Identification of the linter.

getLinterInstanceId

public final String getLinterInstanceId()

Description copied from interface: Linter

Gets the identification of this linter instance.

Specified by:

getLinterInstanceId in interface Linter

Returns:

Identification of this linter instance

getSeverity

public final LintSeverity getSeverity()

Description copied from interface: Linter

Gets the severity of the lints produced by this linter.

Specified by:

getSeverity in interface Linter

Returns:

Severity of the lints produced by this linter

getSummary

public abstract String getSummary()

Gets a brief summary of this linter. Needs to be overridden.

Specified by:

getSummary in interface Linter

Returns:

Brief summary of this linter

toString

public final String toString()

Overrides:

toString in class BaseCommand<LinterConfig,Void>