rcf.core.framework.component
Enum OperationType

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

All Implemented Interfaces:

Serializable, Comparable<OperationType>

@Revision(value="$Revision: 1.2 $",
          date="$Date: 2006/12/15 20:37:50 $",
          tag="$Name:  $")
public enum OperationType
extends Enum<OperationType>

TODO: Javadoc

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

Version:

$Revision: 1.2 $

Author:

Greg Gibeling

Enum Constant Summary

Compute
The primary object of this operation is to perform some computation, propgating data from various inputs to outputs.

Read
The primary objective of this operation is to read a property.

ReadWrite
A combination of Read and Write.

Write
The primary objective of this operation is to write a property.

Method Summary

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

Read

public static final OperationType Read

The primary objective of this operation is to read a property. Note that this is more general the Get as the operation may in fact do more than just read a property, in other words it may have side effects of all kinds. Furthermore unlike Get, the operation may act on a property which is not of PropertyUse.Option.

Write

public static final OperationType Write

The primary objective of this operation is to write a property. Note that this is more general the Set as the operation may in fact do more than just write a property, in other words it may have side effects of all kinds. Furthermore unlike Set, the operation may act on a property which is not of PropertyUse.Option.

ReadWrite

public static final OperationType ReadWrite

A combination of Read and Write.

Compute

public static final OperationType Compute

The primary object of this operation is to perform some computation, propgating data from various inputs to outputs. Notice that it may also modify any inouts.

Method Detail

values

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

Returns:

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

valueOf

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