org.jwebsocket.token

Interface Token

All Known Implementing Classes:

BaseToken, JSONToken, MapToken

public interface Token

Author:

aschulze

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() resets all fields of the token.
Boolean	getBoolean(String aKey)
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)
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)
String	getNS()
Object	getObject(String aKey)
String	getString(String aKey)
String	getString(String aKey, String aDefault)
Token	getToken(String aKey)
Token	getToken(String aKey, Token aDefault)
String	getType()
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	setDouble(String aKey, Float aValue)
void	setInteger(String aKey, Integer aValue)
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	setNS(String aNS)
void	setString(String aKey, String aValue)
void	setToken(String aKey, ITokenizable aTokenizable)
void	setToken(String aKey, Token aToken)
void	setType(String aType)
boolean	setValidated(String aKey, Object aObj) validates the passed objects and uses the appropriate assignment method

Method Detail

clear

void clear()

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

set

void set(ITokenizable aTokenizable)

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.

Parameters:

aTokenizable -

getMap

Map getMap()

Returns:

setMap

void setMap(Map aMap)

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.

getObject

Object getObject(String aKey)

Parameters:

aKey -

Returns:

getString

String getString(String aKey,
               String aDefault)

Parameters:

aKey -

aDefault -

Returns:

getString

String getString(String aKey)

Parameters:

aKey -

Returns:

setString

void setString(String aKey,
             String aValue)

Parameters:

aKey -

aValue -

getInteger

Integer getInteger(String aKey,
                 Integer aDefault)

Parameters:

aKey -

aDefault -

Returns:

getInteger

Integer getInteger(String aKey)

Parameters:

aKey -

Returns:

setInteger

void setInteger(String aKey,
              Integer aValue)

Parameters:

aKey -

aValue -

getLong

Long getLong(String aKey,
           Long aDefault)

Parameters:

aKey -

aDefault -

Returns:

getLong

Long getLong(String aKey)

Parameters:

aKey -

Returns:

setLong

void setLong(String aKey,
           Long aValue)

Parameters:

aKey -

aValue -

getDouble

Double getDouble(String aKey,
               Double aDefault)

Parameters:

aKey -

aDefault -

Returns:

getDouble

Double getDouble(String aKey)

Parameters:

aKey -

Returns:

setDouble

void setDouble(String aKey,
             Double aValue)

Parameters:

aKey -

aValue -

setDouble

void setDouble(String aKey,
             Float aValue)

Parameters:

aKey -

aValue -

getBoolean

Boolean getBoolean(String aKey,
                 Boolean aDefault)

Parameters:

aKey -

aDefault -

Returns:

getBoolean

Boolean getBoolean(String aKey)

Parameters:

aKey -

Returns:

setBoolean

void setBoolean(String aKey,
              Boolean aValue)

Parameters:

aKey -

aValue -

getList

List getList(String aKey,
           List aDefault)

Parameters:

aKey -

aDefault -

Returns:

getList

List getList(String aKey)

Parameters:

aKey -

Returns:

setList

void setList(String aKey,
           List aList)

Parameters:

aKey -

aList -

setToken

void setToken(String aKey,
            ITokenizable aTokenizable)

Parameters:

aKey -

aTokenizable -

setToken

void setToken(String aKey,
            Token aToken)

Parameters:

aKey -

aToken -

getToken

Token getToken(String aKey)

Parameters:

aKey -

Returns:

getToken

Token getToken(String aKey,
             Token aDefault)

Parameters:

aKey -

aDefault -

Returns:

getMap

Map getMap(String aKey,
         Map aDefault)

Parameters:

aKey -

aDefault -

Returns:

getMap

Map getMap(String aKey)

Parameters:

aKey -

Returns:

setMap

void setMap(String aKey,
          Map aMap)

Parameters:

aKey -

aMap -

remove

void remove(String aKey)

Parameters:

aKey -

getType

String getType()

Returns:

setType

void setType(String aType)

Parameters:

aType -

getNS

String getNS()

Returns:

setNS

void setNS(String aNS)

Parameters:

aNS -

setValidated

boolean setValidated(String aKey,
                   Object aObj)

validates the passed objects and uses the appropriate assignment method

Parameters:

aKey -

aObj -

Returns:

true if value could be set otherwise false

getKeyIterator

Iterator<String> getKeyIterator()

Returns: