com.atlassian.bamboo.configuration.external.yaml

Interface BambooYamlParser

All Known Implementing Classes:

BambooYamlParserImpl

public interface BambooYamlParser

Parser for simplified Bamboo YAML documents.

See Also:

BambooYamlDefinition

Method Summary

Modifier and Type	Method and Description
BambooYamlDefinition	parse(String yamlString) Constructs an instance of BambooYamlDefinition based on the given YAML string.

Method Detail

parse

@NotNull
BambooYamlDefinition parse(@NotNull
                                    String yamlString)
                             throws YamlSpecsValidationException

Constructs an instance of BambooYamlDefinition based on the given YAML string. This method will run basic validation, e.g. that types in the YAML document match.

Parameters:

yamlString - a YAML document as a string

Returns:

parsed YAML document

Throws:

YamlSpecsValidationException - if the passed YAML document is invalid in any way