zserio.tools

Class WarningsConfig

java.lang.Object

zserio.tools.WarningsConfig

public final class WarningsConfig
extends java.lang.Object

Class which keeps configuration of warnings subsystem.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WarningsConfig.WarningDefinition Definition of a single warning or a warning group.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CHOICE_UNHANDLED_ENUM_ITEM Option name for choice unhandled enumeration item warnings.
static java.lang.String	DEFAULT_INSTANTIATION Option name for default template instantiation warnings.
static java.lang.String	DOC_COMMENT_FORMAT Option name for documentation comment format warnings.
static java.lang.String	DOC_COMMENT_LINK Option name for documentation comment warnings related to links (e.g.
static java.lang.String	DOC_COMMENT_MISSING Option name for missing documentation comment warnings.
static java.lang.String	DOC_COMMENT_UNUSED Option name for unused documentation comments warnings.
static java.lang.String	ENCODING Option name for encoding warnings.
static java.lang.String	IMPORT Option name for import warnings.
static java.lang.String	OPTIONAL_FIELD_REFERENCE Option name for optional field references warnings.
static java.lang.String	SQL_PRIMARY_KEY Option name for SQL primary key warnings.
static java.lang.String	TIMESTAMP Option name for timestamp warnings.
static java.lang.String	UNPACKABLE_ARRAY Option name for unpackable array warnings.
static java.lang.String	UNPACKABLE_UNION Option name for arrays of unpackable unions warnings.
static java.lang.String	UNUSED Option name for unused type warnings.

Constructor Summary

Constructors

Constructor and Description
WarningsConfig() Default constructor which construct default configuration for warnings subsystem.
WarningsConfig(java.util.List<java.lang.String> enabledWarnings, java.util.List<java.lang.String> disabledWarnings) Constructor which takes list of explicitly enabled/disabled warnings.

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,WarningsConfig.WarningDefinition>	getWarningsDefinition() Gets definition of all warnings.
boolean	isEnabled(java.lang.String warningOption) Gets whether the given warning is enabled.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CHOICE_UNHANDLED_ENUM_ITEM

public static final java.lang.String CHOICE_UNHANDLED_ENUM_ITEM

Option name for choice unhandled enumeration item warnings.

See Also:

Constant Field Values

DEFAULT_INSTANTIATION

public static final java.lang.String DEFAULT_INSTANTIATION

Option name for default template instantiation warnings.

See Also:

Constant Field Values

DOC_COMMENT_FORMAT

public static final java.lang.String DOC_COMMENT_FORMAT

Option name for documentation comment format warnings.

See Also:

Constant Field Values

DOC_COMMENT_MISSING

public static final java.lang.String DOC_COMMENT_MISSING

Option name for missing documentation comment warnings.

See Also:

Constant Field Values

DOC_COMMENT_LINK

public static final java.lang.String DOC_COMMENT_LINK

Option name for documentation comment warnings related to links (e.g. see tag or markdown link).

See Also:

Constant Field Values

DOC_COMMENT_UNUSED

public static final java.lang.String DOC_COMMENT_UNUSED

Option name for unused documentation comments warnings.

See Also:

Constant Field Values

ENCODING

public static final java.lang.String ENCODING

Option name for encoding warnings.

See Also:

Constant Field Values

IMPORT

public static final java.lang.String IMPORT

Option name for import warnings.

See Also:

Constant Field Values

OPTIONAL_FIELD_REFERENCE

public static final java.lang.String OPTIONAL_FIELD_REFERENCE

Option name for optional field references warnings.

See Also:

Constant Field Values

TIMESTAMP

public static final java.lang.String TIMESTAMP

Option name for timestamp warnings.

See Also:

Constant Field Values

SQL_PRIMARY_KEY

public static final java.lang.String SQL_PRIMARY_KEY

Option name for SQL primary key warnings.

See Also:

Constant Field Values

UNPACKABLE_ARRAY

public static final java.lang.String UNPACKABLE_ARRAY

Option name for unpackable array warnings.

See Also:

Constant Field Values

UNPACKABLE_UNION

public static final java.lang.String UNPACKABLE_UNION

Option name for arrays of unpackable unions warnings.

See Also:

Constant Field Values

UNUSED

public static final java.lang.String UNUSED

Option name for unused type warnings.

See Also:

Constant Field Values

Constructor Detail

WarningsConfig

public WarningsConfig()

Default constructor which construct default configuration for warnings subsystem.

WarningsConfig

public WarningsConfig(java.util.List<java.lang.String> enabledWarnings,
                      java.util.List<java.lang.String> disabledWarnings)
               throws org.apache.commons.cli.ParseException

Constructor which takes list of explicitly enabled/disabled warnings.

Parameters:

enabledWarnings - Explicitly enabled warnings.

disabledWarnings - Explicitly disabled warnings.

Throws:

org.apache.commons.cli.ParseException - In case of invalid warnings options.

Method Detail

isEnabled

public boolean isEnabled(java.lang.String warningOption)

Gets whether the given warning is enabled.

Parameters:

warningOption - Warning option to check.

Returns:

True when the specified warning is enabled, false otherwise.

getWarningsDefinition

public java.util.Map<java.lang.String,WarningsConfig.WarningDefinition> getWarningsDefinition()

Gets definition of all warnings.

Returns:

Map of all defined warnings options.