org.g_node.nix.base

Class EntityWithMetadata

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

org.g_node.nix.base.EntityWithMetadata

All Implemented Interfaces:

Comparable

Direct Known Subclasses:

Block, EntityWithSources, Source

@Platform(value="linux") @Platform(value="windows")
public abstract class EntityWithMetadata
extends NamedEntity

EntityWithMetadata

An abstract class for entities that can be associated with additional metadata.

Constructor Summary

Constructors

Constructor and Description
EntityWithMetadata()

Method Summary

Modifier and Type	Method and Description
abstract Section	getMetadata() Get metadata associated with this entity.
abstract void	removeMetadata() Removes metadata associated with the entity.
abstract void	setMetadata(Section metadata) Associate the entity with some metadata.
abstract void	setMetadata(String id) Associate the entity with some metadata.

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

compareTo, getDefinition, getName, getType, setDefinition, setType

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

EntityWithMetadata

public EntityWithMetadata()

Method Detail

getMetadata

public abstract Section getMetadata()

Get metadata associated with this entity.

Returns:

The associated section, if no such section exists {#link null} is returned.

setMetadata

public abstract void setMetadata(Section metadata)

Associate the entity with some metadata.

Calling this method will replace previously stored information.

Parameters:

metadata - The Section that should be associated with this entity.

setMetadata

public abstract void setMetadata(String id)

Associate the entity with some metadata.

Calling this method will replace previously stored information.

Parameters:

id - The id of the Section that should be associated with this entity.

removeMetadata

public abstract void removeMetadata()

Removes metadata associated with the entity.