org.mapfish.print.wrapper

Class PAbstractObject

java.lang.Object

org.mapfish.print.wrapper.PElement

org.mapfish.print.wrapper.PAbstractObject

All Implemented Interfaces:

PObject

Direct Known Subclasses:

PJsonObject, PMultiObject, PYamlObject

public abstract class PAbstractObject
extends PElement
implements PObject

Abstract class for PObject implementation.

Constructor Summary

Constructors

Constructor and Description
PAbstractObject(PElement parent, java.lang.String contextName) Constructor.

Method Summary

Modifier and Type	Method and Description
PArray	getArray(java.lang.String key) Get a property as a array or throw exception.
boolean	getBool(java.lang.String key) Get a property as a boolean or throw exception.
double	getDouble(java.lang.String key) Get a property as a double or throw an exception.
float	getFloat(java.lang.String key) Get a property as a float or throw an exception.
int	getInt(java.lang.String key) Get a property as an int or throw an exception.
long	getLong(java.lang.String key) Get a property as an long or throw an exception.
PObject	getObject(java.lang.String key) Get a property as a object or throw exception.
java.lang.String	getString(java.lang.String key) Get a property as a string or throw an exception.
PArray	optArray(java.lang.String key, PArray defaultValue) Get a property as a array or default.
java.lang.Boolean	optBool(java.lang.String key, java.lang.Boolean defaultValue) Get a property as a boolean or default value.
java.lang.Double	optDouble(java.lang.String key, java.lang.Double defaultValue) Get a property as a double or defaultValue.
java.lang.Float	optFloat(java.lang.String key, java.lang.Float defaultValue) Get a property as a float or Default value.
java.lang.Integer	optInt(java.lang.String key, java.lang.Integer defaultValue) Get a property as an int or default value.
long	optLong(java.lang.String key, long defaultValue) Get a property as an long or default value.
PObject	optObject(java.lang.String key, PObject defaultValue) Get a property as a array or default.
java.lang.String	optString(java.lang.String key, java.lang.String defaultValue) Get a property as a string or defaultValue.

Methods inherited from class org.mapfish.print.wrapper.PElement

addPathTo, getContextName, getCurrentPath, getParent, getPath

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.mapfish.print.wrapper.PObject

getCurrentPath, getPath, has, isArray, keys, opt, optArray, optBool, optDouble, optFloat, optInt, optLong, optObject, optString, size

Constructor Detail

PAbstractObject

public PAbstractObject(PElement parent,
                       java.lang.String contextName)

Constructor.

Parameters:

parent - the parent element

contextName - the field name of this element in the parent.

Method Detail

getString

public final java.lang.String getString(java.lang.String key)

Get a property as a string or throw an exception.

Specified by:

getString in interface PObject

Parameters:

key - the property name

optString

public final java.lang.String optString(java.lang.String key,
                                        java.lang.String defaultValue)

Get a property as a string or defaultValue.

Specified by:

optString in interface PObject

Parameters:

key - the property name

defaultValue - the default value

getInt

public final int getInt(java.lang.String key)

Get a property as an int or throw an exception.

Specified by:

getInt in interface PObject

Parameters:

key - the property name

optInt

public final java.lang.Integer optInt(java.lang.String key,
                                      java.lang.Integer defaultValue)

Get a property as an int or default value.

Specified by:

optInt in interface PObject

Parameters:

key - the property name

defaultValue - the default value

getLong

public final long getLong(java.lang.String key)

Get a property as an long or throw an exception.

Specified by:

getLong in interface PObject

Parameters:

key - the property name

optLong

public final long optLong(java.lang.String key,
                          long defaultValue)

Get a property as an long or default value.

Specified by:

optLong in interface PObject

Parameters:

key - the property name

defaultValue - the default value

getDouble

public final double getDouble(java.lang.String key)

Get a property as a double or throw an exception.

Specified by:

getDouble in interface PObject

Parameters:

key - the property name

optDouble

public final java.lang.Double optDouble(java.lang.String key,
                                        java.lang.Double defaultValue)

Get a property as a double or defaultValue.

Specified by:

optDouble in interface PObject

Parameters:

key - the property name

defaultValue - the default value

getFloat

public final float getFloat(java.lang.String key)

Get a property as a float or throw an exception.

Specified by:

getFloat in interface PObject

Parameters:

key - the property name

optFloat

public final java.lang.Float optFloat(java.lang.String key,
                                      java.lang.Float defaultValue)

Get a property as a float or Default value.

Specified by:

optFloat in interface PObject

Parameters:

key - the property name

defaultValue - default value

getBool

public final boolean getBool(java.lang.String key)

Get a property as a boolean or throw exception.

Specified by:

getBool in interface PObject

Parameters:

key - the property name

optBool

public final java.lang.Boolean optBool(java.lang.String key,
                                       java.lang.Boolean defaultValue)

Get a property as a boolean or default value.

Specified by:

optBool in interface PObject

Parameters:

key - the property name

defaultValue - the default

getObject

public final PObject getObject(java.lang.String key)

Get a property as a object or throw exception.

Specified by:

getObject in interface PObject

Parameters:

key - the property name

optObject

public final PObject optObject(java.lang.String key,
                               PObject defaultValue)

Get a property as a array or default.

Specified by:

optObject in interface PObject

Parameters:

key - the property name

defaultValue - default

getArray

public final PArray getArray(java.lang.String key)

Get a property as a array or throw exception.

Specified by:

getArray in interface PObject

Parameters:

key - the property name

optArray

public final PArray optArray(java.lang.String key,
                             PArray defaultValue)

Get a property as a array or default.

Specified by:

optArray in interface PObject

Parameters:

key - the property name

defaultValue - default