Package com.tameif.tame.lang

Class BlockEntry

java.lang.Object

com.tameif.tame.lang.BlockEntry

All Implemented Interfaces:

Saveable

public class BlockEntry
extends java.lang.Object
implements Saveable

Describes a single block entry stub for a block table.

Author:

Matthew Tropiano

Method Summary

Modifier and Type	Method and Description
static BlockEntry	create(BlockEntryType entryType, Value... values) Creates a new BlockEntry.
static BlockEntry	create(java.io.InputStream in) Creates a new BlockEntry from an input stream.
boolean	equals(BlockEntry entry) Checks if this entry is equal to another entry.
boolean	equals(java.lang.Object obj)
java.lang.String	getEntryString() Returns a string representation of this entry.
BlockEntryType	getEntryType() Gets the entry type.
Value[]	getValues() Gets the values to match.
int	hashCode()
void	readBytes(java.io.InputStream in) Imports this object from bytes.
java.lang.String	toFriendlyString() Gets the string representation of this as a non-debugging-human-friendly string.
java.lang.String	toString()
void	writeBytes(java.io.OutputStream out) Exports this object to bytes.

Methods inherited from class java.lang.Object

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

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

fromBytes, toBytes

Method Detail

create

public static BlockEntry create(BlockEntryType entryType,
                                Value... values)

Creates a new BlockEntry.

Parameters:

entryType - the entry type.

values - the values to match.

Returns:

a new BlockEntry.

create

public static BlockEntry create(java.io.InputStream in)
                         throws java.io.IOException

Creates a new BlockEntry from an input stream.

Parameters:

in - the input stream to read from.

Returns:

a new BlockEntry.

Throws:

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

getEntryType

public BlockEntryType getEntryType()

Gets the entry type.

Returns:

the entry type.

getValues

public Value[] getValues()

Gets the values to match.

Returns:

the entry values that need matching.

getEntryString

public java.lang.String getEntryString()

Returns a string representation of this entry. Useful for export to languages that cannot use objects as lookup keys.

Returns:

a string representation of this entry.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

equals

public boolean equals(BlockEntry entry)

Checks if this entry is equal to another entry.

Parameters:

entry - the entry to compare to.

Returns:

true if equal, false if not.

writeBytes

public void writeBytes(java.io.OutputStream out)
                throws java.io.IOException

Description copied from interface: Saveable

Exports this object to bytes.

Specified by:

writeBytes in interface Saveable

Parameters:

out - the output stream to write to.

Throws:

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

readBytes

public void readBytes(java.io.InputStream in)
               throws java.io.IOException

Description copied from interface: Saveable

Imports this object from bytes.

Specified by:

readBytes in interface Saveable

Parameters:

in - the input stream to read from.

Throws:

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

toFriendlyString

public java.lang.String toFriendlyString()

Gets the string representation of this as a non-debugging-human-friendly string.

Returns:

an output-friendly string of this entry.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object