Class YmlPropertiesManager

java.lang.Object

org.codehaus.mojo.properties.managers.YmlPropertiesManager

All Implemented Interfaces:

PropertiesManager

@Named
@Singleton
public class YmlPropertiesManager
extends Object
implements PropertiesManager

Properties manager using YAML as backand.

Field Summary

Fields inherited from interface PropertiesManager

DEFAULT_MANAGER_EXTENSION

Constructor Summary

Constructors

Constructor	Description
YmlPropertiesManager()

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	flattenYamlToMap(String parentKey, Map<String,Object> yamlMap)
boolean	isExtensionSupport(String extension)	Determinate if manager support resource by file extension.
Properties	load(InputStream in)	Load properties.
Properties	load(InputStream in, Charset charset)	Load properties using the given character set.
void	save(Properties properties, OutputStream out, String comments)	Store properties
void	save(Properties properties, OutputStream out, String comments, Charset charset)	Store properties using the given character set.
String	toString()

Methods inherited from class Object

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

Constructor Details

YmlPropertiesManager

public YmlPropertiesManager()

Method Details

isExtensionSupport

public boolean isExtensionSupport(String extension)

Description copied from interface: PropertiesManager

Determinate if manager support resource by file extension.

Specified by:

isExtensionSupport in interface PropertiesManager

Parameters:

extension - file extension

Returns:

true if extension is supported

load

public Properties load(InputStream in)
                throws IOException

Description copied from interface: PropertiesManager

Load properties.

Specified by:

load in interface PropertiesManager

Parameters:

in - input stream of properties resource

Returns:

a properties

Throws:

IOException - in case of IO problems

load

public Properties load(InputStream in,
 Charset charset)
                throws IOException

Description copied from interface: PropertiesManager

Load properties using the given character set.

Specified by:

load in interface PropertiesManager

Parameters:

in - input stream of properties resource

charset - the character set the resource is encoded in

Returns:

a properties

Throws:

IOException - in case of IO problems

flattenYamlToMap

public Map<String,Object> flattenYamlToMap(String parentKey,
 Map<String,Object> yamlMap)

save

public void save(Properties properties,
 OutputStream out,
 String comments)
          throws IOException

Description copied from interface: PropertiesManager

Store properties

Specified by:

save in interface PropertiesManager

Parameters:

properties - properties to store

out - output stream of properties resource

comments - a comments added to output resource

Throws:

IOException - in case of IO problems

save

public void save(Properties properties,
 OutputStream out,
 String comments,
 Charset charset)
          throws IOException

Description copied from interface: PropertiesManager

Store properties using the given character set.

Specified by:

save in interface PropertiesManager

Parameters:

properties - properties to store

out - output stream of properties resource

comments - a comments added to output resource

charset - the character set to encode the resource in

Throws:

IOException - in case of IO problems

toString

public String toString()

Overrides:

toString in class Object