public interface Entity extends Comparable<Entity>
An entity holds informations on a defining element in metadata.
Modifier and Type | Field and Description |
---|---|
static Comparator<Entity> |
UUID_COMPARATOR
UUID comparator.
|
Modifier and Type | Method and Description |
---|---|
Entity |
copy()
Creates a copy of this entity.
|
Optional<Attributes> |
getAttributes(String usage)
Gets the attributes for an usage.
|
String |
getElementName()
Gets the entity element name.
|
Optional<String> |
getName()
Gets the name of this.
|
Optional<String> |
getNameInUpperCase()
Gets the name of this in upper case.
|
String |
getPrefix()
Gets the class prefix.
|
String |
getReferenceName()
Gets the entity reference name.
|
Optional<UUID> |
getUUID()
Gets the UUID of this Entity.
|
static final Comparator<Entity> UUID_COMPARATOR
@Nonnull @CheckReturnValue Entity copy()
@Nonnull @CheckReturnValue Optional<Attributes> getAttributes(@Nonnull String usage)
usage
- The usage.@Nonnull @CheckReturnValue String getElementName()
The entity element is used to in the generation of the entity URI.
@Nonnull @CheckReturnValue Optional<String> getName()
@Nonnull @CheckReturnValue Optional<String> getNameInUpperCase()
@Nonnull @CheckReturnValue String getPrefix()
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.
@Nonnull @CheckReturnValue String getReferenceName()
@Nonnull @CheckReturnValue Optional<UUID> getUUID()
Copyright © 2003-2019 Serge Brisson. All Rights Reserved.