Package com.github.victools.jsonschema.generator

Class CustomDefinition

java.lang.Object

com.github.victools.jsonschema.generator.CustomDefinition

Direct Known Subclasses:

CustomPropertyDefinition

public class CustomDefinition
extends Object

The result of a custom definition look-up.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	CustomDefinition.AttributeInclusion	Indication whether the normal attribute collection should be performed and any attributes should be added to the custom definition.
static enum	CustomDefinition.DefinitionType	Indication whether a custom definition should always be inlined or follow the standard behaviour.

Field Summary

Fields

Modifier and Type	Field	Description
static final CustomDefinition.AttributeInclusion	EXCLUDING_ATTRIBUTES	Alternative accessor for CustomDefinition.AttributeInclusion.NO.
static final CustomDefinition.AttributeInclusion	INCLUDING_ATTRIBUTES	Alternative accessor for CustomDefinition.AttributeInclusion.YES.
static final CustomDefinition.DefinitionType	INLINE_DEFINITION	Alternative accessor for CustomDefinition.DefinitionType.INLINE.

Constructor Summary

Constructors

Constructor	Description
CustomDefinition(tools.jackson.databind.node.ObjectNode value)	Constructor for a custom definition that should follow the standard behaviour in regards to be inlined or mentioned in the "definitions".
CustomDefinition(tools.jackson.databind.node.ObjectNode value, boolean meantToBeInline)	Constructor for a custom definition.
CustomDefinition(tools.jackson.databind.node.ObjectNode value, CustomDefinition.DefinitionType definitionType, CustomDefinition.AttributeInclusion attributeInclusion)	Constructor for a custom definition.

Method Summary

Modifier and Type	Method	Description
CustomDefinition.AttributeInclusion	getAttributeInclusion()	Getter for the associated extent of additional attributes being collected and applied.
CustomDefinition.DefinitionType	getDefinitionType()	Getter for the associated definition type.
tools.jackson.databind.node.ObjectNode	getValue()	Getter for the actual custom definition.
final boolean	isMeantToBeInline()	Getter for the flag indicating whether this custom definition should be inlined even if it occurs multiple times.
final boolean	shouldAlwaysProduceDefinition()	Getter for the flag indicating whether this custom definition should always be included in the SchemaKeyword.TAG_DEFINITIONS even if it occurs only once.
boolean	shouldIncludeAttributes()	Check whether this custom definition allows for additional attributes being collected and applied.

Methods inherited from class java.lang.Object

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

Field Details

INLINE_DEFINITION

public static final CustomDefinition.DefinitionType INLINE_DEFINITION

Alternative accessor for CustomDefinition.DefinitionType.INLINE.

INCLUDING_ATTRIBUTES

public static final CustomDefinition.AttributeInclusion INCLUDING_ATTRIBUTES

Alternative accessor for CustomDefinition.AttributeInclusion.YES.

EXCLUDING_ATTRIBUTES

public static final CustomDefinition.AttributeInclusion EXCLUDING_ATTRIBUTES

Alternative accessor for CustomDefinition.AttributeInclusion.NO.

Constructor Details

CustomDefinition

public CustomDefinition(tools.jackson.databind.node.ObjectNode value)

Constructor for a custom definition that should follow the standard behaviour in regards to be inlined or mentioned in the "definitions".

Parameters:

value - generated custom definition

CustomDefinition

public CustomDefinition(tools.jackson.databind.node.ObjectNode value,
 boolean meantToBeInline)

Constructor for a custom definition.

Parameters:

value - generated custom definition

meantToBeInline - whether the definition should be inlined even if it occurs multiple times; otherwise applying standard behaviour

CustomDefinition

public CustomDefinition(tools.jackson.databind.node.ObjectNode value,
 CustomDefinition.DefinitionType definitionType,
 CustomDefinition.AttributeInclusion attributeInclusion)

Constructor for a custom definition.

Parameters:

value - generated custom definition

definitionType - whether the definition should be inlined even if it occurs multiple times; otherwise applying standard behaviour

attributeInclusion - whether additional attributes should be applied on top of this custom definition

Method Details

getValue

public tools.jackson.databind.node.ObjectNode getValue()

Getter for the actual custom definition.

Returns:

node containing the custom definition

getDefinitionType

public CustomDefinition.DefinitionType getDefinitionType()

Getter for the associated definition type.

Returns:

indication whether a custom definition should always be inlined or follow the standard behaviour

isMeantToBeInline

public final boolean isMeantToBeInline()

Getter for the flag indicating whether this custom definition should be inlined even if it occurs multiple times.

Returns:

whether this custom definition should be inlined even if it occurs multiple times

shouldAlwaysProduceDefinition

public final boolean shouldAlwaysProduceDefinition()

Getter for the flag indicating whether this custom definition should always be included in the SchemaKeyword.TAG_DEFINITIONS even if it occurs only once.

Returns:

whether an occurrence of this custom definition should always be replaced by a reference

Since:

4.27.0

getAttributeInclusion

public CustomDefinition.AttributeInclusion getAttributeInclusion()

Getter for the associated extent of additional attributes being collected and applied.

Returns:

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

shouldIncludeAttributes

public boolean shouldIncludeAttributes()

Check whether this custom definition allows for additional attributes being collected and applied.

Returns:

whether getAttributeInclusion() returns AttributeInclusion.YES