com.sk89q.util.yaml

Class YAMLProcessor

java.lang.Object

com.sk89q.util.yaml.YAMLNode

com.sk89q.util.yaml.YAMLProcessor

public class YAMLProcessor
extends YAMLNode

YAML configuration loader. To use this class, construct it with path to a file and call its load() method. For specifying node paths in the various get*() methods, they support SK's path notation, allowing you to select child nodes by delimiting node names with periods.

For example, given the following configuration file:

members:
     - Hollie
     - Jason
     - Bobo
     - Aya
     - Tetsu
 worldguard:
     fire:
         spread: false
         blocks: [cloth, rock, glass]
 sturmeh:
     cool: false
     eats:
         babies: true

Calling code could access sturmeh's baby eating state by using getBoolean("sturmeh.eats.babies", false). For lists, there are methods such as getStringList that will return a type safe list.

Author:

sk89q

Field Summary

Fields

Modifier and Type	Field and Description
static char	COMMENT_CHAR
protected File	file
protected YAMLFormat	format
protected String	header
static String	LINE_BREAK
protected org.yaml.snakeyaml.Yaml	yaml

Fields inherited from class com.sk89q.util.yaml.YAMLNode

root

Constructor Summary

Constructors

Constructor and Description
YAMLProcessor(File file, boolean writeDefaults)
YAMLProcessor(File file, boolean writeDefaults, YAMLFormat format)

Method Summary

Methods

Modifier and Type	Method and Description
String	getComment(String key) Returns a root-level comment.
Map<String,String>	getComments() Returns root-level comments.
static YAMLNode	getEmptyNode(boolean writeDefaults) This method returns an empty ConfigurationNode for using as a default in methods that select a node from a node list.
String	getHeader() Return the set header.
InputStream	getInputStream()
OutputStream	getOutputStream()
void	load() Loads the configuration file.
boolean	save() Saves the configuration to disk.
void	setComment(String key, String... comment) Set a root-level comment.
void	setComment(String key, String comment)
void	setComments(Map<String,String> comments) Set root-level comments from a map.
void	setHeader(String... headerLines) Set the header for the file as a series of lines that are terminated by a new line sequence.
void	setHeader(String header) Set the header for the file.

Methods inherited from class com.sk89q.util.yaml.YAMLNode

addNode, clear, getBlockVector2dList, getBoolean, getBoolean, getBooleanList, getDouble, getDouble, getDoubleList, getInt, getInt, getIntList, getKeys, getList, getMap, getNode, getNodeList, getNodes, getProperty, getString, getString, getStringList, getVector, getVector, getVector2d, getVector2dList, getVectorList, removeProperty, setProperty, setWriteDefaults, writeDefaults

Methods inherited from class java.lang.Object

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

Field Detail

LINE_BREAK

public static final String LINE_BREAK

COMMENT_CHAR

public static final char COMMENT_CHAR

See Also:

Constant Field Values

yaml

protected final org.yaml.snakeyaml.Yaml yaml

file

protected final File file

header

protected String header

format

protected YAMLFormat format

Constructor Detail

YAMLProcessor

public YAMLProcessor(File file,
             boolean writeDefaults,
             YAMLFormat format)

YAMLProcessor

public YAMLProcessor(File file,
             boolean writeDefaults)

Method Detail

load

public void load()
          throws IOException

Loads the configuration file.

Throws:

IOException

setHeader

public void setHeader(String... headerLines)

Set the header for the file as a series of lines that are terminated by a new line sequence.

Parameters:

headerLines - header lines to prepend

setHeader

public void setHeader(String header)

Set the header for the file. A header can be provided to prepend the YAML data output on configuration save. The header is printed raw and so must be manually commented if used. A new line will be appended after the header, however, if a header is provided.

Parameters:

header - header to prepend

getHeader

public String getHeader()

Return the set header.

Returns:

save

public boolean save()

Saves the configuration to disk. All errors are clobbered.

Returns:

true if it was successful

getInputStream

public InputStream getInputStream()
                           throws IOException

Throws:

IOException

getOutputStream

public OutputStream getOutputStream()
                             throws IOException

Throws:

IOException

getComment

public String getComment(String key)

Returns a root-level comment.

Parameters:

key - the property key

Returns:

the comment or null

setComment

public void setComment(String key,
              String comment)

setComment

public void setComment(String key,
              String... comment)

Set a root-level comment.

Parameters:

key - the property key

comment - the comment. May be null, in which case the comment is removed.

getComments

public Map<String,String> getComments()

Returns root-level comments.

Returns:

map of root-level comments

setComments

public void setComments(Map<String,String> comments)

Set root-level comments from a map.

Parameters:

comments - comment map

getEmptyNode

public static YAMLNode getEmptyNode(boolean writeDefaults)

This method returns an empty ConfigurationNode for using as a default in methods that select a node from a node list.

Returns: