TElement

java.lang.Object
- com.tameif.tame.element.TElement

All Implemented Interfaces:

Saveable

Direct Known Subclasses:

TContainer, TObject, TPlayer, TRoom, TWorld
```
public abstract class TElement
extends java.lang.Object
implements Saveable
```
Common engine element object.

Author:

Matthew Tropiano

Constructor Summary

Constructors
Modifier Constructor and Description

protected TElement()
Prepares a new element.

Constructors
Modifier	Constructor and Description
`protected`	`TElement()` Prepares a new element.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addBlock(BlockEntry blockEntry, Block block)` Adds/replaces a block and block entry to this element.
`void`	`addFunction(java.lang.String functionName, FunctionEntry entry)` Adds/replaces a block and block entry to this element.
`boolean`	`equals(TElement element)` Compares elements.
`boolean`	`equals(java.lang.Object object)`
`void`	`fromBytes(byte[] data)` Reads this object's representation from a byte array.
`Block`	`getBlock(BlockEntry blockEntry)` Gets a block using a block entry on this element.
`java.lang.Iterable<java.util.Map.Entry<BlockEntry,Block>>`	`getBlockEntries()`
`FunctionEntry`	`getFunction(java.lang.String functionName)` Gets a function entry using a function name on this element.
`java.lang.Iterable<java.util.Map.Entry<java.lang.String,FunctionEntry>>`	`getFunctionEntries()`
`java.lang.String`	`getIdentity()` Gets the identity (primary identifier name).
`TElement`	`getParent()` Gets this object's parent.
`int`	`hashCode()`
`boolean`	`isArchetype()` Checks if this element is an Archetype.
`abstract boolean`	`isValidEntryType(BlockEntryType type)` Checks if this element handles a particular entry type.
`void`	`readBytes(java.io.InputStream in)` Imports this object from bytes.
`Block`	`resolveBlock(BlockEntry blockEntry)` Resolves a block using a block entry on this element by going backwards through its lineage.
`FunctionEntry`	`resolveFunction(java.lang.String functionName)` Resolves a function entry using a function name on this element by going backwards through its lineage.
`void`	`setArchetype(boolean archetype)` Sets if this element is an Archetype.
`protected void`	`setIdentity(java.lang.String identity)` Sets the identity (primary identifier name).
`protected void`	`setIdentityForced(java.lang.String identity)` Sets the identity (primary identifier name) without doing an illegal identity check.
`void`	`setParent(TElement parent)` Sets a parent on this object.
`byte[]`	`toBytes()` Gets this object's representation as bytes.
`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

- Constructor Detail
  - TElement
```
protected TElement()
```
    Prepares a new element.
- Method Detail
  - getIdentity
```
public java.lang.String getIdentity()
```
    Gets the identity (primary identifier name).
    
    Returns:
    
    this element's identity.
  - setIdentity
```
protected void setIdentity(java.lang.String identity)
```
    Sets the identity (primary identifier name).
    
    Parameters:
    
    identity - the identity to set.
  - setIdentityForced
```
protected void setIdentityForced(java.lang.String identity)
```
    Sets the identity (primary identifier name) without doing an illegal identity check.
    
    Parameters:
    
    identity - the identity to set.
  - isValidEntryType
```
public abstract boolean isValidEntryType(BlockEntryType type)
```
    Checks if this element handles a particular entry type.
    
    Parameters:
    
    type - the entry type to check.
    
    Returns:
    
    true if so, false if not.
  - addBlock
```
public void addBlock(BlockEntry blockEntry,
                     Block block)
```
    Adds/replaces a block and block entry to this element.
    
    Parameters:
    
    blockEntry - the block entry to associate with a block.
    
    block - the block to assign.
  - getBlockEntries
```
public java.lang.Iterable<java.util.Map.Entry<BlockEntry,Block>> getBlockEntries()
```
    Returns:
    
    an iterable structure for all block entries in this table.
  - getBlock
```
public Block getBlock(BlockEntry blockEntry)
```
    Gets a block using a block entry on this element.
    
    Parameters:
    
    blockEntry - the block entry to use.
    
    Returns:
    
    the associated block, or null if no associated block.
  - resolveBlock
```
public Block resolveBlock(BlockEntry blockEntry)
```
    Resolves a block using a block entry on this element by going backwards through its lineage.
    
    Parameters:
    
    blockEntry - the block entry to use.
    
    Returns:
    
    an associated block, or null if no associated block.
  - addFunction
```
public void addFunction(java.lang.String functionName,
                        FunctionEntry entry)
```
    Adds/replaces a block and block entry to this element.
    
    Parameters:
    
    functionName - the function name to associate with the table.
    
    entry - the entry to associate.
  - getFunctionEntries
```
public java.lang.Iterable<java.util.Map.Entry<java.lang.String,FunctionEntry>> getFunctionEntries()
```
    Returns:
    
    an iterable structure for all function entries in this table.
  - getFunction
```
public FunctionEntry getFunction(java.lang.String functionName)
```
    Gets a function entry using a function name on this element.
    
    Parameters:
    
    functionName - the function name to use.
    
    Returns:
    
    the associated entry, or null if no associated entry.
  - resolveFunction
```
public FunctionEntry resolveFunction(java.lang.String functionName)
```
    Resolves a function entry using a function name on this element by going backwards through its lineage.
    
    Parameters:
    
    functionName - the function name to use.
    
    Returns:
    
    an associated entry, or null if no associated entry.
  - setParent
```
public void setParent(TElement parent)
```
    Sets a parent on this object.
    
    Parameters:
    
    parent - the parent object to set.
  - getParent
```
public TElement getParent()
```
    Gets this object's parent. The ordering is in the order they were added.
    
    Returns:
    
    an iterator for this object's lineage.
    
    See Also:
    
    setParent(TElement)
  - isArchetype
```
public boolean isArchetype()
```
    Checks if this element is an Archetype. Archetypes do not hold state nor have contexts - they only define code. Archetypes can be inherited from, but can never be owned, nor own things, nor be in expressions nor operations.
    
    Returns:
    
    true if so, false if not.
  - setArchetype
```
public void setArchetype(boolean archetype)
```
    Sets if this element is an Archetype. Archetypes do not hold state nor have contexts - they only define code. Archetypes can be inherited from, but can never be owned, nor own things, nor be in expressions nor operations.
    
    Parameters:
    
    archetype - true if so, false if not.
    
    Throws:
    
    ModuleException - if this element cannot be an archetype and archetype is true, or if you attempt to set this to false on an object that has this already set to true.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object object)
```
    Overrides:
    
    equals in class java.lang.Object
  - equals
```
public boolean equals(TElement element)
```
    Compares elements. Uses identity.
    
    Parameters:
    
    element - the other element.
    
    Returns:
    
    true if equal, false if not.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - 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.
  - toBytes
```
public byte[] toBytes()
               throws java.io.IOException
```
    Description copied from interface: Saveable
    
    Gets this object's representation as bytes.
    
    Specified by:
    
    toBytes in interface Saveable
    
    Returns:
    
    the byte array of state bytes.
    
    Throws:
    
    java.io.IOException - if a write problem occurs.
  - fromBytes
```
public void fromBytes(byte[] data)
               throws java.io.IOException
```
    Description copied from interface: Saveable
    
    Reads this object's representation from a byte array.
    
    Specified by:
    
    fromBytes in interface Saveable
    
    Parameters:
    
    data - the data to read.
    
    Throws:
    
    java.io.IOException - if a read problem occurs.

Class TElement

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TElement

Method Detail

getIdentity

setIdentity

setIdentityForced

isValidEntryType

addBlock

getBlockEntries

getBlock

resolveBlock

addFunction

getFunctionEntries

getFunction

resolveFunction

setParent

getParent

isArchetype

setArchetype

hashCode

equals

equals

toString

writeBytes

readBytes

toBytes

fromBytes