com.phoenix_int.aserver.types
Class PHXString

java.lang.Object
  com.phoenix_int.aserver.types.PHXSimpleType
      com.phoenix_int.aserver.types.PHXString

All Implemented Interfaces:

IPHXType, IPHXType2, IPHXUnits

public class PHXString
extends PHXSimpleType

The Phoenix type for Strings. This class adds the following features to the PHXSimpleType:

• value: String
• enumValues: String[]
• enumAliases: String[]

See Also:

PHXSimpleType

Constructor Summary

PHXString()

Method Summary

static java.lang.String	arrayToString(java.lang.String[] sa)
void	fromString(java.lang.String value) converts a String representation to the internal value
void	fromString2(PHXStringBuffer value) converts a PHXStringBuffer representation to the internal value
java.lang.String[]	getEnumAliases() An interface function for the enumeration array
java.lang.String	getEnumAliasesStr() An interface function for the enumeration array
java.lang.String[]	getEnumValues() lists enum values
java.lang.String	getEnumValuesStr() Interface function to pass out the enumeration array as a comma separated string
java.lang.String	getValue() retrieves the current value of the variable
static void	main(java.lang.String[] args)
void	setEnumAliases(java.lang.String values) takes a comma seperated string of values and fills the enumeration aliases list with values.
void	setEnumAliases(java.lang.String[] values) takes an array of values and fills the enumeration aliases list with values.
void	setEnumValues(java.lang.String input) sets enum values
void	setEnumValues(java.lang.String[] values) sets enum values
void	setValue(PHXStringBuffer v) sets the value for the variable
void	setValue(java.lang.String v) sets the value for the variable
java.lang.String	toString() converts the variable to a string
PHXStringBuffer	toString2() converts the variable to a PHXStringBuffer

Methods inherited from class com.phoenix_int.aserver.types.PHXSimpleType

addPropertyChangeListener, getDescription, getEnumTokens, getHasChanged, getUnits, removePropertyChangeListener, setDescription, setHasChanged, setUnits

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PHXString

public PHXString()

Method Detail

getValue

public java.lang.String getValue()

retrieves the current value of the variable

Returns:

the value of the variable

setValue

public void setValue(java.lang.String v)
              throws java.lang.IllegalArgumentException

sets the value for the variable

Parameters:

v - the value

Throws:

java.lang.IllegalArgumentException

setValue

public void setValue(PHXStringBuffer v)
              throws java.lang.IllegalArgumentException

sets the value for the variable

Parameters:

v - the value

Throws:

java.lang.IllegalArgumentException

toString2

public PHXStringBuffer toString2()

converts the variable to a PHXStringBuffer

Returns:

a PHXStringBuffer representation of the variable

toString

public java.lang.String toString()

converts the variable to a string

Specified by:

toString in interface IPHXType

Overrides:

toString in class java.lang.Object

Returns:

a String representation of the variable

fromString2

public void fromString2(PHXStringBuffer value)

converts a PHXStringBuffer representation to the internal value

Parameters:

value - the value to convert

fromString

public void fromString(java.lang.String value)

converts a String representation to the internal value

Parameters:

value - the value to convert

getEnumValues

public java.lang.String[] getEnumValues()

lists enum values

Returns:

enum values

getEnumValuesStr

public java.lang.String getEnumValuesStr()

Interface function to pass out the enumeration array as a comma separated string

Returns:

comma separated string of the possible values of the list

setEnumValues

public void setEnumValues(java.lang.String input)

sets enum values

Parameters:

value: - list of enum values

setEnumValues

public void setEnumValues(java.lang.String[] values)

sets enum values

Parameters:

value: - list of enum values

setEnumAliases

public void setEnumAliases(java.lang.String values)

takes a comma seperated string of values and fills the enumeration aliases list with values.

Parameters:

values - A comma seperated string of enumeration aliases

setEnumAliases

public void setEnumAliases(java.lang.String[] values)

takes an array of values and fills the enumeration aliases list with values.

Parameters:

values - A string array of enumeration aliases

getEnumAliases

public java.lang.String[] getEnumAliases()

An interface function for the enumeration array

Returns:

an array of the possible values of the list

getEnumAliasesStr

public java.lang.String getEnumAliasesStr()

An interface function for the enumeration array

Returns:

an comma separated string of the possible values of the list

arrayToString

public static java.lang.String arrayToString(java.lang.String[] sa)

main

public static void main(java.lang.String[] args)