schemacrawler.tools.lint

Class Linter

java.lang.Object

schemacrawler.tools.lint.Linter

Direct Known Subclasses:

BaseLinter

public abstract class Linter
extends java.lang.Object

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.

Author:

Sualeh Fatehi

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

exceedsThreshold

public final boolean exceedsThreshold()

getDescription

public java.lang.String getDescription()

Gets a lengthy description of the linter. By default, reads a resource file called /help/.txt and if that is not present, returns the summary. Can be overridden.

Returns:

Lengthy description of the linter

getLintCount

public final int getLintCount()

Gets the number of lints produced by this linter.

Returns:

Lint counts

getLinterId

public java.lang.String getLinterId()

Gets the identification of this linter.

Returns:

Identification of this linter

getLinterInstanceId

public final java.lang.String getLinterInstanceId()

Gets the identification of this linter instance.

Returns:

Identification of this linter instance

getSeverity

public final LintSeverity getSeverity()

Gets the severity of the lints produced by this linter.

Returns:

Severity of the lints produced by this linter

getSummary

public abstract java.lang.String getSummary()

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

Returns:

Brief summary of this linter

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object