Package org.gcube.informationsystem.types.reference.properties

Enum PropertyDefinition.PropertyAttribute

java.lang.Object

java.lang.Enum<PropertyDefinition.PropertyAttribute>

org.gcube.informationsystem.types.reference.properties.PropertyDefinition.PropertyAttribute

All Implemented Interfaces:

Serializable, Comparable<PropertyDefinition.PropertyAttribute>

Enclosing interface:

PropertyDefinition

public static enum PropertyDefinition.PropertyAttribute
extends Enum<PropertyDefinition.PropertyAttribute>

Documents the fixed, schema-level attributes every property field carries in a Type Schema -- a glossary of the schema language itself, not a specific property's actual value (that is what PropertyDefinition's own getters return). Primarily consumed by documentation generation.

Enum Constant Summary

Enum Constants

Enum Constant	Description
DESCRIPTION	Human-readable documentation of the field's purpose.
MANDATORY	Whether the field key must be present in the JSON payload.
MIN_MAX	Numeric boundaries or length constraints for the property value.
NAME	The identifier of the property field.
READ_ONLY	Whether the property value is immutable after initial creation.
REGEX	A Regular Expression pattern validating the property value's string representation.
TYPE	The data type of the property.

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Returns a human-readable description of this attribute, e.g.
String	getLabel()	Returns the display label of this attribute, e.g.
static PropertyDefinition.PropertyAttribute	valueOf(String name)	Returns the enum constant of this type with the specified name.
static PropertyDefinition.PropertyAttribute[]	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

NAME

public static final PropertyDefinition.PropertyAttribute NAME

The identifier of the property field.

TYPE

public static final PropertyDefinition.PropertyAttribute TYPE

The data type of the property.

DESCRIPTION

public static final PropertyDefinition.PropertyAttribute DESCRIPTION

Human-readable documentation of the field's purpose.

MANDATORY

public static final PropertyDefinition.PropertyAttribute MANDATORY

Whether the field key must be present in the JSON payload.

READ_ONLY

public static final PropertyDefinition.PropertyAttribute READ_ONLY

Whether the property value is immutable after initial creation.

MIN_MAX

public static final PropertyDefinition.PropertyAttribute MIN_MAX

Numeric boundaries or length constraints for the property value.

REGEX

public static final PropertyDefinition.PropertyAttribute REGEX

A Regular Expression pattern validating the property value's string representation.

Method Detail

values

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

Returns:

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

valueOf

public static PropertyDefinition.PropertyAttribute 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

getLabel

public String getLabel()

Returns the display label of this attribute, e.g. for documentation generation.

Returns:

The label.

getDescription

public String getDescription()

Returns a human-readable description of this attribute, e.g. for documentation generation.

Returns:

The description.