org.rvpf.config.entity

Class ClassLibEntity

Object

AbstractEntity

ClassLibEntity

All Implemented Interfaces:

Comparable<Entity>, Entity

Direct Known Subclasses:

ClassLibEntity.Undefined

public class ClassLibEntity
extends AbstractEntity

Class library entity.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ClassLibEntity.Builder Builder.
static class	ClassLibEntity.Undefined Undefined.

Field Summary

Fields

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

Fields inherited from interface Entity

UUID_COMPARATOR

Method Summary

Modifier and Type	Method and Description
void	adjustLevel() Adjust the level of this class library dependencies.
int	compareTo(Entity other) Implements Comparable.
ClassLibEntity	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.
Optional<Boolean>	getCached() Gets the cached indicator.
List<ClassLibEntity>	getClassLibs() Gets the included class libraries.
String	getElementName() Gets the entity element name.
int	getLevel() Gets this class library level.
List<URI>	getLocations() Gets a list of the locations from which this class library may be fetched.
String	getPrefix() Gets the class prefix.
String	getReferenceName() Gets the entity reference name.
int	hashCode()
boolean	isAdded() Asks if this class library has been added to the CLASSPATH.
boolean	isCached(boolean defaultValue) Asks if this class library is cached.
boolean	isDefined() Asks if this class library is defined.
static ClassLibEntity.Builder	newBuilder() Returns a new builder.
void	setAdded(boolean added) Sets the added indicator.

Methods inherited from class AbstractEntity

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

ClassLib element name.

See Also:

Constant Field Values

ENTITY_PREFIX

public static final String ENTITY_PREFIX

ClassLib entity prefix.

See Also:

Constant Field Values

Method Detail

newBuilder

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

Returns a new builder.

Returns:

The new builder.

adjustLevel

public final void adjustLevel()
                       throws TopologicalErrorException

Adjust the level of this class library dependencies.

Throws:

TopologicalErrorException - When a recursive reference is found.

compareTo

public final int compareTo(Entity other)

Implements Comparable.

Specified by:

compareTo in interface Comparable<Entity>

Overrides:

compareTo in class AbstractEntity

Parameters:

other - An other Entity.

Returns:

A negative integer, zero, or a positive integer.

copy

public ClassLibEntity copy()

Creates a copy of this entity.

Returns:

The copy.

equals

public final 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 AbstractEntity

getCached

@Nonnull
 @CheckReturnValue
public final Optional<Boolean> getCached()

Gets the cached indicator.

Returns:

The optional cached indicator.

getClassLibs

@Nonnull
 @CheckReturnValue
public final List<ClassLibEntity> getClassLibs()

Gets the included class libraries.

Returns:

The included class libraries.

getElementName

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

getLevel

@CheckReturnValue
public final int getLevel()

Gets this class library level.

The class library level help control the declaration order to avoid forward references.

Returns:

An int where 0 means that there is no 'classLib' reference to this class library. Lower (negative) values represent a higher stack of references.

getLocations

@Nonnull
 @CheckReturnValue
public final List<URI> getLocations()

Gets a list of the locations from which this class library may be fetched.

Returns:

The list as URIs.

getPrefix

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AbstractEntity

isAdded

@CheckReturnValue
public final boolean isAdded()

Asks if this class library has been added to the CLASSPATH.

Returns:

True if added.

isCached

@CheckReturnValue
public final boolean isCached(boolean defaultValue)

Asks if this class library is cached.

Parameters:

defaultValue - The default value.

Returns:

True if cached.

isDefined

@CheckReturnValue
public boolean isDefined()

Asks if this class library is defined.

Returns:

True if defined.

setAdded

public final void setAdded(boolean added)

Sets the added indicator.

Parameters:

added - The added indicator.