org.magnos.data.var
Class StringVar

java.lang.Object
  org.magnos.data.AbstractData
      org.magnos.data.var.AbstractVar<java.lang.String>
          org.magnos.data.var.StringVar

All Implemented Interfaces:

Data, Var<java.lang.String>

public class StringVar
extends AbstractVar<java.lang.String>

A Var with a boolean value.

Author:

Philip Diffenderfer

Constructor Summary

StringVar(int length)
Instantiates a new BooleanVar.

StringVar(int length, Store store, int location)
Instantiates a new BooleanVar.

StringVar(int length, Store store, int location, java.lang.String value)
Instantiates a new BooleanVar.

StringVar(int length, java.lang.String value)
Instantiates a new BooleanVar.

Method Summary

Data	copy() Creates a clone of this data.
java.lang.String	get() Returns the current value of the var.
java.lang.String	getValue() Returns the value of this var as it was the last time this variable was read from a store at the location (and maybe with an offset) or as it was set with the setValue method.
void	onRead(int location, Store store) Reads this data from the given store at the given location.
void	onWrite(int location, Store store) Writes this data to the given store at the given location.
void	put(java.lang.String value) Sets the value of this var and writes it to the store.
void	set(java.lang.String value) Sets the value of this var, but does not write it to the store.
void	setValue(java.lang.String value) Sets the value of this var without writing the value to a store.
java.lang.String	take() Returns the value of this var by first reading it from the store.

Methods inherited from class org.magnos.data.var.AbstractVar

equals, hashCode, putValue, takeValue, toString

Methods inherited from class org.magnos.data.AbstractData

getActualLocation, getLocation, getParent, getSize, getStore, read, read, read, read, setLocation, setParent, setStore, write, write, write, write

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.magnos.data.Data

getActualLocation, getLocation, getParent, getSize, getStore, read, read, read, read, setLocation, setParent, setStore, write, write, write, write

Constructor Detail

StringVar

public StringVar(int length)

Instantiates a new BooleanVar.

StringVar

public StringVar(int length,
                 java.lang.String value)

Instantiates a new BooleanVar.

Parameters:

value - The initial value.

StringVar

public StringVar(int length,
                 Store store,
                 int location)

Instantiates a new BooleanVar.

Parameters:

store - The intial store.

location - The intial location.

StringVar

public StringVar(int length,
                 Store store,
                 int location,
                 java.lang.String value)

Instantiates a new BooleanVar.

Parameters:

store - The initial store.

location - The initial location.

value - The initial value.

Method Detail

get

public java.lang.String get()

Returns the current value of the var.

Returns:

The current value.

set

public void set(java.lang.String value)

Sets the value of this var, but does not write it to the store.

Parameters:

value - The new value.

put

public void put(java.lang.String value)

Sets the value of this var and writes it to the store.

Parameters:

value - The new value.

take

public java.lang.String take()

Returns the value of this var by first reading it from the store.

Returns:

The value of this var.

getValue

public java.lang.String getValue()

Returns the value of this var as it was the last time this variable was read from a store at the location (and maybe with an offset) or as it was set with the setValue method.

Returns:

The last value read.

setValue

public void setValue(java.lang.String value)

Sets the value of this var without writing the value to a store.

Parameters:

value - The new value to set.

onRead

public void onRead(int location,
                   Store store)

Reads this data from the given store at the given location.

Specified by:

onRead in class AbstractData

Parameters:

location - The offset in bytes from the beginning of the store to read from.

store - The store to read from.

onWrite

public void onWrite(int location,
                    Store store)

Writes this data to the given store at the given location.

Specified by:

onWrite in class AbstractData

Parameters:

location - The offset in bytes from the beginning of the store to write to.

store - The store to write to.

copy

public Data copy()

Creates a clone of this data. The resulting data will be of the same type, have the same location, the same store, and have other similar attributes to this type.

Returns:

A clone of this data.