Package adams.flow.control

Class VariableNameStorageNamePair

java.lang.Object

adams.core.base.BaseObject

adams.core.base.AbstractBaseString

adams.flow.control.VariableNameStorageNamePair

All Implemented Interfaces:

CloneHandler<BaseObject>, Serializable, Comparable

public class VariableNameStorageNamePair
extends AbstractBaseString

Wrapper for a variable name/storage name pair.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static String	SEPARATOR	the separator.

Fields inherited from class adams.core.base.BaseObject

m_Internal, m_Properties, SUFFIX_DISPLAY, SUFFIX_VALUE

Constructor Summary

Constructors

Constructor	Description
VariableNameStorageNamePair()	Initializes the string with length 0.
VariableNameStorageNamePair(String s)	Initializes the object with the string to parse.
VariableNameStorageNamePair(String varName, String storagName)	Initializes the object with the variable name/storage name pair.

Method Summary

Modifier and Type	Method	Description
String	getTipText()	Returns a tool tip for the GUI editor (ignored if null is returned).
boolean	isValid(String value)	Checks whether the string value is a valid presentation for this class.
String	pairValue()	Returns the backquoted String pair.
StorageName	storageNameValue()	Returns the storage name.
String	variableNameValue()	Returns the variable name.

Methods inherited from class adams.core.base.AbstractBaseString

convert, getValue, initialize, isEmpty, length, setValue, stringValue

Methods inherited from class adams.core.base.BaseObject

compareTo, equals, getClone, getInternal, getTemplates, getUnicode, hasFavoritesSupport, hashCode, isValidUnicode, newInstance, setUnicode, toObjectArray, toObjectArray, toString, toStringArray, toStringList

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

SEPARATOR

public static final String SEPARATOR

the separator.

See Also:

Constant Field Values

Constructor Detail

VariableNameStorageNamePair

public VariableNameStorageNamePair()

Initializes the string with length 0.

VariableNameStorageNamePair

public VariableNameStorageNamePair(String varName,
                                   String storagName)

Initializes the object with the variable name/storage name pair.

Parameters:

varName - the variable name to use

storagName - the storage name to use

VariableNameStorageNamePair

public VariableNameStorageNamePair(String s)

Initializes the object with the string to parse.

Parameters:

s - the string to parse

Method Detail

isValid

public boolean isValid(String value)

Checks whether the string value is a valid presentation for this class.

Overrides:

isValid in class AbstractBaseString

Parameters:

value - the string value to check

Returns:

true if non-null

getTipText

public String getTipText()

Returns a tool tip for the GUI editor (ignored if null is returned).

Specified by:

getTipText in class AbstractBaseString

Returns:

the tool tip

pairValue

public String pairValue()

Returns the backquoted String pair.

Returns:

the backquoted pair

variableNameValue

public String variableNameValue()

Returns the variable name.

Returns:

the variable name

storageNameValue

public StorageName storageNameValue()

Returns the storage name.

Returns:

the storage name