org.hypergraphdb.atom

Enum HGAtomRef.Mode

java.lang.Object

java.lang.Enum<HGAtomRef.Mode>

org.hypergraphdb.atom.HGAtomRef.Mode

All Implemented Interfaces:

Serializable, Comparable<HGAtomRef.Mode>

Enclosing class:

HGAtomRef

public static enum HGAtomRef.Mode
extends Enum<HGAtomRef.Mode>

Enum Constant Summary

Enum Constants

Enum Constant and Description
floating This constant define an FLOATING reference mode.
hard This constant define a HARD reference mode.
symbolic This constant define a SYMBOLIC reference mode.

Method Summary

Methods

Modifier and Type	Method and Description
static HGAtomRef.Mode	get(byte code)
byte	getCode()
static HGAtomRef.Mode	valueOf(String name) Returns the enum constant of this type with the specified name.
static HGAtomRef.Mode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

hard

public static final HGAtomRef.Mode hard

This constant define a HARD reference mode. This behavior of hard references is like the Unix file system hard links: when all hard references are removed from HyperGraph, the referent is removed as well.

symbolic

public static final HGAtomRef.Mode symbolic

This constant define a SYMBOLIC reference mode. This behavior of symbolic references is like the Unix file system symbolic links: they are just pointers to the referent without an effect on its lifetime.

floating

public static final HGAtomRef.Mode floating

This constant define an FLOATING reference mode. This behavior of floating references is particular to HyperGraph: when removed they will leave the referent as a temporary atom that will eventually be automatically removed from HyperGraph if not used. This behavior relies on the MANAGED system-level atom attribute. If the referent is not managed when the last floating reference is removed, it will be tagged as managed from then on. Thus it is still possible to access the atom by some other means (e.g. a handle to it is kept somewhere or through a query) and re-establish a HGAtomRef to it.

Method Detail

values

public static HGAtomRef.Mode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (HGAtomRef.Mode c : HGAtomRef.Mode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static HGAtomRef.Mode valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getCode

public byte getCode()

get

public static HGAtomRef.Mode get(byte code)