TAMEModule

java.lang.Object
- com.tameif.tame.TAMEModule

All Implemented Interfaces:

Saveable
```
public class TAMEModule
extends java.lang.Object
implements Saveable
```
An instantiated module.

Author:

Matthew Tropiano

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class TAMEModule.Header
TAME Module Header.

Nested Classes
Modifier and Type	Class and Description
`static class`	`TAMEModule.Header` TAME Module Header.

Constructor Summary

Constructors
Constructor and Description

TAMEModule()
Creates a new module.

Constructors
Constructor and Description
`TAMEModule()` Creates a new module.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAction(TAction a)` Add an action to this world.
`void`	`addContainer(TContainer container)` Adds an container to the module.
`void`	`addObject(TObject object)` Adds an object to the module.
`void`	`addPlayer(TPlayer player)` Adds an player to the module.
`void`	`addRoom(TRoom room)` Adds a room to the module.
`byte[]`	`calculateDigest()` Calculates this module's digest - only necessary if read from a script but never saved.
`static TAMEModule`	`create(java.io.InputStream in)` Reads a module from binary content.
`TAction`	`getActionByIdentity(java.lang.String identity)` Retrieves an action by its identity.
`TAction`	`getActionByName(java.lang.String name)` Retrieves an action by name, case-insensitively.
`int`	`getActionCount()` Gets how many actions are in this module.
`java.lang.Iterable<java.util.Map.Entry<java.lang.String,TAction>>`	`getActionList()`
`TContainer`	`getContainerByIdentity(java.lang.String identity)` Retrieves a container by identity.
`int`	`getContainerCount()` Gets how many containers are in this module.
`java.lang.Iterable<java.util.Map.Entry<java.lang.String,TContainer>>`	`getContainerList()`
`byte[]`	`getDigest()` Gets the module digest.
`TElement`	`getElementByIdentity(java.lang.String identity)` Retrieves an element by identity.
`TAMEModule.Header`	`getHeader()` Returns the module header.
`TObject`	`getObjectByIdentity(java.lang.String identity)` Retrieves an Object by identity.
`int`	`getObjectCount()` Gets how many objects are in this module.
`java.lang.Iterable<java.util.Map.Entry<java.lang.String,TObject>>`	`getObjectList()`
`TPlayer`	`getPlayerByIdentity(java.lang.String identity)` Retrieves a Player by identity.
`int`	`getPlayerCount()` Gets how many players are in this module.
`java.lang.Iterable<java.util.Map.Entry<java.lang.String,TPlayer>>`	`getPlayerList()`
`TRoom`	`getRoomByIdentity(java.lang.String identity)` Retrieves a Room by identity.
`int`	`getRoomCount()` Gets how many rooms are in this module.
`java.lang.Iterable<java.util.Map.Entry<java.lang.String,TRoom>>`	`getRoomList()`
`TWorld`	`getWorld()` Gets the module's world.
`void`	`readBytes(java.io.InputStream in)` Imports this object from bytes.
`static TAMEModule.Header`	`readModuleHeader(java.io.InputStream in)` Reads a module header and only the header from a module stream.
`void`	`setWorld(TWorld world)` Sets the module's world.
`void`	`writeBytes(java.io.OutputStream out)` Exports this object to bytes.

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.Saveable
fromBytes, toBytes

- Constructor Detail
  - TAMEModule
```
public TAMEModule()
```
    Creates a new module.
- Method Detail
  - create
```
public static TAMEModule create(java.io.InputStream in)
                         throws java.io.IOException
```
    Reads a module from binary content.
    
    Parameters:
    
    in - the input stream to read from.
    
    Returns:
    
    a deserialized module.
    
    Throws:
    
    java.io.IOException - if the stream can't be read.
  - readModuleHeader
```
public static TAMEModule.Header readModuleHeader(java.io.InputStream in)
                                          throws java.io.IOException
```
    Reads a module header and only the header from a module stream.
    
    Parameters:
    
    in - the input stream to read from.
    
    Returns:
    
    a module header.
    
    Throws:
    
    java.io.IOException - if the stream can't be read.
  - getHeader
```
public TAMEModule.Header getHeader()
```
    Returns the module header. The module header contains a lot of header information about the module.
    
    Returns:
    
    the header.
  - getDigest
```
public byte[] getDigest()
```
    Gets the module digest.
    
    Returns:
    
    the digest or null if not calculated.
    
    See Also:
    
    calculateDigest()
  - addAction
```
public void addAction(TAction a)
```
    Add an action to this world. World loaders will use this.
    
    Parameters:
    
    a - the Action to add.
  - getActionByName
```
public TAction getActionByName(java.lang.String name)
```
    Retrieves an action by name, case-insensitively.
    
    Parameters:
    
    name - the Action's name.
    
    Returns:
    
    the corresponding Action, or null if not found.
  - getActionByIdentity
```
public TAction getActionByIdentity(java.lang.String identity)
```
    Retrieves an action by its identity.
    
    Parameters:
    
    identity - the Action's identity.
    
    Returns:
    
    the corresponding Action, or null if not found.
  - setWorld
```
public void setWorld(TWorld world)
```
    Sets the module's world.
    
    Parameters:
    
    world - the world to set.
  - getWorld
```
public TWorld getWorld()
```
    Gets the module's world.
    
    Returns:
    
    the world.
  - addRoom
```
public void addRoom(TRoom room)
```
    Adds a room to the module.
    
    Parameters:
    
    room - the Room.
  - getRoomByIdentity
```
public TRoom getRoomByIdentity(java.lang.String identity)
```
    Retrieves a Room by identity.
    
    Parameters:
    
    identity - the Room's identity.
    
    Returns:
    
    the corresponding Room, or null if not found.
  - addObject
```
public void addObject(TObject object)
```
    Adds an object to the module.
    
    Parameters:
    
    object - the Object.
  - getObjectByIdentity
```
public TObject getObjectByIdentity(java.lang.String identity)
```
    Retrieves an Object by identity.
    
    Parameters:
    
    identity - the Object's identity.
    
    Returns:
    
    the corresponding Object, or null if not found.
  - addContainer
```
public void addContainer(TContainer container)
```
    Adds an container to the module.
    
    Parameters:
    
    container - the container.
  - getContainerByIdentity
```
public TContainer getContainerByIdentity(java.lang.String identity)
```
    Retrieves a container by identity.
    
    Parameters:
    
    identity - the container's identity.
    
    Returns:
    
    the corresponding container, or null if not found.
  - addPlayer
```
public void addPlayer(TPlayer player)
```
    Adds an player to the module.
    
    Parameters:
    
    player - the Player's identity.
  - getPlayerByIdentity
```
public TPlayer getPlayerByIdentity(java.lang.String identity)
```
    Retrieves a Player by identity.
    
    Parameters:
    
    identity - the Player's identity.
    
    Returns:
    
    the corresponding Player, or null if not found.
  - getElementByIdentity
```
public TElement getElementByIdentity(java.lang.String identity)
```
    Retrieves an element by identity.
    
    Parameters:
    
    identity - the element's identity.
    
    Returns:
    
    the corresponding element, or null if not found.
  - getPlayerCount
```
public int getPlayerCount()
```
    Gets how many players are in this module.
    
    Returns:
    
    the number of players.
  - getActionCount
```
public int getActionCount()
```
    Gets how many actions are in this module.
    
    Returns:
    
    the number of actions.
  - getRoomCount
```
public int getRoomCount()
```
    Gets how many rooms are in this module.
    
    Returns:
    
    the number of rooms.
  - getObjectCount
```
public int getObjectCount()
```
    Gets how many objects are in this module.
    
    Returns:
    
    the number of objects.
  - getContainerCount
```
public int getContainerCount()
```
    Gets how many containers are in this module.
    
    Returns:
    
    the number of containers.
  - getPlayerList
```
public java.lang.Iterable<java.util.Map.Entry<java.lang.String,TPlayer>> getPlayerList()
```
    Returns:
    
    an iterable list of player pairs.
  - getActionList
```
public java.lang.Iterable<java.util.Map.Entry<java.lang.String,TAction>> getActionList()
```
    Returns:
    
    an iterable list of action pairs.
  - getRoomList
```
public java.lang.Iterable<java.util.Map.Entry<java.lang.String,TRoom>> getRoomList()
```
    Returns:
    
    an iterable list of room pairs.
  - getObjectList
```
public java.lang.Iterable<java.util.Map.Entry<java.lang.String,TObject>> getObjectList()
```
    Returns:
    
    an iterable list of object pairs.
  - getContainerList
```
public java.lang.Iterable<java.util.Map.Entry<java.lang.String,TContainer>> getContainerList()
```
    Returns:
    
    an iterable list of container pairs.
  - calculateDigest
```
public byte[] calculateDigest()
```
    Calculates this module's digest - only necessary if read from a script but never saved. Must be calculated to save a module state.
    
    Returns:
    
    the calculated digest.
    
    Throws:
    
    ModuleException - if it cannot be calculated.
  - 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.

Class TAMEModule

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

Constructor Detail

TAMEModule

Method Detail

create

readModuleHeader

getHeader

getDigest

addAction

getActionByName

getActionByIdentity

setWorld

getWorld

addRoom

getRoomByIdentity

addObject

getObjectByIdentity

addContainer

getContainerByIdentity

addPlayer

getPlayerByIdentity

getElementByIdentity

getPlayerCount

getActionCount

getRoomCount

getObjectCount

getContainerCount

getPlayerList

getActionList

getRoomList

getObjectList

getContainerList

calculateDigest

writeBytes

readBytes