rcf.core.framework.component
Enum PropertyUse

java.lang.Object
  java.lang.Enum<PropertyUse>
      rcf.core.framework.component.PropertyUse

All Implemented Interfaces:

Serializable, Comparable<PropertyUse>

@Revision(value="$Revision: 1.1 $",
          date="$Date: 2006/11/29 21:10:25 $",
          tag="$Name:  $")
public enum PropertyUse
extends Enum<PropertyUse>

TODO: Javadoc

TODO: Unit tests, Code review, Javadoc review, Seal/Finalize TODO: equals, hashCode, toString

Version:

$Revision: 1.1 $

Author:

Greg Gibeling

Enum Constant Summary

Data
TODO: Javadoc This property is part of the data that the components instance represents.

Inout
TODO: Javadoc This property is both input and output; the component's operations will perform a computation which will modify this data.

Input
TODO: Javadoc This property is input to the component; the component's operations will perform computation over this data.

Option
TODO: Javadoc This property represents an option which the component will take into account when performing operations.

Output
TODO: Javadoc This property is output from the component; the component's operations ill generate this data.

State
TODO: Javadoc This property represents the state of the component, or some part of its state.

Method Summary

static PropertyUse	valueOf(String name) Returns the enum constant of this type with the specified name.
static PropertyUse[]	values() Returns an array containing the constants of this enum type, in the order they're declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

Data

public static final PropertyUse Data

TODO: Javadoc This property is part of the data that the components instance represents. This is not that same as state as data may very well be a part of the component's identity. All fields of a simple C-style struct would be data.

State

public static final PropertyUse State

TODO: Javadoc This property represents the state of the component, or some part of its state. This is not the same as data, as state is generally independant of the component's identity. A simple FSM component might have a single state property, and many operations which modify it.

Option

public static final PropertyUse Option

TODO: Javadoc This property represents an option which the component will take into account when performing operations. Generally this is neither data nor state as operations will not change this (other than set methods) and this will determine exactly what and how operations work.

Input

public static final PropertyUse Input

TODO: Javadoc This property is input to the component; the component's operations will perform computation over this data.

Output

public static final PropertyUse Output

TODO: Javadoc This property is output from the component; the component's operations ill generate this data.

Inout

public static final PropertyUse Inout

TODO: Javadoc This property is both input and output; the component's operations will perform a computation which will modify this data.

Method Detail

values

public static final PropertyUse[] values()

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

for(PropertyUse c : PropertyUse.values())
        System.out.println(c);

Returns:

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

valueOf

public static PropertyUse 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