com.simba.dsi.dataengine.utilities
Enum ParameterType

java.lang.Object
  extended by java.lang.Enum<ParameterType>
      extended by com.simba.dsi.dataengine.utilities.ParameterType
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<ParameterType>

public enum ParameterType
extends java.lang.Enum<ParameterType>

A ParameterType is used to indicate whether a parameter is used for input, output, or both.


Enum Constant Summary
INPUT
          Indicates that the parameter is used for input.
INPUT_OUTPUT
          Indicates that the parameter is used for both input and output.
OUTPUT
          Indicates that the parameter is used for output.
RETURN_VALUE
          Indicates that the parameter is used for a return value.
UNKNOWN
          Indicates that the type is unknown
 
Method Summary
static ParameterType getEnumByValue(int value)
          Get the ParameterType that matches the input value.
 int getIntValue()
          Get the The ParameterType number.
static ParameterType valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static ParameterType[] 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

UNKNOWN

public static final ParameterType UNKNOWN
Indicates that the type is unknown


INPUT

public static final ParameterType INPUT
Indicates that the parameter is used for input.


INPUT_OUTPUT

public static final ParameterType INPUT_OUTPUT
Indicates that the parameter is used for both input and output.


OUTPUT

public static final ParameterType OUTPUT
Indicates that the parameter is used for output.


RETURN_VALUE

public static final ParameterType RETURN_VALUE
Indicates that the parameter is used for a return value.

Method Detail

values

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

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

valueOf

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

getEnumByValue

public static ParameterType getEnumByValue(int value)
Get the ParameterType that matches the input value. An unknown input will result in a null ParameterType being returned.

Parameters:
value - The value of the ParameterType.
Returns:
The ParameterType that matches the value.

getIntValue

public int getIntValue()
Get the The ParameterType number.

Returns:
ParameterType number.


Copyright © 2006-2014 Simba Technologies Incorporated. All Rights Reserved.