csip.api.server

Interface PayloadMetaInfo

public interface PayloadMetaInfo

Payload Metainfo access.

Author:

od

Method Summary

Modifier and Type	Method and Description
void	appendWarning(java.lang.String msg) Append a warning.
boolean	getBoolean(java.lang.String name) Get a metainfo value as boolean.
boolean	getBoolean(java.lang.String name, boolean def)
int	getCount() Get the number of metainfo entries.
double	getDouble(java.lang.String name) Get the metainfo value as double.
double	getDouble(java.lang.String name, double def)
int	getInt(java.lang.String name) Get metainfo value as int.
int	getInt(java.lang.String name, int def) Get metainfo value as int.
java.util.Collection<java.lang.String>	getNames() Get all metainfo names.
java.lang.String	getString(java.lang.String name) Get the metainfo value as String.
java.lang.String	getString(java.lang.String name, java.lang.String def)
java.lang.String[]	getStringArray(java.lang.String name) Get the metainfo value as StringArray.
java.lang.String[]	getStringArray(java.lang.String name, java.lang.String[] def)
boolean	hasName(java.lang.String name) Check if a metainfo entry exists.
void	put(java.lang.String key, double value)
void	put(java.lang.String key, int value)
void	put(java.lang.String key, long value)
void	put(java.lang.String key, java.lang.String value)
void	put(java.lang.String key, java.lang.String[] value)
PayloadMetaInfo	require(java.lang.String... names) Check is a required key exists.
void	setWarning(java.lang.String msg) Set a warning message.

Method Detail

getString

java.lang.String getString(java.lang.String name)
                    throws ServiceException

Get the metainfo value as String.

Parameters:

name - the name of the metainfo entry

Returns:

the value of a metainfo entry

Throws:

ServiceException - if there is a JSON error.

getString

java.lang.String getString(java.lang.String name,
                           java.lang.String def)

getStringArray

java.lang.String[] getStringArray(java.lang.String name)
                           throws ServiceException

Get the metainfo value as StringArray.

Parameters:

name - the name of the metainfo entry

Returns:

the value of a metainfo entry

Throws:

ServiceException - if there is a JSON error.

getStringArray

java.lang.String[] getStringArray(java.lang.String name,
                                  java.lang.String[] def)

getInt

int getInt(java.lang.String name)
    throws ServiceException

Get metainfo value as int.

Parameters:

name - the name of the metainfo entry

Returns:

the int value of a metainfo entry.

Throws:

ServiceException - if there is a JSON error.

getInt

int getInt(java.lang.String name,
           int def)
    throws ServiceException

Get metainfo value as int.

Parameters:

name - the name of the metainfo entry

def - the default value

Returns:

the int value of a metainfo entry.

Throws:

ServiceException - if there is a JSON error.

getDouble

double getDouble(java.lang.String name)
          throws ServiceException

Get the metainfo value as double.

Parameters:

name - the name of the metainfo entry

Returns:

the metainfo value.

Throws:

ServiceException - if there is a JSON error.

getDouble

double getDouble(java.lang.String name,
                 double def)
          throws ServiceException

Throws:

ServiceException

getBoolean

boolean getBoolean(java.lang.String name)
            throws ServiceException

Get a metainfo value as boolean.

Parameters:

name - the name of the metainfo entry

Returns:

the metainfo value

Throws:

ServiceException - if there is a JSON error.

getBoolean

boolean getBoolean(java.lang.String name,
                   boolean def)

hasName

boolean hasName(java.lang.String name)

Check if a metainfo entry exists.

Parameters:

name - the name of a metainfo name.

Returns:

true if a metainfo entry exists, false otherwise

require

PayloadMetaInfo require(java.lang.String... names)
                 throws ServiceException

Check is a required key exists.

Parameters:

names - the parameter name

Returns:

this object

Throws:

ServiceException - if the parameter is not found.

getNames

java.util.Collection<java.lang.String> getNames()

Get all metainfo names.

Returns:

the set of metainfo names.

getCount

int getCount()

Get the number of metainfo entries.

Returns:

the number of entries.

setWarning

void setWarning(java.lang.String msg)
         throws ServiceException

Set a warning message.

Parameters:

msg - the message

Throws:

ServiceException - if warning cannot be added.

put

void put(java.lang.String key,
         java.lang.String value)
  throws ServiceException

Throws:

ServiceException

put

void put(java.lang.String key,
         int value)
  throws ServiceException

Throws:

ServiceException

put

void put(java.lang.String key,
         long value)
  throws ServiceException

Throws:

ServiceException

put

void put(java.lang.String key,
         double value)
  throws ServiceException

Throws:

ServiceException

put

void put(java.lang.String key,
         java.lang.String[] value)
  throws ServiceException

Throws:

ServiceException

appendWarning

void appendWarning(java.lang.String msg)
            throws ServiceException

Append a warning.

Parameters:

msg - the message to append

Throws:

ServiceException - if json operation fails