Package com.tameif.tame

Class TAMEModule.Header

java.lang.Object

com.tameif.tame.TAMEModule.Header

All Implemented Interfaces:

Saveable

Enclosing class:

TAMEModule

public static class TAMEModule.Header
extends java.lang.Object
implements Saveable

TAME Module Header.

Author:

Matthew Tropiano

Constructor Summary

Constructors

Constructor and Description
Header() Creates a new module header.

Method Summary

Modifier and Type	Method and Description
void	addAttribute(java.lang.String attribute, java.lang.String value) Adds an attribute to the module.
java.lang.String[]	getAllAttributes() Gets all of this module header's attributes.
java.lang.String	getAttribute(java.lang.String attribute) Gets an attribute value from the module.
com.tameif.tame.struct.CaseInsensitiveStringMap<java.lang.String>	getAttributeMap() Gets the attribute map for the header.
void	readBytes(java.io.InputStream in) Imports this object from bytes.
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

Header

public Header()

Creates a new module header.

Method Detail

addAttribute

public void addAttribute(java.lang.String attribute,
                         java.lang.String value)

Adds an attribute to the module. Attributes are case-insensitive. There are a bunch of suggested ones that all clients/servers should read.

Parameters:

attribute - the attribute name.

value - the value.

getAttribute

public java.lang.String getAttribute(java.lang.String attribute)

Gets an attribute value from the module. Attributes are case-insensitive. There are a bunch of suggested ones that all clients/servers should read.

Parameters:

attribute - the attribute name.

Returns:

the corresponding value or null if not found.

getAllAttributes

public java.lang.String[] getAllAttributes()

Gets all of this module header's attributes.

Returns:

an array of all of the attributes. Never returns null.

getAttributeMap

public com.tameif.tame.struct.CaseInsensitiveStringMap<java.lang.String> getAttributeMap()

Gets the attribute map for the header.

Returns:

a reference to the map.

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.