Package com.tameif.tame.lang

Class ValueSet

java.lang.Object

com.tameif.tame.lang.ValueSet

All Implemented Interfaces:

ReferenceSaveable, com.tameif.tame.struct.Sizable, java.lang.Iterable<java.util.Map.Entry<java.lang.String,Value>>

public class ValueSet
extends java.lang.Object
implements ReferenceSaveable, java.lang.Iterable<java.util.Map.Entry<java.lang.String,Value>>, com.tameif.tame.struct.Sizable

Convenience class for Value lookup tables. All variable names are case-insensitive!

Author:

Matthew Tropiano

Constructor Summary

Constructors

Constructor and Description
ValueSet() Creates a new ValueHash.

Method Summary

Modifier and Type	Method and Description
void	clear() Clears this hash.
boolean	containsKey(java.lang.String variableName) Checks if a variable is defined on this hash.
void	copyFrom(ValueSet hash) Copies values from one value hash to this one.
static ValueSet	create(java.util.Map<java.lang.Long,Value> referenceMap, java.io.InputStream in) Creates this object from an input stream, expecting its byte representation.
Value	get(java.lang.String variableName) Gets a value on this hash.
boolean	isEmpty() Returns if this object contains no objects.
java.util.Iterator<java.util.Map.Entry<java.lang.String,Value>>	iterator()
java.util.List<java.lang.String>	names()
void	put(java.lang.String variableName, Value value) Sets a value on this hash.
void	readReferentialBytes(java.util.Map<java.lang.Long,Value> referenceMap, java.io.InputStream in) Imports this object from bytes, looking up value references in a map.
void	remove(java.lang.String variableName) Clears a variable from the hash.
int	size()
void	writeReferentialBytes(java.util.concurrent.atomic.AtomicLong referenceCounter, java.util.Map<java.lang.Object,java.lang.Long> referenceSet, java.io.OutputStream out) Exports this object to bytes, preserving up value references from a map.

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.tameif.tame.lang.ReferenceSaveable

fromReferentialBytes, toReferentialBytes

Constructor Detail

ValueSet

public ValueSet()

Creates a new ValueHash.

Method Detail

create

public static ValueSet create(java.util.Map<java.lang.Long,Value> referenceMap,
                              java.io.InputStream in)
                       throws java.io.IOException

Creates this object from an input stream, expecting its byte representation.

Parameters:

referenceMap - the reference map to use for "seen" value references.

in - the input stream to read from.

Returns:

the read object.

Throws:

java.io.IOException - if a read error occurs.

copyFrom

public void copyFrom(ValueSet hash)

Copies values from one value hash to this one.

Parameters:

hash - the source hash to copy values from.

clear

public void clear()

Clears this hash.

get

public Value get(java.lang.String variableName)

Gets a value on this hash.

Parameters:

variableName - the variable name.

Returns:

the corresponding value, or null.

put

public void put(java.lang.String variableName,
                Value value)

Sets a value on this hash.

Parameters:

variableName - the variable name.

value - the value.

remove

public void remove(java.lang.String variableName)

Clears a variable from the hash.

Parameters:

variableName - the name of the variable.

containsKey

public boolean containsKey(java.lang.String variableName)

Checks if a variable is defined on this hash.

Parameters:

variableName - the name of the variable.

Returns:

if the variable exists or not.

names

public java.util.List<java.lang.String> names()

Returns:

a list of all values.

iterator

public java.util.Iterator<java.util.Map.Entry<java.lang.String,Value>> iterator()

Specified by:

iterator in interface java.lang.Iterable<java.util.Map.Entry<java.lang.String,Value>>

writeReferentialBytes

public void writeReferentialBytes(java.util.concurrent.atomic.AtomicLong referenceCounter,
                                  java.util.Map<java.lang.Object,java.lang.Long> referenceSet,
                                  java.io.OutputStream out)
                           throws java.io.IOException

Description copied from interface: ReferenceSaveable

Exports this object to bytes, preserving up value references from a map.

Specified by:

writeReferentialBytes in interface ReferenceSaveable

Parameters:

referenceCounter - the reference counter to use for when unique values are seen.

referenceSet - the reference set to use for "seen" value references - maps object reference to counter value.

out - the output stream to write to.

Throws:

java.io.IOException - if a write problem occurs.

readReferentialBytes

public void readReferentialBytes(java.util.Map<java.lang.Long,Value> referenceMap,
                                 java.io.InputStream in)
                          throws java.io.IOException

Description copied from interface: ReferenceSaveable

Imports this object from bytes, looking up value references in a map.

Specified by:

readReferentialBytes in interface ReferenceSaveable

Parameters:

referenceMap - the reference map to use for "seen" value references.

in - the input stream to read from.

Throws:

java.io.IOException - if a read problem occurs.

size

public int size()

Specified by:

size in interface com.tameif.tame.struct.Sizable

Returns:

the amount of individual objects that this object contains.

isEmpty

public boolean isEmpty()

Description copied from interface: com.tameif.tame.struct.Sizable

Returns if this object contains no objects. The general policy of this method is that this returns true if and only if Sizable.size() returns 0.

Specified by:

isEmpty in interface com.tameif.tame.struct.Sizable

Returns:

true if so, false otherwise.