org.eclipse.smila.blackboard
Enum Blackboard.Get

java.lang.Object
  java.lang.Enum<Blackboard.Get>
      org.eclipse.smila.blackboard.Blackboard.Get

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Blackboard.Get>

Enclosing interface:

Blackboard

public static enum Blackboard.Get
extends java.lang.Enum<Blackboard.Get>

use as an argument in {@link #getRecord(String, CreateMode).

Enum Constant Summary

AUTO_CREATE
create a new record if it does not exist in record storage.

EXISTING
do not create a new record if it does not exists on blackboard or in record storage.

NEW
always create a new empty record that will replace an existing version on commit.

Method Summary

static Blackboard.Get	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Blackboard.Get[]	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

EXISTING

public static final Blackboard.Get EXISTING

do not create a new record if it does not exists on blackboard or in record storage.

AUTO_CREATE

public static final Blackboard.Get AUTO_CREATE

create a new record if it does not exist in record storage.

NEW

public static final Blackboard.Get NEW

always create a new empty record that will replace an existing version on commit.

Method Detail

values

public static Blackboard.Get[] 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 (Blackboard.Get c : Blackboard.Get.values())
    System.out.println(c);

Returns:

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

valueOf

public static Blackboard.Get valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null