gov.nasa.gsfc.drl.rtstps.core.status
Class StatusItem

java.lang.Object
  extended by gov.nasa.gsfc.drl.rtstps.core.status.StatusItem
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
IntegerStatusItem, LongStatusItem, TextStatusItem

public abstract class StatusItem
extends java.lang.Object
implements java.io.Serializable

This class contains a single status item. It is most often a long integer counter. The derivatives define the type of value.

See Also:
Serialized Form

Field Summary
protected  boolean clearable
          If true, this item can be cleared.
private  java.lang.String name
          A name for this item.
private static long serialVersionUID
           
 
Constructor Summary
protected StatusItem(java.lang.String label)
          Create a StatusItem with the given name.
 
Method Summary
abstract  void clear()
          Clear this status item.
 java.lang.String getName()
          Get the name.
abstract  java.lang.String getValue()
          Get this item's value as a string.
 boolean isClearable()
          Determine if this status item is clearable.
 void setClearable(boolean x)
          Set to clearable or not.
 java.lang.String toString()
          Get this item in the form "name=value".
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

serialVersionUID

private static final long serialVersionUID
See Also:
Constant Field Values

name

private final java.lang.String name
A name for this item. It does not need to be unique. A client will often display the name adjacent to the value.


clearable

protected boolean clearable
If true, this item can be cleared. For integer type, it means it can be set to zero.

Constructor Detail

StatusItem

protected StatusItem(java.lang.String label)
Create a StatusItem with the given name.

Method Detail

getName

public final java.lang.String getName()
Get the name.


setClearable

public final void setClearable(boolean x)
Set to clearable or not. A clearable status item may be set to zero if an integer. An item is clearable by default.


isClearable

public final boolean isClearable()
Determine if this status item is clearable.


toString

public java.lang.String toString()
Get this item in the form "name=value".

Overrides:
toString in class java.lang.Object

getValue

public abstract java.lang.String getValue()
Get this item's value as a string.


clear

public abstract void clear()
Clear this status item. Nothing happens if the item is not clearable.