io.toro.martini

Class YamlMethods

java.lang.Object

io.toro.martini.YamlMethods

public class YamlMethods
extends Object

Constructor Summary

Constructors

Constructor and Description
YamlMethods()

Method Summary

Modifier and Type	Method and Description
static String	asYaml(io.toro.gloop.object.property.GloopObject gloopObject, boolean includeRoot, boolean includeNulls)
static io.toro.gloop.object.cursor.GloopCursor	getInputCursorFromFile(String filename, List<String> yamlNodeNames, io.toro.gloop.engine.GloopExecutionContext context)
static io.toro.gloop.object.cursor.GloopCursor	getInputCursorFromInputStream(InputStream inputStream, List<String> yamlNodeNames, io.toro.gloop.engine.GloopExecutionContext context)
static String	gloopModelToYamlString(io.toro.gloop.object.property.GloopObject gloopObject)
static io.toro.gloop.object.property.GloopObject	inputStreamToGloopObject(InputStream yamlStream)
static io.toro.gloop.object.property.GloopModel	openYamlOutputCursor(boolean printStartDocument, String name, String indent, boolean closeDestination, Object destination, io.toro.gloop.engine.GloopExecutionContext context)
static void	printYaml(IndentPrinter printer, io.toro.gloop.object.property.GloopObject gloopObject, boolean includeNulls)
static io.toro.gloop.object.property.GloopObject	readerToGloopObject(Reader yamlString)
static void	writeYaml(Writer writer, io.toro.gloop.object.property.GloopObject gloopObject, boolean includeNulls)
static io.toro.gloop.object.property.GloopObject	yamlStringToGloopObject(String yamlString)

Methods inherited from class java.lang.Object

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

Constructor Detail

YamlMethods

public YamlMethods()

Method Detail

gloopModelToYamlString

@GloopComment(value="Convert a gloop object to YAML")
 @GloopParameter(value="Yaml string",
                name="gloopYaml")
public static String gloopModelToYamlString(io.toro.gloop.object.property.GloopObject gloopObject)

yamlStringToGloopObject

public static io.toro.gloop.object.property.GloopObject yamlStringToGloopObject(String yamlString)

inputStreamToGloopObject

public static io.toro.gloop.object.property.GloopObject inputStreamToGloopObject(InputStream yamlStream)

readerToGloopObject

public static io.toro.gloop.object.property.GloopObject readerToGloopObject(Reader yamlString)

asYaml

@GloopComment(value="Marshalls the given gloop object as a yaml string")
public static String asYaml(@GloopParameter(allowNull=false)
                                                                                                     io.toro.gloop.object.property.GloopObject gloopObject,
                                                                                                     @GloopParameter(defaultValue="false")
                                                                                                     boolean includeRoot,
                                                                                                     @GloopParameter(defaultValue="false")
                                                                                                     boolean includeNulls)

writeYaml

@GloopComment(value="Marshalls the given gloop object to a writer")
public static void writeYaml(@GloopParameter(allowNull=false)
                                                                                                 Writer writer,
                                                                                                 @GloopParameter(allowNull=false)
                                                                                                 io.toro.gloop.object.property.GloopObject gloopObject,
                                                                                                 @GloopParameter(defaultValue="false")
                                                                                                 boolean includeNulls)

printYaml

@GloopComment(value="Marshalls the given gloop object to an indent printer")
public static void printYaml(@GloopParameter(allowNull=false)
                                                                                                          IndentPrinter printer,
                                                                                                          @GloopParameter(allowNull=false)
                                                                                                          io.toro.gloop.object.property.GloopObject gloopObject,
                                                                                                          @GloopParameter(defaultValue="false")
                                                                                                          boolean includeNulls)

getInputCursorFromFile

@GloopComment(value="Parses a large YAML file. Use the yamlNodeNames property to tell it which nodes you want toextract from the YAML file.Use $yamlRoot for root arrays")
 @GloopObjectParameter(value="gloopYamlCursor{\n  gloopYamlCursor[]{\n    nodeName\n    cursorRecord:object\n  }\n}")
public static io.toro.gloop.object.cursor.GloopCursor getInputCursorFromFile(String filename,
                                                                                                                                                                                                                                                                                                                                                                              List<String> yamlNodeNames,
                                                                                                                                                                                                                                                                                                                                                                              io.toro.gloop.engine.GloopExecutionContext context)
                                                                                                                                                                                                                                                                                                                                                                       throws FileNotFoundException

Throws:

FileNotFoundException

getInputCursorFromInputStream

@GloopComment(value="Parses a large YAML file. Use the yamlNodeNames property to tell it which nodes you want to extract from the YAML file.Use $yamlRoot for root arrays")
 @GloopObjectParameter(value="gloopYamlCursor{\n  gloopYamlCursor[]{\n    nodeName\n    cursorRecord:object\n  }\n}")
public static io.toro.gloop.object.cursor.GloopCursor getInputCursorFromInputStream(InputStream inputStream,
                                                                                                                                                                                                                                                                                                                                                                                      List<String> yamlNodeNames,
                                                                                                                                                                                                                                                                                                                                                                                      io.toro.gloop.engine.GloopExecutionContext context)

openYamlOutputCursor

@GloopObjectParameter(value="output{\nyamlCursorOutput{\nindentPrinter:object:printer used to write the yaml out to::::groovy.util.IndentPrinter\nyamlOutputCursor[]*{\n}\n}\n}")
public static io.toro.gloop.object.property.GloopModel openYamlOutputCursor(@GloopParameter(defaultValue="true",value="True if the cursor will print a `---` at the start of document")
                                                                                                                                                                                                                                                              boolean printStartDocument,
                                                                                                                                                                                                                                                              @GloopParameter(value="The name to print before declaring the array (null if there is no name)")
                                                                                                                                                                                                                                                              String name,
                                                                                                                                                                                                                                                              @GloopParameter(allowNull=false,defaultValue="  ",value="The indent to use for printing. Default is 2 spaces")
                                                                                                                                                                                                                                                              String indent,
                                                                                                                                                                                                                                                              @GloopParameter(defaultValue="true",value="True if the cursor will close ethe underlying destination after printing closing text")
                                                                                                                                                                                                                                                              boolean closeDestination,
                                                                                                                                                                                                                                                              @GloopParameter(value="Must be a StringBuffer, Writer, OutputStream or File")
                                                                                                                                                                                                                                                              Object destination,
                                                                                                                                                                                                                                                              io.toro.gloop.engine.GloopExecutionContext context)
                                                                                                                                                                                                                                                       throws IOException

Throws:

IOException