org.mapfish.print.wrapper.yaml

Class PYamlObject

java.lang.Object

org.mapfish.print.wrapper.PElement

org.mapfish.print.wrapper.PAbstractObject

org.mapfish.print.wrapper.yaml.PYamlObject

All Implemented Interfaces:

PObject

public class PYamlObject
extends PAbstractObject

Object wrapper for Yaml parsing.

Constructor Summary

Constructors

Constructor and Description
PYamlObject(java.util.Map<java.lang.String,java.lang.Object> obj, java.lang.String contextName) Constructor.
PYamlObject(PElement parent, java.util.Map<java.lang.String,java.lang.Object> obj, java.lang.String contextName) Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	has(java.lang.String key) Check if the object has a property with the key.
boolean	isArray(java.lang.String key) Is the property an array.
java.util.Iterator<java.lang.String>	keys() Get an iterator of all keys in this objects.
java.lang.Object	opt(java.lang.String key) Get the value for the key.
PArray	optArray(java.lang.String key) Get a property as a array or null.
java.lang.Boolean	optBool(java.lang.String key) Get a property as a boolean or null.
java.lang.Double	optDouble(java.lang.String key) Get a property as a double or defaultValue.
java.lang.Float	optFloat(java.lang.String key) Get a property as a float or null.
java.lang.Integer	optInt(java.lang.String key) Get a property as a int or MIN_VALUE.
java.lang.Long	optLong(java.lang.String key) Get a property as a long or MIN_VALUE.
PObject	optObject(java.lang.String key) Get a property as a object or null.
java.lang.String	optString(java.lang.String key) Get a property as a string or null.
int	size() Get the number of properties in this object.
PJsonObject	toJSON() Convert this object to a json object.
java.lang.String	toString()

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

getArray, getBool, getDouble, getFloat, getInt, getLong, getObject, getString, optArray, optBool, optDouble, optFloat, optInt, optLong, optObject, optString

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, wait, wait, wait

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

getCurrentPath, getPath

Constructor Detail

PYamlObject

public PYamlObject(java.util.Map<java.lang.String,java.lang.Object> obj,
                   java.lang.String contextName)

Constructor.

Parameters:

obj - the internal json element

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

PYamlObject

public PYamlObject(PElement parent,
                   java.util.Map<java.lang.String,java.lang.Object> obj,
                   java.lang.String contextName)

Constructor.

Parameters:

parent - the parent element

obj - the internal json element

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

Method Detail

opt

public final java.lang.Object opt(java.lang.String key)

Description copied from interface: PObject

Get the value for the key.

Parameters:

key - the key identifying the value to obtain.

optString

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

Description copied from interface: PObject

Get a property as a string or null.

Parameters:

key - the property name

optInt

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

Description copied from interface: PObject

Get a property as a int or MIN_VALUE.

Parameters:

key - the property name

optLong

public final java.lang.Long optLong(java.lang.String key)

Description copied from interface: PObject

Get a property as a long or MIN_VALUE.

Parameters:

key - the property name

optDouble

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

Description copied from interface: PObject

Get a property as a double or defaultValue.

Parameters:

key - the property name

optFloat

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

Description copied from interface: PObject

Get a property as a float or null.

Parameters:

key - the property name

optBool

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

Description copied from interface: PObject

Get a property as a boolean or null.

Parameters:

key - the property name

optObject

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

Description copied from interface: PObject

Get a property as a object or null.

Parameters:

key - the property name

optArray

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

Description copied from interface: PObject

Get a property as a array or null.

Parameters:

key - the property name

isArray

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

Description copied from interface: PObject

Is the property an array.

Parameters:

key - the property name

keys

public final java.util.Iterator<java.lang.String> keys()

Description copied from interface: PObject

Get an iterator of all keys in this objects.

Returns:

The keys iterator

size

public final int size()

Description copied from interface: PObject

Get the number of properties in this object.

has

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

Description copied from interface: PObject

Check if the object has a property with the key.

Parameters:

key - key to check for.

toString

public final java.lang.String toString()

Overrides:

toString in class java.lang.Object

toJSON

public final PJsonObject toJSON()

Convert this object to a json object.