org.jwebsocket.token

Class JSONToken

java.lang.Object

org.jwebsocket.token.BaseToken

org.jwebsocket.token.JSONToken

All Implemented Interfaces:

Token

public class JSONToken
extends BaseToken
implements Token

A token is ...

Author:

aschulze

Field Summary

Fields inherited from class org.jwebsocket.token.BaseToken

TT_EVENT

Constructor Summary

Constructors

Constructor and Description
JSONToken() Creates a new empty instance of a token.
JSONToken(org.json.JSONObject aJSON)
JSONToken(String aType)
JSONToken(String aNS, String aType)

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() resets all fields of the token.
Object	get(String aKey)
Boolean	getBoolean(String aArg)
Boolean	getBoolean(String aKey, Boolean aDefault)
Double	getDouble(String aKey)
Double	getDouble(String aKey, Double aDefault)
Integer	getInteger(String aKey)
Integer	getInteger(String aKey, Integer aDefault)
org.json.JSONObject	getJSONObject()
Iterator<String>	getKeyIterator()
List	getList(String aKey)
List	getList(String aKey, List aDefault)
Long	getLong(String aKey)
Long	getLong(String aKey, Long aDefault)
Map	getMap()
Map	getMap(String aKey)
Map	getMap(String aKey, Map aDefault)
Object	getObject(String aKey)
String	getString(String aKey)
String	getString(String aKey, String aDefault)
Token	getToken(String aKey)
Token	getToken(String aKey, Token aDefault)
void	put(String aKey, Object aValue) puts a new key/value pair into the token, in other words it adds a new item to the token.
void	remove(String aKey)
void	set(ITokenizable aTokenizable) copies all fields of the given ITokenizable to the token.
void	setBoolean(String aKey, Boolean aValue)
void	setDouble(String aKey, Double aValue)
void	setInteger(String aKey, Integer aValue)
void	setJSONObject(org.json.JSONObject aJSON)
void	setList(String aKey, List aList)
void	setLong(String aKey, Long aValue)
void	setMap(Map aMap) copies all fields from a Map into the Token.
void	setMap(String aKey, Map aMap)
void	setString(String aKey, String aValue)
void	setToken(String aKey, ITokenizable aTokenizable)
void	setToken(String aKey, Token aToken)
String	toString()

Methods inherited from class org.jwebsocket.token.BaseToken

getNS, getType, setDouble, setNS, setType, setValidated

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jwebsocket.token.Token

getNS, getType, setDouble, setNS, setType, setValidated

Constructor Detail

JSONToken

public JSONToken()

Creates a new empty instance of a token. The token does not contain any items.

JSONToken

public JSONToken(String aType)

Parameters:

aType -

JSONToken

public JSONToken(org.json.JSONObject aJSON)

Parameters:

aJSON -

JSONToken

public JSONToken(String aNS,
         String aType)

Parameters:

aNS -

aType -

Method Detail

clear

public void clear()

Description copied from interface: Token

resets all fields of the token. After this operation the token is empty.

Specified by:

clear in interface Token

set

public void set(ITokenizable aTokenizable)

Description copied from interface: Token

copies all fields of the given ITokenizable to the token. Existing fields do not get deleted but overwritten in case of naming conflicts. Use the clear method to explicitely reset the token if desired.

Specified by:

set in interface Token

getMap

public Map getMap()

Specified by:

getMap in interface Token

Returns:

setMap

public void setMap(Map aMap)

Description copied from interface: Token

copies all fields from a Map into the Token. A check has to be made by the corresponding implementations that only such data types are passed that are supported by the Token abstraction.

Specified by:

setMap in interface Token

Parameters:

aMap -

setJSONObject

public void setJSONObject(org.json.JSONObject aJSON)

Parameters:

aJSON -

getJSONObject

public org.json.JSONObject getJSONObject()

Returns:

put

public void put(String aKey,
       Object aValue)

puts a new key/value pair into the token, in other words it adds a new item to the token.

Parameters:

aKey - key of the the token item.

aValue - value of the token item.

get

public Object get(String aKey)

Parameters:

aKey -

Returns:

remove

public void remove(String aKey)

Specified by:

remove in interface Token

Parameters:

aKey -

getString

public String getString(String aKey,
               String aDefault)

Specified by:

getString in interface Token

Parameters:

aKey -

aDefault -

Returns:

setString

public void setString(String aKey,
             String aValue)

Specified by:

setString in interface Token

Parameters:

aKey -

getString

public String getString(String aKey)

Specified by:

getString in interface Token

Parameters:

aKey -

Returns:

getInteger

public Integer getInteger(String aKey,
                 Integer aDefault)

Specified by:

getInteger in interface Token

Parameters:

aKey -

aDefault -

Returns:

getInteger

public Integer getInteger(String aKey)

Specified by:

getInteger in interface Token

Parameters:

aKey -

Returns:

setInteger

public void setInteger(String aKey,
              Integer aValue)

Specified by:

setInteger in interface Token

getLong

public Long getLong(String aKey,
           Long aDefault)

Specified by:

getLong in interface Token

Parameters:

aKey -

aDefault -

Returns:

getLong

public Long getLong(String aKey)

Specified by:

getLong in interface Token

Parameters:

aKey -

Returns:

setLong

public void setLong(String aKey,
           Long aValue)

Specified by:

setLong in interface Token

getDouble

public Double getDouble(String aKey,
               Double aDefault)

Specified by:

getDouble in interface Token

Parameters:

aKey -

aDefault -

Returns:

getDouble

public Double getDouble(String aKey)

Specified by:

getDouble in interface Token

Parameters:

aKey -

Returns:

setDouble

public void setDouble(String aKey,
             Double aValue)

Specified by:

setDouble in interface Token

getBoolean

public Boolean getBoolean(String aKey,
                 Boolean aDefault)

Specified by:

getBoolean in interface Token

Parameters:

aKey -

aDefault -

Returns:

getBoolean

public Boolean getBoolean(String aArg)

Specified by:

getBoolean in interface Token

Parameters:

aArg -

Returns:

setBoolean

public void setBoolean(String aKey,
              Boolean aValue)

Specified by:

setBoolean in interface Token

Parameters:

aKey -

getList

public List getList(String aKey,
           List aDefault)

Specified by:

getList in interface Token

Parameters:

aKey -

aDefault -

Returns:

getList

public List getList(String aKey)

Specified by:

getList in interface Token

Parameters:

aKey -

Returns:

setList

public void setList(String aKey,
           List aList)

Specified by:

setList in interface Token

Parameters:

aKey -

aList -

setToken

public void setToken(String aKey,
            ITokenizable aTokenizable)

Specified by:

setToken in interface Token

Parameters:

aKey -

aTokenizable -

setToken

public void setToken(String aKey,
            Token aToken)

Specified by:

setToken in interface Token

Parameters:

aKey -

aToken -

getToken

public Token getToken(String aKey)

Specified by:

getToken in interface Token

Parameters:

aKey -

Returns:

getToken

public Token getToken(String aKey,
             Token aDefault)

Specified by:

getToken in interface Token

Parameters:

aKey -

aDefault -

Returns:

getMap

public Map getMap(String aKey,
         Map aDefault)

Specified by:

getMap in interface Token

Parameters:

aKey -

aDefault -

Returns:

getMap

public Map getMap(String aKey)

Specified by:

getMap in interface Token

Parameters:

aKey -

Returns:

setMap

public void setMap(String aKey,
          Map aMap)

Specified by:

setMap in interface Token

Parameters:

aKey -

toString

public String toString()

Overrides:

toString in class Object

Returns:

getKeyIterator

public Iterator<String> getKeyIterator()

Specified by:

getKeyIterator in interface Token

Returns:

getObject

public Object getObject(String aKey)

Specified by:

getObject in interface Token

Parameters:

aKey -

Returns: