org.rvpf.config.entity

Class PropertiesDefEntity

Object

AbstractEntity

ValidatorDefEntity

PropertiesDefEntity

All Implemented Interfaces:

Comparable<Entity>, Entity

public final class PropertiesDefEntity
extends ValidatorDefEntity

PropertiesDef entity.

Nested Class Summary

Nested classes/interfaces inherited from class ValidatorDefEntity

ValidatorDefEntity.Builder

Field Summary

Fields

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

Fields inherited from interface Entity

UUID_COMPARATOR

Constructor Summary

Constructors

Constructor and Description
PropertiesDefEntity() Constructs an instance.

Method Summary

Modifier and Type	Method and Description
boolean	addPropertiesDef(PropertiesDefEntity propertiesDef) Adds a child PropertiesDef.
boolean	addPropertyDef(PropertyDefEntity propertyDef) Adds a child PropertyDef.
PropertiesDefEntity	copy() Creates a copy of this entity.
boolean	equals(Object other) For two Entity to be equal, they must at least be instances of the same class, have the same UUID and name.
String	getElementName() Gets the entity element name.
String	getPrefix() Gets the class prefix.
Optional<PropertiesDefEntity>	getPropertiesDef(String name) Gets a child PropertiesDef.
Collection<PropertiesDefEntity>	getPropertiesDefs() Gets the collection of child PropertiesDef.
Optional<PropertyDefEntity>	getPropertyDef(String name) Gets a child PropertyDef.
Collection<PropertyDefEntity>	getPropertyDefs() Gets the collection of child PropertyDef.
String	getReferenceName() Gets the entity reference name.
String	getTarget() Gets this validator's target.
int	hashCode()
boolean	isValidated() Asks if the children are validated.
void	setValidated(boolean validated) Sets the validation indicator.

Methods inherited from class ValidatorDefEntity

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

PropertiesDef element name.

See Also:

Constant Field Values

ENTITY_PREFIX

public static final String ENTITY_PREFIX

PropertiesDef entity prefix.

See Also:

Constant Field Values

Constructor Detail

PropertiesDefEntity

public PropertiesDefEntity()

Constructs an instance.

Method Detail

addPropertiesDef

public boolean addPropertiesDef(@Nonnull
                                PropertiesDefEntity propertiesDef)

Adds a child PropertiesDef.

Parameters:

propertiesDef - The PropertiesDef.

Returns:

False when duplicate.

addPropertyDef

public boolean addPropertyDef(@Nonnull
                              PropertyDefEntity propertyDef)

Adds a child PropertyDef.

Parameters:

propertyDef - The PropertyDef.

Returns:

False when duplicate.

copy

public PropertiesDefEntity copy()

Creates a copy of this entity.

Returns:

The copy.

equals

public boolean equals(Object other)

For two Entity to be equal, they must at least be instances of the same class, have the same UUID and name.

Overrides:

equals in class ValidatorDefEntity

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.

getPropertiesDef

@Nonnull
 @CheckReturnValue
public Optional<PropertiesDefEntity> getPropertiesDef(@Nonnull
                                                                                    String name)

Gets a child PropertiesDef.

Parameters:

name - The name of the PropertiesDef.

Returns:

The optional PropertiesDef.

getPropertiesDefs

@Nonnull
 @CheckReturnValue
public Collection<PropertiesDefEntity> getPropertiesDefs()

Gets the collection of child PropertiesDef.

Returns:

The collection of child PropertiesDef.

getPropertyDef

@Nonnull
 @CheckReturnValue
public Optional<PropertyDefEntity> getPropertyDef(@Nonnull
                                                                                String name)

Gets a child PropertyDef.

Parameters:

name - The name of the PropertyDef.

Returns:

The optional PropertyDef.

getPropertyDefs

@Nonnull
 @CheckReturnValue
public Collection<PropertyDefEntity> getPropertyDefs()

Gets the collection of child PropertyDef.

Returns:

The collection of child PropertyDef.

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.

hashCode

public int hashCode()

Overrides:

hashCode in class ValidatorDefEntity

isValidated

@CheckReturnValue
public boolean isValidated()

Asks if the children are validated.

Returns:

True if the children are validated.

setValidated

public void setValidated(boolean validated)

Sets the validation indicator.

Parameters:

validated - The validation indicator.