Enum CustomDefinition.DefinitionType
- java.lang.Object
-
- java.lang.Enum<CustomDefinition.DefinitionType>
-
- com.github.victools.jsonschema.generator.CustomDefinition.DefinitionType
-
- All Implemented Interfaces:
Serializable
,Comparable<CustomDefinition.DefinitionType>
- Enclosing class:
- CustomDefinition
public static enum CustomDefinition.DefinitionType extends Enum<CustomDefinition.DefinitionType>
Indication whether a custom definition should always be inlined or follow the standard behaviour.
-
-
Enum Constant Summary
Enum Constants Enum Constant Description ALWAYS_REF
Always include this entry in theSchemaKeyword.TAG_DEFINITIONS
even if it is just referenced once.INLINE
Always inline an associated custom definition (with the potential risk of creating infinite loops).STANDARD
Follow the standard behaviour of being moved into theSchemaKeyword.TAG_DEFINITIONS
if it is being referenced multiple times orOption.DEFINITIONS_FOR_ALL_OBJECTS
is enabled.
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static CustomDefinition.DefinitionType
valueOf(String name)
Returns the enum constant of this type with the specified name.static CustomDefinition.DefinitionType[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
INLINE
public static final CustomDefinition.DefinitionType INLINE
Always inline an associated custom definition (with the potential risk of creating infinite loops).
-
STANDARD
public static final CustomDefinition.DefinitionType STANDARD
Follow the standard behaviour of being moved into theSchemaKeyword.TAG_DEFINITIONS
if it is being referenced multiple times orOption.DEFINITIONS_FOR_ALL_OBJECTS
is enabled. UnlessOption.INLINE_ALL_SCHEMAS
is enabled, forcing this to be inlined.
-
ALWAYS_REF
public static final CustomDefinition.DefinitionType ALWAYS_REF
Always include this entry in theSchemaKeyword.TAG_DEFINITIONS
even if it is just referenced once. This bypasses evenOption.INLINE_ALL_SCHEMAS
.- Since:
- 4.27.0
-
-
Method Detail
-
values
public static CustomDefinition.DefinitionType[] 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.DefinitionType c : CustomDefinition.DefinitionType.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.DefinitionType 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
-
-