me.timothy.bots.responses

Class ResponseInfo

java.lang.Object

me.timothy.bots.responses.ResponseInfo

public class ResponseInfo
extends java.lang.Object

Allows sophisticated, but easy, formatting for responses by combining long-term things like headers, footers, etc. with information pertinent to a specific response

Author:

Timothy

Constructor Summary

Constructors

Constructor and Description
ResponseInfo() Creates a new response info with an empty map
ResponseInfo(ResponseInfo o) Creates a response info that shallow copies another response info

Method Summary

Modifier and Type	Method and Description
void	addLongtermObject(java.lang.String key, FormattableObject obj) Adds a longterm object to this response info
void	addLongtermString(java.lang.String key, java.lang.String obj)
void	addTemporaryObject(java.lang.String key, FormattableObject obj) Adds a temporary object to the response info
void	addTemporaryString(java.lang.String key, java.lang.String obj)
void	clearTemporary() Clears all the temporary objects
FormattableObject	getObject(java.lang.String key) Gets an object, either permanent or temporary
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ResponseInfo

public ResponseInfo()

Creates a new response info with an empty map

ResponseInfo

public ResponseInfo(ResponseInfo o)

Creates a response info that shallow copies another response info

Parameters:

o - the object to shallow copy

Method Detail

addLongtermObject

public void addLongtermObject(java.lang.String key,
                              FormattableObject obj)

Adds a longterm object to this response info

Parameters:

key - the key to use

obj - the object mapped to the key

addLongtermString

public void addLongtermString(java.lang.String key,
                              java.lang.String obj)

addTemporaryObject

public void addTemporaryObject(java.lang.String key,
                               FormattableObject obj)

Adds a temporary object to the response info

Parameters:

key - the key to use

obj - the object mapped to key

addTemporaryString

public void addTemporaryString(java.lang.String key,
                               java.lang.String obj)

getObject

public FormattableObject getObject(java.lang.String key)

Gets an object, either permanent or temporary

Parameters:

key - the key to search for

Returns:

the mapped object or null

clearTemporary

public void clearTemporary()

Clears all the temporary objects

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object