com.esotericsoftware.yamlbeans

Class YamlConfig

java.lang.Object

com.esotericsoftware.yamlbeans.YamlConfig

Direct Known Subclasses:

UnsafeYamlConfig

public class YamlConfig
extends Object

Stores configuration for reading and writing YAML.

Author:

Nathan Sweet

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	YamlConfig.Quote
static class	YamlConfig.ReadConfig
static class	YamlConfig.WriteClassName
static class	YamlConfig.WriteConfig

Field Summary

Fields

Modifier and Type	Field and Description
YamlConfig.ReadConfig	readConfig Configuration for reading YAML.
YamlConfig.WriteConfig	writeConfig Configuration for writing YAML.

Constructor Summary

Constructors

Constructor and Description
YamlConfig()

Method Summary

Modifier and Type	Method and Description
void	setAllowDuplicates(boolean allowDuplicates) Allows duplicate keys in YAML document.
void	setBeanProperties(boolean beanProperties) If true, bean properties with both a getter and setter will be used.
void	setClassTag(String tag, Class type) Allows the specified tag to be used in YAML instead of the full class name.
void	setPrivateConstructors(boolean privateConstructors) If true, private no-arg constructors will be used.
void	setPrivateFields(boolean privateFields) If true, private non-transient fields will be used.
void	setPropertyDefaultType(Class type, String propertyName, Class defaultType) Sets the default type of a property.
void	setPropertyElementType(Class type, String propertyName, Class elementType) Sets the default type of elements in a Collection or Map property.
void	setScalarSerializer(Class type, ScalarSerializer serializer) Adds a serializer for the specified scalar type
void	setTagSuffix(String tagSuffix) When not null, YAML read into a Map stores any value tags using key + tagSuffix, and when writing YAML the value tags are output.

Methods inherited from class java.lang.Object

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

Field Detail

writeConfig

public YamlConfig.WriteConfig writeConfig

Configuration for writing YAML.

readConfig

public YamlConfig.ReadConfig readConfig

Configuration for reading YAML.

Constructor Detail

YamlConfig

public YamlConfig()

Method Detail

setAllowDuplicates

public void setAllowDuplicates(boolean allowDuplicates)

Allows duplicate keys in YAML document. Default is true

Parameters:

allowDuplicates - allow duplicates.

setClassTag

public void setClassTag(String tag,
                        Class type)

Allows the specified tag to be used in YAML instead of the full class name.

Parameters:

tag - the tag to be used instead of the class.

type - the class the tag will link to.

setScalarSerializer

public void setScalarSerializer(Class type,
                                ScalarSerializer serializer)

Adds a serializer for the specified scalar type

Parameters:

type - the class type the serializer will be linked to.

serializer - the serializer.

setPropertyElementType

public void setPropertyElementType(Class type,
                                   String propertyName,
                                   Class elementType)

Sets the default type of elements in a Collection or Map property. No tag will be output for elements of this type. This type will be used for each element if no tag is found.

Parameters:

type - default class.

propertyName - name of property.

elementType - element type.

setPropertyDefaultType

public void setPropertyDefaultType(Class type,
                                   String propertyName,
                                   Class defaultType)

Sets the default type of a property. No tag will be output for values of this type. This type will be used if no tag is found.

Parameters:

type - class type

propertyName - name of property

defaultType - default class type.

setBeanProperties

public void setBeanProperties(boolean beanProperties)

If true, bean properties with both a getter and setter will be used. Note the getter and setter methods must be named the same as the field they get or set. Default is true.

Parameters:

beanProperties - bean properties.

setPrivateFields

public void setPrivateFields(boolean privateFields)

If true, private non-transient fields will be used. Default is false.

Parameters:

privateFields - enable private fields.

setPrivateConstructors

public void setPrivateConstructors(boolean privateConstructors)

If true, private no-arg constructors will be used. Default is true.

Parameters:

privateConstructors - enable private constructors.

setTagSuffix

public void setTagSuffix(String tagSuffix)

When not null, YAML read into a Map stores any value tags using key + tagSuffix, and when writing YAML the value tags are output. Key tags are not stored in the map. Default is null.

Parameters:

tagSuffix - tag suffix