com.sodius.mdw.core.eval.project
Class DirectionKind

java.lang.Object
  extended by com.sodius.mdw.core.eval.project.DirectionKind

public final class DirectionKind
extends Object

Enumerations of known model parameter direction kinds.

This class cannot be instantiated or subclassed by clients.

See Also:
ModelParameter.getDirection()

Field Summary
static DirectionKind IN
          in : elements are read in the input model, no modification performed.
static DirectionKind INOUT
          inout : some elements are read and others are created in the model.
static DirectionKind OUT
          out : elements are created in the output model.
 
Method Summary
 boolean isIn()
          Return true if the direction is in.
 boolean isInOut()
          Return true if the direction is inout.
 boolean isOut()
          Return true if the direction is out.
 String toString()
          Returns a String representation of this direction.
static DirectionKind valueOf(String value)
          Determines the direction represented as a String value.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

IN

public static final DirectionKind IN
in : elements are read in the input model, no modification performed. For an entry-point rule set, this will tell the workbench a model needs to be loaded from a source location.


OUT

public static final DirectionKind OUT
out : elements are created in the output model. For an entry-point rule set, this will tell the workbench a model may be written into a target location.


INOUT

public static final DirectionKind INOUT
inout : some elements are read and others are created in the model. For an entry-point rule set, this will tell the workbench the model needs to be loaded from a resource and saved to a target location, (which may or may not be the same physical resource).

Method Detail

valueOf

public static DirectionKind valueOf(String value)
                             throws IllegalArgumentException
Determines the direction represented as a String value.

Parameters:
value - a String representing a direction.
Returns:
the corresponding direction.
Throws:
IllegalArgumentException - if the value is not recognized.

isIn

public boolean isIn()
Return true if the direction is in.

Returns:
true if the direction is in.
See Also:
IN

isOut

public boolean isOut()
Return true if the direction is out.

Returns:
true if the direction is out.
See Also:
OUT

isInOut

public boolean isInOut()
Return true if the direction is inout.

Returns:
true if the direction is inout.
See Also:
INOUT

toString

public String toString()
Returns a String representation of this direction.

Overrides:
toString in class Object
Returns:
the direction as a String.