org.beryx.textio.web

Class TextTerminalData

java.lang.Object

org.beryx.textio.web.TextTerminalData

public class TextTerminalData
extends Object

The data sent by the server to a polling web component. Includes:

• an action to be executed by the web component (NONE, READ, READ_MASKED, DISPOSE or ABORT).
• a boolean value indicating whether the terminal should reset its settings before performing the specified action.
• a list of TextTerminalData.MessageGroups, each one consisting of a list of settings (represented as TextTerminalData.KeyValues) and a list of prompt messages.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TextTerminalData.Action
static class	TextTerminalData.KeyValue A key-value pair
static class	TextTerminalData.MessageGroup A group of messages sharing the same settings

Constructor Summary

Constructors

Constructor and Description
TextTerminalData()

Method Summary

Modifier and Type	Method and Description
String	addMessage(String message)
void	addRawMessage(String message)
void	addSetting(String key, Object value)
void	addSetting(TextTerminalData.KeyValue keyVal)
void	clear()
TextTerminalData.Action	getAction()
String	getActionData()
TextTerminalData	getCopy()
List<TextTerminalData.MessageGroup>	getMessageGroups()
boolean	hasAction()
boolean	isEmpty()
boolean	isNewGroupRequiredForSetting()
boolean	isResetRequired()
TextTerminalData.MessageGroup	newMessageGroup()
void	setAction(TextTerminalData.Action action)
void	setActionData(String actionData)
void	setResetRequired(boolean resetRequired)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

TextTerminalData

public TextTerminalData()

Method Detail

getCopy

public TextTerminalData getCopy()

getMessageGroups

public List<TextTerminalData.MessageGroup> getMessageGroups()

newMessageGroup

public TextTerminalData.MessageGroup newMessageGroup()

isNewGroupRequiredForSetting

public boolean isNewGroupRequiredForSetting()

addSetting

public void addSetting(String key,
                       Object value)

addSetting

public void addSetting(TextTerminalData.KeyValue keyVal)

addRawMessage

public void addRawMessage(String message)

addMessage

public String addMessage(String message)

getAction

public TextTerminalData.Action getAction()

setAction

public void setAction(TextTerminalData.Action action)

getActionData

public String getActionData()

setActionData

public void setActionData(String actionData)

isResetRequired

public boolean isResetRequired()

setResetRequired

public void setResetRequired(boolean resetRequired)

isEmpty

public boolean isEmpty()

hasAction

public boolean hasAction()

clear

public void clear()

toString

public String toString()

Overrides:

toString in class Object