Package de.xima.fc.prompt.service.support

Enum ForbidOptionalPropertiesMode

java.lang.Object

java.lang.Enum<ForbidOptionalPropertiesMode>

de.xima.fc.prompt.service.support.ForbidOptionalPropertiesMode

All Implemented Interfaces:

Serializable, Comparable<ForbidOptionalPropertiesMode>

public enum ForbidOptionalPropertiesMode
extends Enum<ForbidOptionalPropertiesMode>

Mode that controls the behavior of the forbidOptionalProperties transform step.

Since:

8.5.0

See Also:

IJsonSchemaTransformerBuilder.forbidOptionalProperties(ForbidOptionalPropertiesMode)

Enum Constant Summary

Enum Constants

Enum Constant	Description
CONVERT_TO_NULLABLE	Converts all optional properties to required nullable properties, i.e. adds "null" to the list of types of each property
DROP	Drops (removes) all optional properties.
MARK_AS_REQUIRED	Marks all optional properties as required, via the JSON schema "required" keyword .

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

CONVERT_TO_NULLABLE

public static final ForbidOptionalPropertiesMode CONVERT_TO_NULLABLE

Converts all optional properties to required nullable properties, i.e. adds "null" to the list of types of each property. /*

DROP

public static final ForbidOptionalPropertiesMode DROP

Drops (removes) all optional properties.

MARK_AS_REQUIRED

public static final ForbidOptionalPropertiesMode MARK_AS_REQUIRED

Marks all optional properties as required, via the JSON schema "required" keyword .

Method Detail

values

public static ForbidOptionalPropertiesMode[] 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 (ForbidOptionalPropertiesMode c : ForbidOptionalPropertiesMode.values())
    System.out.println(c);

Returns:

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

valueOf

public static ForbidOptionalPropertiesMode 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 name

NullPointerException - if the argument is null