Package com.github.victools.jsonschema.generator

Enum Class CustomDefinition.AttributeInclusion

java.lang.Object

java.lang.Enum<CustomDefinition.AttributeInclusion>

com.github.victools.jsonschema.generator.CustomDefinition.AttributeInclusion

All Implemented Interfaces:

Serializable, Comparable<CustomDefinition.AttributeInclusion>, Constable

Enclosing class:

CustomDefinition

public static enum CustomDefinition.AttributeInclusion
extends Enum<CustomDefinition.AttributeInclusion>

Indication whether the normal attribute collection should be performed and any attributes should be added to the custom definition.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
NO	Skip the attribute collection both for a specific field/method or the type in general if that's the level where this custom definition is being applied.
YES	Collect and add attributes both for a specific field/method as well as for the associated type in general.

Method Summary

Modifier and Type	Method	Description
static CustomDefinition.AttributeInclusion	valueOf(String name)	Returns the enum constant of this class with the specified name.
static CustomDefinition.AttributeInclusion[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

YES

public static final CustomDefinition.AttributeInclusion YES

Collect and add attributes both for a specific field/method as well as for the associated type in general.

NO

public static final CustomDefinition.AttributeInclusion NO

Skip the attribute collection both for a specific field/method or the type in general if that's the level where this custom definition is being applied. If this is a nested type/definition, a previous (custom) definition may have already decided something else.

Method Details

values

public static CustomDefinition.AttributeInclusion[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static CustomDefinition.AttributeInclusion valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null