Package org.snakeyaml.engine.v2.api.lowlevel

Class Compose

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

    • Constructor Detail

      • Compose

        public Compose​(LoadSettings settings)
        Create instance with provided LoadSettings
        Parameters:
        settings - - configuration

    • Method Detail

      • composeReader

        public Optional<org.snakeyaml.engine.v2.nodes.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:
        Processing Overview

      • composeInputStream

        public Optional<org.snakeyaml.engine.v2.nodes.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:
        Processing Overview

      • composeString

        public Optional<org.snakeyaml.engine.v2.nodes.Node> composeString​(String yaml)
        Parse a YAML stream and produce Node
        Parameters:
        yaml - - YAML document(s).
        Returns:
        parsed Node if available
        See Also:
        Processing Overview

      • composeAllFromReader

        public Iterable<org.snakeyaml.engine.v2.nodes.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:
        Processing Overview

      • composeAllFromInputStream

        public Iterable<org.snakeyaml.engine.v2.nodes.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:
        Processing Overview

      • composeAllFromString

        public Iterable<org.snakeyaml.engine.v2.nodes.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:
        Processing Overview