com.rational.test.ft.value
Class EnumerationType

java.lang.Object   com.rational.test.ft.value.EnumerationType

public class EnumerationType
extends java.lang.Object

Expresses primimtve values (such as the month in a date) as the logical enumeration types they represent.

Since:

RFT1.0

Constructor Summary

EnumerationType(int current, java.lang.String[] enumeration)
Presents the possible values as the enumeration and the current index.

EnumerationType(int current, java.lang.String[] enumeration, boolean editable)
Presents the possible values as the enumeration and the current index.

EnumerationType(int current, java.lang.String text, java.lang.String[] enumeration)
Presents the possible values as the enumeration and the current and text index.

EnumerationType(int current, java.lang.String text, java.lang.String[] enumeration, boolean editable)
Presents the possible values as the enumeration and the current and text index.

EnumerationType(int current, java.lang.String text, java.lang.String[] enumeration, boolean editable, boolean overrideLimit)
Presents the possible values as the enumeration and the current and text index.

Method Summary

boolean	addEnumerationLiteral(java.lang.String literal) Adds an enumeration literal not in enumeration.
int	getCurrentIndex() Gets the current index into the enumeration.
java.lang.String	getCurrentText() Gets the text associated with the current index.
boolean	getEditable() Determines whether a new enumeration literal not in enumeration can be added and set as the selected literal
java.lang.String[]	getEnumerationLiterals() Gets the enumeration literals associated with this enumeration type.
void	setEnumerationLiterals(java.lang.String[] enumeration) Defines the enumeration literals associated with this enumeration type.
void	setSelectedLiteral(int currentIndex) Sets the current index into the enumeration.
java.lang.String	toString() Returns a string with the value the class represents.

Methods inherited from class java.lang.Object

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

Constructor Detail

EnumerationType

public EnumerationType(int current,                        java.lang.String[] enumeration)

Presents the possible values as the enumeration and the current index.

Since:

RFT1.0

EnumerationType

public EnumerationType(int current,                        java.lang.String text,                        java.lang.String[] enumeration)

Presents the possible values as the enumeration and the current and text index.

Since:

RFT1.0

EnumerationType

public EnumerationType(int current,                        java.lang.String[] enumeration,                        boolean editable)

Presents the possible values as the enumeration and the current index.

Since:

RFT2.0

EnumerationType

public EnumerationType(int current,                        java.lang.String text,                        java.lang.String[] enumeration,                        boolean editable)

Presents the possible values as the enumeration and the current and text index.

Since:

RFT2.0

EnumerationType

public EnumerationType(int current,                        java.lang.String text,                        java.lang.String[] enumeration,                        boolean editable,                        boolean overrideLimit)

Presents the possible values as the enumeration and the current and text index.

Since:

RFT2.0

Method Detail

getCurrentIndex

public int getCurrentIndex()

Gets the current index into the enumeration.

Since:

RFT1.0

setSelectedLiteral

public void setSelectedLiteral(int currentIndex)

Sets the current index into the enumeration. The currentText is set to the corresponding enumeration literal.

Since:

RFT1.0

getEnumerationLiterals

public java.lang.String[] getEnumerationLiterals()

Gets the enumeration literals associated with this enumeration type.

Since:

RFT1.0

setEnumerationLiterals

public void setEnumerationLiterals(java.lang.String[] enumeration)

Defines the enumeration literals associated with this enumeration type.

Since:

RFT1.0

getCurrentText

public java.lang.String getCurrentText()

Gets the text associated with the current index.

Since:

RFT1.0

getEditable

public boolean getEditable()

Determines whether a new enumeration literal not in enumeration can be added and set as the selected literal

Since:

RFT2.0

addEnumerationLiteral

public boolean addEnumerationLiteral(java.lang.String literal)

Adds an enumeration literal not in enumeration. The existing enumeration literals are removed and the added literal is the selected literal.

Since:

RFT2.0

toString

public java.lang.String toString()

Returns a string with the value the class represents.

Overrides:

toString in class java.lang.Object