org.rvpf.metadata.entity

Class AttributesDefEntity

Object

AbstractEntity

ValidatorDefEntity

AttributesDefEntity

All Implemented Interfaces:

Comparable<Entity>, Entity

public final class AttributesDefEntity
extends ValidatorDefEntity

Attributes definition entity.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AttributesDefEntity.Builder PropertyDef builder.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ELEMENT_NAME AttributesDef element name.
static String	ENTITY_PREFIX AttributesDef entity prefix.

Fields inherited from interface Entity

UUID_COMPARATOR

Method Summary

Modifier and Type	Method and Description
AttributesDefEntity	copy() Creates a copy of this entity.
Optional<AttributeDefEntity>	getAttributeDef(String name) Gets an attribute definition.
Collection<AttributeDefEntity>	getAttributeDefs() Gets the attribute definitions.
String	getElementName() Gets the entity element name.
String	getPrefix() Gets the class prefix.
String	getReferenceName() Gets the entity reference name.
String	getTarget() Gets this validator's target.
String	getUsage() Gets the usage.
static AttributesDefEntity.Builder	newBuilder() Returns a new builder.

Methods inherited from class ValidatorDefEntity

equals, hashCode, isHidden, isMultiple, setHidden, setMultiple

Methods inherited from class AbstractEntity

compareTo, getAttributes, getName, getNameInUpperCase, getThisLogger, getUUID, setName, setUUID, toString

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

ELEMENT_NAME

public static final String ELEMENT_NAME

AttributesDef element name.

See Also:

Constant Field Values

ENTITY_PREFIX

public static final String ENTITY_PREFIX

AttributesDef entity prefix.

See Also:

Constant Field Values

Method Detail

newBuilder

@Nonnull
 @CheckReturnValue
public static AttributesDefEntity.Builder newBuilder()

Returns a new builder.

Returns:

The new builder.

copy

public AttributesDefEntity copy()

Creates a copy of this entity.

Returns:

The copy.

getAttributeDef

@Nonnull
 @CheckReturnValue
public Optional<AttributeDefEntity> getAttributeDef(@Nonnull
                                                                                  String name)

Gets an attribute definition.

Parameters:

name - The attribute name.

Returns:

The attribute definition.

getAttributeDefs

@Nonnull
 @CheckReturnValue
public Collection<AttributeDefEntity> getAttributeDefs()

Gets the attribute definitions.

Returns:

The attribute definitions.

getElementName

public String getElementName()

Gets the entity element name.

The entity element is used to in the generation of the entity URI.

Returns:

The entity element name.

getPrefix

public String getPrefix()

Gets the class prefix.

Each concrete entity subclass has its own prefix which will be the same for all its instances. This prefix is used to avoid name collision between different classes in a common registry.

Returns:

The class prefix.

getReferenceName

public String getReferenceName()

Gets the entity reference name.

Returns:

The entity reference name.

getTarget

public String getTarget()

Gets this validator's target.

Specified by:

getTarget in class ValidatorDefEntity

Returns:

The validator's target.

getUsage

@Nonnull
 @CheckReturnValue
public String getUsage()

Gets the usage.

Returns:

The usage.