stella.net.tpl

Class TplSet

java.lang.Object

stella.net.tpl.TplCommand

stella.net.tpl.TplSet

public class TplSet
extends TplCommand

The set command. Parses only single-lined data from the TplEvent.

Field Summary

Fields

Modifier and Type	Field and Description
private String	module The requested module to set.
static String	SET The set command string.
private Boolean	success The success of the set procedure, either null, TRUE or FALSE.
private String	value The new value of the object.

Fields inherited from class stella.net.tpl.TplCommand

ABORTED, ABORTEDBY, BUSY, COMPLETE, DENIED, DIMENSION, ERROR, FAILED, IDBUSY, INVALID, LOCKED, NOTRUNNING, OK, OVERRUN, RANGE, SYNTAX, TIMEOUT, TOOMANY, TYPE, UNKNOWN

Constructor Summary

Constructors

Constructor and Description
TplSet(int id, String query) Constructs a new set command specifiying the object to set and its new value.

Method Summary

Modifier and Type	Method and Description
String	getCommandLead() Returns the query string.
Boolean	getSuccess() Returns the state of the setting request.
boolean	parseTplEvent(TplEvent reply) Additionally checks if the event represents the queried data.

Methods inherited from class stella.net.tpl.TplCommand

commenceCommand, getCommencedWhen, getID, getInfo, getState, hashCode, isAcknowledged, isCompleted, isSending, setInfo, setState, toString

Methods inherited from class java.lang.Object

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

Field Detail

SET

public static final String SET

The set command string.

See Also:

Constant Field Values

success

private Boolean success

The success of the set procedure, either null, TRUE or FALSE.

value

private String value

The new value of the object.

module

private String module

The requested module to set.

Constructor Detail

TplSet

public TplSet(int id,
              String query)

Constructs a new set command specifiying the object to set and its new value.

Method Detail

getCommandLead

public String getCommandLead()

Returns the query string. This is the string the command has been constructed with, preceeded by SET and a space.

Specified by:

getCommandLead in class TplCommand

getSuccess

public Boolean getSuccess()

Returns the state of the setting request. If null is returned, the server has not responded yet. Otherwise we have a valid Boolean.

parseTplEvent

public boolean parseTplEvent(TplEvent reply)
                      throws ParseException

Additionally checks if the event represents the queried data.

Overrides:

parseTplEvent in class TplCommand

Returns:

True, if the event belongs to this command.

Throws:

ParseException