org.fulib.yaml

Class YamlObject

java.lang.Object

org.fulib.yaml.YamlObject

public class YamlObject
extends java.lang.Object

A container for arbitrary attributes. Simple attributes can be set with put(String, Object) and get with get(String). Collection attributes can be created with with(String, Object).

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ID
static java.lang.String	TYPE

Constructor Summary

Constructors

Constructor and Description
YamlObject()
YamlObject(java.lang.String id)
YamlObject(java.lang.String id, java.lang.String type)

Method Summary

Modifier and Type	Method and Description
java.lang.Object	get(java.lang.String property)
java.lang.String	getId() Convenience getter for get(ID).
java.util.LinkedHashMap<java.lang.String,java.lang.Object>	getMap() Deprecated. since 1.2; use getProperties() instead
java.util.Map<java.lang.String,java.lang.Object>	getProperties()
java.lang.String	getType() Convenience getter for get(TYPE).
YamlObject	put(java.lang.String property, java.lang.Object value) Sets the attribute value for the given property name.
void	setId(java.lang.String id) Convenience setter for put(ID, id).
void	setType(java.lang.String type) Convenience setter for put(TYPE, type).
java.lang.String	toString()
YamlObject	with(java.lang.String property, java.lang.Object item) Adds the item to the collection attribute with the given property name.

Methods inherited from class java.lang.Object

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

Field Detail

ID

public static final java.lang.String ID

See Also:

Constant Field Values

TYPE

public static final java.lang.String TYPE

See Also:

Constant Field Values

Constructor Detail

YamlObject

public YamlObject()

YamlObject

public YamlObject(java.lang.String id)

Parameters:

id - the id

Since:

1.2

YamlObject

public YamlObject(java.lang.String id,
                  java.lang.String type)

Parameters:

id - the id

type - the type

Method Detail

getMap

@Deprecated
public java.util.LinkedHashMap<java.lang.String,java.lang.Object> getMap()

Deprecated. since 1.2; use getProperties() instead

Returns:

the map of property names to property values

getProperties

public java.util.Map<java.lang.String,java.lang.Object> getProperties()

Returns:

the map of property names to property values

Since:

1.2

getId

public java.lang.String getId()

Convenience getter for get(ID). In particular, roughly implemented as

    final Object id = this.get(ID);
    return id != null ? id.toString() : null;
 

Returns:

the ID

Since:

1.2

setId

public void setId(java.lang.String id)

Convenience setter for put(ID, id).

Parameters:

id - the ID

Since:

1.2

getType

public java.lang.String getType()

Convenience getter for get(TYPE). In particular, roughly implemented as

    final Object type = this.get(TYPE);
    return type != null ? type.toString() : null;
 

Returns:

the type

Since:

1.2

setType

public void setType(java.lang.String type)

Convenience setter for put(TYPE, type).

Parameters:

type - the type

Since:

1.2

get

public java.lang.Object get(java.lang.String property)

Parameters:

property - the property name

Returns:

the attribute value for the given property name, or null if not specified

put

public YamlObject put(java.lang.String property,
                      java.lang.Object value)

Sets the attribute value for the given property name.

Parameters:

property - the property name

value - the attribute value

Returns:

this instance, to allow method chaining

with

public YamlObject with(java.lang.String property,
                       java.lang.Object item)

Adds the item to the collection attribute with the given property name. In particular, the implementation is as follows:

1. If the property is not set, set the item as the attribute value as if put(String, Object)(property, item) was called
2. If the property is already set and the value is a List, add the item to that list
3. If the property is already set and the value is not a List, create a new list with the old value and the item and set that as the new value

Parameters:

property - the property name

item - the item to add or set

Returns:

this instance, to allow method chaining

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object