schemacrawler.tools.command.lint.options

Enum LintReportOutputFormat

java.lang.Object

java.lang.Enum<LintReportOutputFormat>

schemacrawler.tools.command.lint.options.LintReportOutputFormat

All Implemented Interfaces:

Serializable, Comparable<LintReportOutputFormat>, OutputFormat

public enum LintReportOutputFormat
extends Enum<LintReportOutputFormat>
implements OutputFormat

Enumeration for text format type.

Enum Constant Summary

Enum Constants

Enum Constant and Description
html
json
text
yaml

Method Summary

Modifier and Type	Method and Description
static LintReportOutputFormat	fromFormat(String format) Gets the value from the format.
String	getDescription()
String	getFormat()
List<String>	getFormats()
static boolean	isSupportedFormat(String format) Checks if the value of the format is supported.
String	toString()
static LintReportOutputFormat	valueOf(String name) Returns the enum constant of this type with the specified name.
static LintReportOutputFormat[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

text

public static final LintReportOutputFormat text

html

public static final LintReportOutputFormat html

json

public static final LintReportOutputFormat json

yaml

public static final LintReportOutputFormat yaml

Method Detail

values

public static LintReportOutputFormat[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (LintReportOutputFormat c : LintReportOutputFormat.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static LintReportOutputFormat valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

fromFormat

public static LintReportOutputFormat fromFormat(String format)

Gets the value from the format.

Parameters:

format - Text output format.

Returns:

TextOutputFormat

isSupportedFormat

public static boolean isSupportedFormat(String format)

Checks if the value of the format is supported.

Returns:

True if the format is a text output format

getDescription

public String getDescription()

Specified by:

getDescription in interface OutputFormat

getFormat

public String getFormat()

Specified by:

getFormat in interface OutputFormat

getFormats

public List<String> getFormats()

Specified by:

getFormats in interface OutputFormat

toString

public String toString()

Overrides:

toString in class Enum<LintReportOutputFormat>