org.magnos.data.var
Class BooleanVar

java.lang.Object
  org.magnos.data.AbstractData
      org.magnos.data.var.AbstractVar<java.lang.Boolean>
          org.magnos.data.var.BooleanVar

All Implemented Interfaces:

Data, Var<java.lang.Boolean>

public class BooleanVar
extends AbstractVar<java.lang.Boolean>

A Var with a boolean value.

Author:

Philip Diffenderfer

Field Summary

static int

SIZE

Constructor Summary

BooleanVar()
Instantiates a new BooleanVar.

BooleanVar(boolean value)
Instantiates a new BooleanVar.

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

BooleanVar(Store store, int location, boolean value)
Instantiates a new BooleanVar.

Method Summary

Data	copy() Creates a clone of this data.
boolean	get() Returns the current value of the var.
java.lang.Boolean	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(boolean value) Sets the value of this var and writes it to the store.
void	set(boolean value) Sets the value of this var, but does not write it to the store.
void	setValue(java.lang.Boolean value) Sets the value of this var without writing the value to a store.
boolean	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

Field Detail

SIZE

public static final int SIZE

See Also:

Constant Field Values

Constructor Detail

BooleanVar

public BooleanVar()

Instantiates a new BooleanVar.

BooleanVar

public BooleanVar(boolean value)

Instantiates a new BooleanVar.

Parameters:

value - The initial value.

BooleanVar

public BooleanVar(Store store,
                  int location)

Instantiates a new BooleanVar.

Parameters:

store - The intial store.

location - The intial location.

BooleanVar

public BooleanVar(Store store,
                  int location,
                  boolean value)

Instantiates a new BooleanVar.

Parameters:

store - The initial store.

location - The initial location.

value - The initial value.

Method Detail

get

public boolean get()

Returns the current value of the var.

Returns:

The current value.

set

public void set(boolean value)

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

Parameters:

value - The new value.

put

public void put(boolean value)

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

Parameters:

value - The new value.

take

public boolean take()

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

Returns:

The value of this var.

getValue

public java.lang.Boolean 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.Boolean 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.