org.rvpf.metadata.entity

Class MetadataEntity

Object

AbstractEntity

MetadataEntity

All Implemented Interfaces:

Comparable<Entity>, Entity

Direct Known Subclasses:

GroupEntity, ParamsEntity

public abstract class MetadataEntity
extends AbstractEntity

Metadata entity.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MetadataEntity.Builder Builder.

Field Summary

Fields inherited from interface Entity

UUID_COMPARATOR

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MetadataEntity() Constructs an instance.
protected	MetadataEntity(MetadataEntity other) Constructs an instance from an other.
protected	MetadataEntity(Optional<String> name, Optional<UUID> uuid, Optional<KeyedGroups> attributes, Optional<Map<String,Text>> texts) Constructs an instance.

Method Summary

Modifier and Type	Method and Description
void	addText(Text text) Adds text.
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.
Optional<KeyedGroups>	getAttributes() Gets the attributes.
Optional<Attributes>	getAttributes(String usage) Gets the attributes for an usage.
Optional<Map<String,Text>>	getTexts() Gets the texts.
int	hashCode()
void	setAttributes(Optional<KeyedGroups> attributes) Sets attributes.

Methods inherited from class AbstractEntity

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

Methods inherited from class Object

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

Methods inherited from interface Entity

copy, getElementName, getPrefix, getReferenceName

Constructor Detail

MetadataEntity

protected MetadataEntity()

Constructs an instance.

MetadataEntity

protected MetadataEntity(@Nonnull
                         MetadataEntity other)

Constructs an instance from an other.

Parameters:

other - The other instance.

MetadataEntity

protected MetadataEntity(@Nonnull
                         Optional<String> name,
                         @Nonnull
                         Optional<UUID> uuid,
                         @Nonnull
                         Optional<KeyedGroups> attributes,
                         @Nonnull
                         Optional<Map<String,Text>> texts)

Constructs an instance.

Parameters:

name - The optional entity name.

uuid - The optional entity UUID.

attributes - The optional attributes.

texts - The optional texts.

Method Detail

addText

public final void addText(@Nonnull
                          Text text)

Adds text.

Parameters:

text - The text.

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.

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

Overrides:

equals in class AbstractEntity

getAttributes

@Nonnull
 @CheckReturnValue
public final Optional<KeyedGroups> getAttributes()

Gets the attributes.

Returns:

The optional attributes.

getAttributes

public final Optional<Attributes> getAttributes(String usage)

Gets the attributes for an usage.

Specified by:

getAttributes in interface Entity

Overrides:

getAttributes in class AbstractEntity

Parameters:

usage - The usage.

Returns:

The optional attributes.

getTexts

@Nonnull
 @CheckReturnValue
public final Optional<Map<String,Text>> getTexts()

Gets the texts.

Returns:

The texts.

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractEntity

setAttributes

public final void setAttributes(@Nonnull
                                Optional<KeyedGroups> attributes)

Sets attributes.

Parameters:

attributes - The optional attributes.