Package com.amihaiemil.eoyaml

Interface YamlInput

public interface YamlInput

Yaml input.

Since:

1.0.0

Version:

$Id: b2f1463fc24dde66e8e44f98ed2bd40afd37ba56 $

Author:

Mihai Andronache (amihaiemil@gmail.com)

Method Summary

Modifier and Type	Method	Description
Scalar	readFoldedBlockScalar()	Read the given input as a folded block scalar.
Scalar	readLiteralBlockScalar()	Read the given input as a literal block scalar.
Scalar	readPlainScalar()	Read the given input as a plain scalar.
YamlMapping	readYamlMapping()	Read the given input as a Yaml mapping.
YamlSequence	readYamlSequence()	Read the given input as a Yaml sequence.
YamlStream	readYamlStream()	Read the given input as a Yaml stream.

Method Detail

readYamlMapping

YamlMapping readYamlMapping()
                     throws IOException

Read the given input as a Yaml mapping.

Returns:

Read YamlMapping.

Throws:

IOException - if the input cannot be read for some reason

readYamlSequence

YamlSequence readYamlSequence()
                       throws IOException

Read the given input as a Yaml sequence.

Returns:

Read YamlSequence.

Throws:

IOException - if the input cannot be read for some reason

readYamlStream

YamlStream readYamlStream()
                   throws IOException

Read the given input as a Yaml stream.

Returns:

Read YamlStream.

Throws:

IOException - if the input cannot be read for some reason

readPlainScalar

Scalar readPlainScalar()
                throws IOException

Read the given input as a plain scalar. e.g.

 ---
 lonelyScalar
 ...
 

Returns:

Read Scalar.

Throws:

IOException - if the input cannot be read for some reason

readFoldedBlockScalar

Scalar readFoldedBlockScalar()
                      throws IOException

Read the given input as a folded block scalar. e.g.

 ---
 >
   Long scalar which
   has been folded for
   readability
 ...
 

Returns:

Read Scalar.

Throws:

IOException - if the input cannot be read for some reason

readLiteralBlockScalar

Scalar readLiteralBlockScalar()
                       throws IOException

Read the given input as a literal block scalar. e.g.

 ---
 |
   line1
   line2
   line3
 ...
 

Returns:

Read Scalar.

Throws:

IOException - if the input cannot be read for some reason