Class Compose

java.lang.Object
org.snakeyaml.engine.v2.api.lowlevel.Compose

public class Compose extends Object
Helper to compose input stream to Node
  • Field Details

  • Constructor Details

    • Compose

      public Compose(LoadSettings settings)
      Create instance with provided LoadSettings
      Parameters:
      settings - - configuration
  • Method Details

    • composeReader

      public Optional<Node> composeReader(Reader yaml)
      Parse a YAML stream and produce Node
      Parameters:
      yaml - - YAML document(s). Since the encoding is already known the BOM must not be present (it will be parsed as content)
      Returns:
      parsed Node if available
      See Also:
    • composeInputStream

      public Optional<Node> composeInputStream(InputStream yaml)
      Parse a YAML stream and produce Node
      Parameters:
      yaml - - YAML document(s). Default encoding is UTF-8. The BOM must be present if the encoding is UTF-16 or UTF-32
      Returns:
      parsed Node if available
      See Also:
    • composeString

      public Optional<Node> composeString(String yaml)
      Parse a YAML stream and produce Node
      Parameters:
      yaml - - YAML document(s).
      Returns:
      parsed Node if available
      See Also:
    • composeAllFromReader

      public Iterable<Node> composeAllFromReader(Reader yaml)
      Parse all YAML documents in a stream and produce corresponding representation trees.
      Parameters:
      yaml - stream of YAML documents
      Returns:
      parsed root Nodes for all the specified YAML documents
      See Also:
    • composeAllFromInputStream

      public Iterable<Node> composeAllFromInputStream(InputStream yaml)
      Parse all YAML documents in a stream and produce corresponding representation trees.
      Parameters:
      yaml - - YAML document(s). Default encoding is UTF-8. The BOM must be present if the encoding is UTF-16 or UTF-32
      Returns:
      parsed root Nodes for all the specified YAML documents
      See Also:
    • composeAllFromString

      public Iterable<Node> composeAllFromString(String yaml)
      Parse all YAML documents in a stream and produce corresponding representation trees.
      Parameters:
      yaml - - YAML document(s).
      Returns:
      parsed root Nodes for all the specified YAML documents
      See Also: