org.yaml.snakeyaml
Class TypeDescription

java.lang.Object
  org.yaml.snakeyaml.TypeDescription

public final class TypeDescription
extends java.lang.Object

Provides additional runtime information necessary to create a custom Java instance.

Constructor Summary

TypeDescription(java.lang.Class<? extends java.lang.Object> clazz)

TypeDescription(java.lang.Class<? extends java.lang.Object> clazz, java.lang.String tag)

TypeDescription(java.lang.Class<? extends java.lang.Object> clazz, Tag tag)

Method Summary

java.lang.Class<? extends java.lang.Object>	getListPropertyType(java.lang.String property) Get class of List values for provided JavaBean property.
java.lang.Class<? extends java.lang.Object>	getMapKeyType(java.lang.String property) Get keys type info for this JavaBean
java.lang.Class<? extends java.lang.Object>	getMapValueType(java.lang.String property) Get values type info for this JavaBean
Tag	getTag() Get tag which shall be used to load or dump the type (class).
java.lang.Class<? extends java.lang.Object>	getType() Get represented type (class)
boolean	isRoot() Defines whether this type (class) is the root of the YAML document
void	putListPropertyType(java.lang.String property, java.lang.Class<? extends java.lang.Object> type) Specify that the property is a type-safe List.
void	putMapPropertyType(java.lang.String property, java.lang.Class<? extends java.lang.Object> key, java.lang.Class<? extends java.lang.Object> value) Specify that the property is a type-safe Map.
void	setRoot(boolean root) Specify whether this type (class) should be serve as the root of the YAML document
void	setTag(java.lang.String tag)
void	setTag(Tag tag) Set tag to be used to load or dump the type (class).
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

TypeDescription

public TypeDescription(java.lang.Class<? extends java.lang.Object> clazz,
                       Tag tag)

TypeDescription

public TypeDescription(java.lang.Class<? extends java.lang.Object> clazz,
                       java.lang.String tag)

TypeDescription

public TypeDescription(java.lang.Class<? extends java.lang.Object> clazz)

Method Detail

getTag

public Tag getTag()

Get tag which shall be used to load or dump the type (class).

Returns:

tag to be used. It may be a tag for Language-Independent Types (http://www.yaml.org/type/)

setTag

public void setTag(Tag tag)

Set tag to be used to load or dump the type (class).

Parameters:

tag - local or global tag

setTag

public void setTag(java.lang.String tag)

getType

public java.lang.Class<? extends java.lang.Object> getType()

Get represented type (class)

Returns:

type (class) to be described.

isRoot

public boolean isRoot()

Defines whether this type (class) is the root of the YAML document

Returns:

true if this type shall be used as a root of object hierarchy.

setRoot

public void setRoot(boolean root)

Specify whether this type (class) should be serve as the root of the YAML document

Parameters:

root - true if this type shall be used as a root of object hierarchy.

putListPropertyType

public void putListPropertyType(java.lang.String property,
                                java.lang.Class<? extends java.lang.Object> type)

Specify that the property is a type-safe List.

Parameters:

property - name of the JavaBean property

type - class of List values

getListPropertyType

public java.lang.Class<? extends java.lang.Object> getListPropertyType(java.lang.String property)

Get class of List values for provided JavaBean property.

Parameters:

property - property name

Returns:

class of List values

putMapPropertyType

public void putMapPropertyType(java.lang.String property,
                               java.lang.Class<? extends java.lang.Object> key,
                               java.lang.Class<? extends java.lang.Object> value)

Specify that the property is a type-safe Map.

Parameters:

property - property name of this JavaBean

key - class of keys in Map

value - class of values in Map

getMapKeyType

public java.lang.Class<? extends java.lang.Object> getMapKeyType(java.lang.String property)

Get keys type info for this JavaBean

Parameters:

property - property name of this JavaBean

Returns:

class of keys in the Map

getMapValueType

public java.lang.Class<? extends java.lang.Object> getMapValueType(java.lang.String property)

Get values type info for this JavaBean

Parameters:

property - property name of this JavaBean

Returns:

class of values in the Map

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object