Enum CustomDefinition.AttributeInclusion
- java.lang.Object
-
- java.lang.Enum<CustomDefinition.AttributeInclusion>
-
- com.github.victools.jsonschema.generator.CustomDefinition.AttributeInclusion
-
- All Implemented Interfaces:
Serializable
,Comparable<CustomDefinition.AttributeInclusion>
- 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.
-
-
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
All Methods Static Methods Concrete Methods Modifier and Type Method Description static CustomDefinition.AttributeInclusion
valueOf(String name)
Returns the enum constant of this type with the specified name.static CustomDefinition.AttributeInclusion[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
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 Detail
-
values
public static CustomDefinition.AttributeInclusion[] 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 (CustomDefinition.AttributeInclusion c : CustomDefinition.AttributeInclusion.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static CustomDefinition.AttributeInclusion 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 nameNullPointerException
- if the argument is null
-
-