Package com.redwood.agent.api.rtx

Enum RTXType

java.lang.Object

java.lang.Enum<RTXType>

com.redwood.agent.api.rtx.RTXType

All Implemented Interfaces:

Serializable, Comparable<RTXType>

public enum RTXType
extends Enum<RTXType>

Data type of an RTX Column.

Enum Constant Summary

Enum Constants

Enum Constant	Description
Date
DateTime
DateTimeZone
Number
String
Time

Field Summary

Fields

Modifier and Type	Field	Description
static String	DATE_FORMAT	Deprecated. The canonical format for fields of type Date.

Method Summary

Modifier and Type	Method	Description
String	getElementName()	Get the type name as used in the RTX header.
ParameterType	getParameterType()
static RTXType	safeValueOf(String value)	Helper function to return the RTXTypes represented by value.
String	toCanonicalStringValue(Object value)
static <T> T	toInternalRepresentation(Object value, RTXType rtxType)
static <T> T	toInternalRepresentation(Object value, Class<T> type)
static RTXType	valueOf(ParameterType pt)	Returns the enum constant of this type with the specified name.
static <T> RTXType	valueOf(Class<T> columnClass)	Returns the enum constant of this type with the specified name.
static RTXType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static RTXType[]	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

String

public static final RTXType String

Number

public static final RTXType Number

Date

public static final RTXType Date

DateTime

public static final RTXType DateTime

DateTimeZone

public static final RTXType DateTimeZone

Time

public static final RTXType Time

Field Detail

DATE_FORMAT

@Deprecated
public static final String DATE_FORMAT

Deprecated.

The canonical format for fields of type Date. Use toInternalRepresentation(Object, Class) instead.

See Also:

Constant Field Values

Method Detail

values

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

Returns:

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

valueOf

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

NullPointerException - if the argument is null

safeValueOf

public static RTXType safeValueOf(String value)

Helper function to return the RTXTypes represented by value. If value is null, or not a valid RTXTypes enumeration then this method will return null.

The main difference between this method and valueOf(String), is that this method will return null when passed an invalid value, valueOf(String) will throw an IllegalArgumentException.

Parameters:

value - The string value that corresponds to the requested enumeration value

Returns:

The RTXTypes corresponding to value, or null, if value is null, or not a valid enumeration

See Also:

valueOf(String)

valueOf

public static <T> RTXType valueOf(Class<T> columnClass)

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:

columnClass - 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

NullPointerException - if the argument is null

valueOf

public static RTXType valueOf(ParameterType pt)

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:

pt - 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

NullPointerException - if the argument is null

getParameterType

public ParameterType getParameterType()

getElementName

public String getElementName()

Get the type name as used in the RTX header.

Returns:

the type name.

toInternalRepresentation

public static <T> T toInternalRepresentation(Object value,
                                             Class<T> type)
                                      throws RTXParseException

Throws:

RTXParseException

toInternalRepresentation

public static <T> T toInternalRepresentation(Object value,
                                             RTXType rtxType)
                                      throws RTXParseException

Throws:

RTXParseException

toCanonicalStringValue

public String toCanonicalStringValue(Object value)