org.csstudio.data.values.internal

Class StringValue

java.lang.Object

org.csstudio.data.values.internal.Value

org.csstudio.data.values.internal.StringValue

All Implemented Interfaces:

IStringValue, IValue

public class StringValue
extends Value
implements IStringValue

Implementation of IStringValue.

Author:

Kay Kasemir

See Also:

IStringValue

Nested Class Summary

Nested classes/interfaces inherited from interface org.csstudio.data.values.IValue

IValue.Format

Field Summary

Fields inherited from class org.csstudio.data.values.internal.Value

MAX_FORMAT_VALUE_COUNT

Constructor Summary

Constructors

Constructor and Description
StringValue(ITimestamp time, ISeverity severity, String status, String[] values) Constructs a new StringValue.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	format(IValue.Format how, int precision) Format the value as a string.
String	getValue()
String[]	getValues()
int	hashCode()

Methods inherited from class org.csstudio.data.values.internal.Value

format, getDisplayChar, getMetaData, getSeverity, getStatus, getTime, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.csstudio.data.values.IValue

format, getMetaData, getSeverity, getStatus, getTime

Constructor Detail

StringValue

public StringValue(ITimestamp time,
                   ISeverity severity,
                   String status,
                   String[] values)

Constructs a new StringValue.

Parameters:

time - the timestamp of the value

severity - the severity of the value

status - the status

values - the values array

Method Detail

getValues

public final String[] getValues()

Specified by:

getValues in interface IStringValue

Returns:

Returns the whole array of values.

getValue

public final String getValue()

Specified by:

getValue in interface IStringValue

Returns:

Returns the first array element.

Since most samples are probably scalars, this is a convenient way to get that one and only element.

See Also:

IStringValue.getValues()

format

public final String format(IValue.Format how,
                           int precision)

Description copied from interface: IValue

Format the value as a string.

This means only the numeric or string value. Not the timestamp, not the severity and status.

Specified by:

format in interface IValue

Specified by:

format in class Value

Parameters:

how - Detail on how to format.

precision - Might be used by some format types to select for example the number of digits after the decimal point. A precision of '-1' might select the default-precision obtained from the MetaData.

Returns:

This Value's value as a string.

equals

public final boolean equals(Object obj)

Overrides:

equals in class Value

hashCode

public int hashCode()

Overrides:

hashCode in class Value