org.rvpf.metadata.entity

Class SyncEntity

Object

AbstractEntity

MetadataEntity

ParamsEntity

SyncEntity

All Implemented Interfaces:

Comparable<Entity>, Entity

public final class SyncEntity
extends ParamsEntity

Sync entity.

Instances of this class supply an object implementing the Sync interface.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	ELEMENT_NAME Sync element name.
static String	ENTITY_PREFIX Sync entity prefix.
static String	ENTITY_REFERENCE_NAME Sync entity reference name.

Fields inherited from interface Entity

UUID_COMPARATOR

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SyncEntity(Optional<String> name, Optional<UUID> uuid, Optional<KeyedGroups> attributes, Optional<Map<String,Text>> texts, Optional<Params> params, ClassDefEntity classDef, Optional<Sync> sync) Constructs an instance.

Method Summary

Modifier and Type	Method and Description
SyncEntity	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.
ClassDefEntity	getClassDef() Gets the classDef.
String	getElementName() Gets the entity element name.
String	getPrefix() Gets the class prefix.
String	getReferenceName() Gets the entity reference name.
Sync	getSync() Gets a Sync instance.
int	hashCode()
static SyncEntity.Builder	newBuilder() Returns a new builder.
boolean	setUp() Sets up this.
void	tearDown() Tears down what has been set up.

Methods inherited from class ParamsEntity

getParams, setParams

Methods inherited from class MetadataEntity

addText, getAttributes, getAttributes, getTexts, setAttributes

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

Field Detail

ELEMENT_NAME

public static final String ELEMENT_NAME

Sync element name.

See Also:

Constant Field Values

ENTITY_PREFIX

public static final String ENTITY_PREFIX

Sync entity prefix.

See Also:

Constant Field Values

ENTITY_REFERENCE_NAME

public static final String ENTITY_REFERENCE_NAME

Sync entity reference name.

See Also:

Constant Field Values

Constructor Detail

SyncEntity

protected SyncEntity(@Nonnull
                     Optional<String> name,
                     @Nonnull
                     Optional<UUID> uuid,
                     @Nonnull
                     Optional<KeyedGroups> attributes,
                     @Nonnull
                     Optional<Map<String,Text>> texts,
                     @Nonnull
                     Optional<Params> params,
                     @Nonnull
                     ClassDefEntity classDef,
                     @Nonnull
                     Optional<Sync> sync)

Constructs an instance.

Parameters:

name - The optional entity name.

uuid - The optional entity UUID.

attributes - The optional attributes.

texts - The optional texts.

params - The optional params.

classDef - The class definition.

sync - The optional Sync instance.

Method Detail

newBuilder

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

Returns a new builder.

Returns:

The new builder.

copy

public SyncEntity 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.

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 ParamsEntity

getClassDef

@Nonnull
 @CheckReturnValue
public ClassDefEntity getClassDef()

Gets the classDef.

Returns:

The classDef.

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.

getSync

@Nonnull
 @CheckReturnValue
public Sync getSync()

Gets a Sync instance.

Returns:

The Sync instance.

hashCode

public int hashCode()

Overrides:

hashCode in class ParamsEntity

setUp

@CheckReturnValue
public boolean setUp()

Sets up this.

Returns:

True on success.

tearDown

public void tearDown()

Tears down what has been set up.