inria.meije.rc.sugarcubes
Class InternalStringIdentifiers

java.lang.Object
  |
  +--inria.meije.rc.sugarcubes.InternalStringIdentifiers
All Implemented Interfaces:
InternalIdentifiers, java.io.Serializable

public class InternalStringIdentifiers
extends java.lang.Object
implements InternalIdentifiers, java.io.Serializable

This is a simple implementation of an InternalIdentifiers, consistent with the StringID implementation based on java strings. InternalStringIdentifiers provides standard means to deal with Identifier based on java strings, without having to define your own implementation of Identifiers each time you want to use SugarCubes.

See Also:
Serialized Form

Field Summary
static StringID THREAD_FINISH_IDENTIFIER
          Constant definition of the event identifier returned by the threadFinishIdentifier method.
static StringID THREAD_STEP_IDENTIFIER
          Constant definition of the event identifier returned by the threadStepIdentifier method.
 
Constructor Summary
InternalStringIdentifiers()
           
 
Method Summary
 Identifier cubeDestructionIdentifier(java.lang.String aCubeName)
          This method returns the event identifier corresponding to the event used to preempt a Cube whose name is passed in argument.
 Identifier identifierFromString(java.lang.String aString)
          This method returns the event identifier corresponding to the string given in argument.
 Identifier threadFinishIdentifier()
          This method returns a unique event identifier for the internal event used in the reactive thread macro definition in class SC.
 Identifier threadStepIdentifier()
          This method returns a unique event identifier for the internal event used in the reactive thread macro definition in class SC.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

THREAD_FINISH_IDENTIFIER

public static final StringID THREAD_FINISH_IDENTIFIER
Constant definition of the event identifier returned by the threadFinishIdentifier method.
See Also:
SC.reactiveThread(inria.meije.rc.sugarcubes.Program, inria.meije.rc.sugarcubes.Identifier, inria.meije.rc.sugarcubes.Identifier, inria.meije.rc.sugarcubes.Identifier, inria.meije.rc.sugarcubes.Identifier, int, inria.meije.rc.sugarcubes.InternalIdentifiers)

THREAD_STEP_IDENTIFIER

public static final StringID THREAD_STEP_IDENTIFIER
Constant definition of the event identifier returned by the threadStepIdentifier method.
See Also:
SC.reactiveThread(inria.meije.rc.sugarcubes.Program, inria.meije.rc.sugarcubes.Identifier, inria.meije.rc.sugarcubes.Identifier, inria.meije.rc.sugarcubes.Identifier, inria.meije.rc.sugarcubes.Identifier, int, inria.meije.rc.sugarcubes.InternalIdentifiers)
Constructor Detail

InternalStringIdentifiers

public InternalStringIdentifiers()
Method Detail

cubeDestructionIdentifier

public Identifier cubeDestructionIdentifier(java.lang.String aCubeName)
This method returns the event identifier corresponding to the event used to preempt a Cube whose name is passed in argument.
Specified by:
cubeDestructionIdentifier in interface InternalIdentifiers

identifierFromString

public Identifier identifierFromString(java.lang.String aString)
This method returns the event identifier corresponding to the string given in argument. The Identifier is a StringID wrapper instantiated around the string passed in argument to make that string match the type of an identifier.
Specified by:
identifierFromString in interface InternalIdentifiers

threadFinishIdentifier

public Identifier threadFinishIdentifier()
This method returns a unique event identifier for the internal event used in the reactive thread macro definition in class SC. This event is used to preempt the reactive program of a reactive thread macro. This event should be unique reserved for internal use in SugarCubes and cannot be the same as the event identifier returned by the threadStepIdentifier method.
Specified by:
threadFinishIdentifier in interface InternalIdentifiers
Following copied from interface: inria.meije.rc.sugarcubes.InternalIdentifiers
See Also:
SC.reactiveThread(inria.meije.rc.sugarcubes.Program, inria.meije.rc.sugarcubes.Identifier, inria.meije.rc.sugarcubes.Identifier, inria.meije.rc.sugarcubes.Identifier, inria.meije.rc.sugarcubes.Identifier, int, inria.meije.rc.sugarcubes.InternalIdentifiers)

threadStepIdentifier

public Identifier threadStepIdentifier()
This method returns a unique event identifier for the internal event used in the reactive thread macro definition in class SC. This event is used to control the execution of the body controlled by the reactive thread macro. This event should be unique and is reserved for internal use in SugarCubes and cannot be the same as the event identifier returned by the threadFinishIdentifier method.
Specified by:
threadStepIdentifier in interface InternalIdentifiers
Following copied from interface: inria.meije.rc.sugarcubes.InternalIdentifiers
See Also:
SC.reactiveThread(inria.meije.rc.sugarcubes.Program, inria.meije.rc.sugarcubes.Identifier, inria.meije.rc.sugarcubes.Identifier, inria.meije.rc.sugarcubes.Identifier, inria.meije.rc.sugarcubes.Identifier, int, inria.meije.rc.sugarcubes.InternalIdentifiers)