org.g_node.nix.base

Class NamedEntity<T extends NamedEntity>

java.lang.Object

org.bytedeco.javacpp.Pointer

org.g_node.nix.base.ImplContainer

org.g_node.nix.base.Entity

org.g_node.nix.base.NamedEntity<T>

All Implemented Interfaces:

Comparable<T>

Direct Known Subclasses:

EntityWithMetadata, Section

@Platform(value="linux") @Platform(value="windows")
public abstract class NamedEntity<T extends NamedEntity>
extends Entity
implements Comparable<T>

NamedEntity

An abstract class for entities with a getName(), getType() and getDefinition().

Constructor Summary

Constructors

Constructor and Description
NamedEntity()

Method Summary

Modifier and Type	Method and Description
int	compareTo(T obj)
abstract String	getDefinition() Getter for the definition of the entity.
abstract String	getName() Getter for the name of the entity.
abstract String	getType() Getter for the type of the entity.
abstract void	setDefinition(String definition) Setter for the definition of the entity.
abstract void	setType(String type) Setter for the type of the entity.

Methods inherited from class org.g_node.nix.base.Entity

equals, forceCreatedAt, forceUpdatedAt, getCreatedAt, getId, getUpdatedAt, hashCode, setCreatedAt, setUpdatedAt

Methods inherited from class org.g_node.nix.base.ImplContainer

isInitialized, isNone

Methods inherited from class org.bytedeco.javacpp.Pointer

address, asBuffer, asByteBuffer, capacity, capacity, deallocate, deallocate, deallocateReferences, fill, isNull, limit, limit, memchr, memcmp, memcpy, memmove, memset, offsetof, position, position, put, setNull, sizeof, toString, zero

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

NamedEntity

public NamedEntity()

Method Detail

setType

public abstract void setType(String type)

Setter for the type of the entity.

Parameters:

type - The type to set.

getType

public abstract String getType()

Getter for the type of the entity.

The property type is used in order to allow the specification of additional semantic meaning for an entity and therefore can introduce domain-specificity into the quite generic data model.

Returns:

The current type.

getName

public abstract String getName()

Getter for the name of the entity.

The name of an entity serves as a human readable identifier. It is not obliged to be unique. However it is strongly recommended to use unique name inside one specific Block.

Returns:

string The name of the entity.

setDefinition

public abstract void setDefinition(String definition)

Setter for the definition of the entity.

Parameters:

definition - The definition of the entity.

getDefinition

public abstract String getDefinition()

Getter for the definition of the entity.

The definition is an optional property that allows the user to add a freely assignable textual definition to the entity.

Returns:

The definition of the entity.

compareTo

public int compareTo(T obj)

Specified by:

compareTo in interface Comparable<T extends NamedEntity>