org.ho.yaml
Class Yaml

java.lang.Object
  org.ho.yaml.Yaml

public class Yaml
extends java.lang.Object

Yaml is the front end to the Jyaml library. It contains the most commonly used and easy to use methods for accessing Yaml. For most usages, this is the only class one needs to use. All of these methods also exist in YamlOperations and are documented there. See YamlOperations.

Field Summary

static YamlConfig

config

Constructor Summary

Yaml()

Method Summary

static java.lang.String	dump(java.lang.Object obj)
static java.lang.String	dump(java.lang.Object obj, boolean minimalOutput)
static void	dump(java.lang.Object obj, java.io.File file)
static void	dump(java.lang.Object obj, java.io.File file, boolean minimalOutput)
static java.lang.String	dumpStream(java.util.Iterator iterator)
static java.lang.String	dumpStream(java.util.Iterator iterator, boolean minimalOutput)
static void	dumpStream(java.util.Iterator iterator, java.io.File file)
static void	dumpStream(java.util.Iterator iterator, java.io.File file, boolean minimalOutput)
static java.lang.Object	load(java.io.File file)
static java.lang.Object	load(java.io.InputStream in)
static java.lang.Object	load(java.io.Reader reader)
static java.lang.Object	load(java.lang.String yamlText)
static YamlStream	loadStream(java.io.File file)
static YamlStream	loadStream(java.io.InputStream in)
static YamlStream	loadStream(java.io.Reader reader)
static YamlStream	loadStream(java.lang.String yamlText)
static <T> YamlStream<T>	loadStreamOfType(java.io.File file, java.lang.Class<T> clazz)
static <T> YamlStream<T>	loadStreamOfType(java.io.InputStream in, java.lang.Class<T> clazz)
static <T> YamlStream<T>	loadStreamOfType(java.io.Reader reader, java.lang.Class<T> clazz)
static <T> YamlStream<T>	loadStreamOfType(java.lang.String yamlText, java.lang.Class<T> clazz)
static <T> T	loadType(java.io.File file, java.lang.Class<T> clazz)
static <T> T	loadType(java.io.InputStream in, java.lang.Class<T> clazz)
static <T> T	loadType(java.io.Reader reader, java.lang.Class<T> clazz)
static <T> T	loadType(java.lang.String yamlText, java.lang.Class<T> clazz)

Methods inherited from class java.lang.Object

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

Field Detail

config

public static YamlConfig config

Constructor Detail

Yaml

public Yaml()

Method Detail

load

public static java.lang.Object load(java.io.Reader reader)

load

public static java.lang.Object load(java.io.InputStream in)

load

public static java.lang.Object load(java.io.File file)
                             throws java.io.FileNotFoundException

Throws:

java.io.FileNotFoundException

load

public static java.lang.Object load(java.lang.String yamlText)

loadType

public static <T> T loadType(java.io.Reader reader,
                             java.lang.Class<T> clazz)

loadType

public static <T> T loadType(java.io.InputStream in,
                             java.lang.Class<T> clazz)
                  throws java.io.FileNotFoundException

Throws:

java.io.FileNotFoundException

loadType

public static <T> T loadType(java.io.File file,
                             java.lang.Class<T> clazz)
                  throws java.io.FileNotFoundException

Throws:

java.io.FileNotFoundException

loadType

public static <T> T loadType(java.lang.String yamlText,
                             java.lang.Class<T> clazz)

loadStream

public static YamlStream loadStream(java.io.Reader reader)

loadStream

public static YamlStream loadStream(java.io.InputStream in)

loadStream

public static YamlStream loadStream(java.io.File file)
                             throws java.io.FileNotFoundException

Throws:

java.io.FileNotFoundException

loadStream

public static YamlStream loadStream(java.lang.String yamlText)

loadStreamOfType

public static <T> YamlStream<T> loadStreamOfType(java.io.Reader reader,
                                                 java.lang.Class<T> clazz)

loadStreamOfType

public static <T> YamlStream<T> loadStreamOfType(java.io.InputStream in,
                                                 java.lang.Class<T> clazz)

loadStreamOfType

public static <T> YamlStream<T> loadStreamOfType(java.io.File file,
                                                 java.lang.Class<T> clazz)
                                      throws java.io.FileNotFoundException

Throws:

java.io.FileNotFoundException

loadStreamOfType

public static <T> YamlStream<T> loadStreamOfType(java.lang.String yamlText,
                                                 java.lang.Class<T> clazz)
                                      throws java.io.FileNotFoundException

Throws:

java.io.FileNotFoundException

dump

public static void dump(java.lang.Object obj,
                        java.io.File file)
                 throws java.io.FileNotFoundException

Throws:

java.io.FileNotFoundException

dump

public static void dump(java.lang.Object obj,
                        java.io.File file,
                        boolean minimalOutput)
                 throws java.io.FileNotFoundException

Throws:

java.io.FileNotFoundException

dumpStream

public static void dumpStream(java.util.Iterator iterator,
                              java.io.File file,
                              boolean minimalOutput)
                       throws java.io.FileNotFoundException

Throws:

java.io.FileNotFoundException

dumpStream

public static void dumpStream(java.util.Iterator iterator,
                              java.io.File file)
                       throws java.io.FileNotFoundException

Throws:

java.io.FileNotFoundException

dump

public static java.lang.String dump(java.lang.Object obj)

dump

public static java.lang.String dump(java.lang.Object obj,
                                    boolean minimalOutput)

dumpStream

public static java.lang.String dumpStream(java.util.Iterator iterator)

dumpStream

public static java.lang.String dumpStream(java.util.Iterator iterator,
                                          boolean minimalOutput)