org.ldp4j.application.vocabulary

Class ImmutableTerm

java.lang.Object

org.ldp4j.application.vocabulary.ImmutableTerm

All Implemented Interfaces:

Serializable, Comparable<Term>, Term

public class ImmutableTerm
extends Object
implements Term

A term implementation that enforces the creation of immutable terms defined for an AbstractImmutableVocabulary, which behave as Enum constants.

Since:

1.0.0

Version:

1.0

Author:

Miguel Esteban Gutiérrez

See Also:

AbstractImmutableVocabulary, Serialized Form

Constructor Summary

Constructors

Constructor and Description
ImmutableTerm(AbstractImmutableVocabulary<? extends ImmutableTerm> vocabulary, String entityName) Create a new term for a vocabulary and entity.

Method Summary

Methods

Modifier and Type	Method and Description
<V> V	as(Class<? extends V> valueClass) Transform the term to an instance of the specified type.
int	compareTo(Term other) Compares this term with the specified object for order.
String	entityName() Returns the simple name of the entity of the vocabulary identified by this term constant.
boolean	equals(Object other) Returns true if the specified object is equal to this term constant.
Vocabulary	getDeclaringVocabulary() Returns the Vocabulary object corresponding to this term constant's vocabulary type.
int	hashCode() Returns a hash code for this term constant.
String	name() Returns the name of this term constant, exactly as declared in its vocabulary declaration.
int	ordinal() Returns the ordinal of this term (its position in its vocabulary declaration, where the initial constant is assigned an ordinal of zero).
String	qualifiedEntityName() Returns the qualified name of the entity of the vocabulary identified by this term constant.
String	toString() Returns the qualified entity name of this term constant.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ImmutableTerm

public ImmutableTerm(AbstractImmutableVocabulary<? extends ImmutableTerm> vocabulary,
             String entityName)

Create a new term for a vocabulary and entity.

Parameters:

vocabulary - the vocabulary to which the term will belong to.

entityName - the entity name of the term.

Throws:

NullPointerException - if any of the vocabulary is null.

IllegalArgumentException - if the entity name is not valid.

Method Detail

ordinal

public final int ordinal()

Returns the ordinal of this term (its position in its vocabulary declaration, where the initial constant is assigned an ordinal of zero).

Specified by:

ordinal in interface Term

Returns:

the ordinal of this term

name

public final String name()

Returns the name of this term constant, exactly as declared in its vocabulary declaration. Most programmers should use the #toString method in preference to this one, as the toString method may return a more user-friendly name. This method is designed primarily for use in specialized situations where correctness depends on getting the exact name, which will not vary from release to release.

Specified by:

name in interface Term

Returns:

the name of this term

entityName

public final String entityName()

Returns the simple name of the entity of the vocabulary identified by this term constant.

Specified by:

entityName in interface Term

qualifiedEntityName

public final String qualifiedEntityName()

Returns the qualified name of the entity of the vocabulary identified by this term constant.

Specified by:

qualifiedEntityName in interface Term

getDeclaringVocabulary

public final Vocabulary getDeclaringVocabulary()

Returns the Vocabulary object corresponding to this term constant's vocabulary type. Two term constants e1 and e2 are of the same vocabulary type if and only if e1.getDeclaringVocabulary() == e2.getDeclaringVocabulary().

Specified by:

getDeclaringVocabulary in interface Term

Returns:

the Vocabulary object corresponding to this term constant's vocabulary type

as

public <V> V as(Class<? extends V> valueClass)

Transform the term to an instance of the specified type.
This method may be overridden, though it typically isn't necessary or desirable. An term type should override this method when a more specific value types are supported.

Specified by:

as in interface Term

Parameters:

valueClass - The type to which the term is to be transformed to.

Returns:

An instance of the specified type that represents this term.

equals

public final boolean equals(Object other)

Returns true if the specified object is equal to this term constant.

Overrides:

equals in class Object

Parameters:

other - the object to be compared for equality with this object.

Returns:

true if the specified object is equal to this term constant.

hashCode

public final int hashCode()

Returns a hash code for this term constant.

Overrides:

hashCode in class Object

Returns:

a hash code for this term constant.

toString

public String toString()

Returns the qualified entity name of this term constant. This method may be overridden, though it typically isn't necessary or desirable. An term type should override this method when a more "programmer-friendly" string form exists.

Overrides:

toString in class Object

Returns:

the name of this term constant

compareTo

public int compareTo(Term other)

Compares this term with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object. Term constants are only comparable to other term constants of the same vocabulary. The natural order implemented by this method is the order in which the constants are declared.

Specified by:

compareTo in interface Comparable<Term>