com.atlassian.bamboo.specs.yaml

Class MapNode

java.lang.Object

com.atlassian.bamboo.specs.yaml.BaseNode

com.atlassian.bamboo.specs.yaml.MapNode

All Implemented Interfaces:

Node

public class MapNode
extends BaseNode

Node representing a dictionary-like YAML structure.

Constructor Summary

Constructors

Constructor and Description
MapNode(Map<String,Object> structure, com.atlassian.bamboo.specs.api.validators.common.ValidationContext validationContext)

Method Summary

Modifier and Type	Method and Description
<T extends Node> ListNode<T>	getList(String property, Class<T> expectedType) Get a property from a parsed YAML as a List of a particular type.
MapNode	getMap(String property) Get a property from a parsed YAML as a Map.
Node	getNode(String property) Get a property from a parsed YAML as a generic Node.
<T extends Node> Optional<ListNode<T>>	getOptionalList(String property, Class<T> expectedType) Get a property from a parsed YAML as a List of a particular type, if the property is present.
Optional<MapNode>	getOptionalMap(String property) Get a property from a parsed YAML as a Map if it's present.
Optional<Node>	getOptionalNode(String property) Get a property from a parsed YAML as a generic Node if it's present.
Optional<StringNode>	getOptionalString(String property) Get a property from a parsed YAML as a String, if the property is present.
Collection<String>	getProperties()
StringNode	getString(String property) Get a property from a parsed YAML as a String.
List<String>	getUnusedProperties() Visits recursively the whole structure and returns list of unused properties.

Methods inherited from class com.atlassian.bamboo.specs.yaml.BaseNode

getValidationContext, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

MapNode

public MapNode(@NotNull
               Map<String,Object> structure,
               @NotNull
               com.atlassian.bamboo.specs.api.validators.common.ValidationContext validationContext)

Method Detail

getString

@NotNull
public StringNode getString(@NotNull
                                     String property)

Get a property from a parsed YAML as a String. Throws if the property is not defined or if it's of wrong type. This method will cast the property to a string if it's a scalar (non-collection), e.g. Integer or Boolean.

Note: blank strings are not accepted. This method will throw if the property is defined but is blank.

getOptionalString

@NotNull
public Optional<StringNode> getOptionalString(@NotNull
                                                       String property)

Get a property from a parsed YAML as a String, if the property is present. Throws if the property is defined but is of wrong type.

Note: blank strings are not accepted. This method will throw if the property is defined but is blank. If a property is optional, it should be skipped instead.

getList

@NotNull
public <T extends Node> ListNode<T> getList(@NotNull
                                                     String property,
                                                     @NotNull
                                                     Class<T> expectedType)

Get a property from a parsed YAML as a List of a particular type. Throws if the property is not defined, is of wrong type, or if any element from the list is of wrong type.

Note: this method will throw if the list is empty! The intention is to use this method for lists which are required, and need to contain at least one element.

getOptionalList

@NotNull
public <T extends Node> Optional<ListNode<T>> getOptionalList(@NotNull
                                                                       String property,
                                                                       @NotNull
                                                                       Class<T> expectedType)

Get a property from a parsed YAML as a List of a particular type, if the property is present. Throws if the property is defined but is of wrong type, or if any element from the list is of wrong type.

Note: this method will not throw if the list is empty. The intention is to use this method for lists which are optional. Skipped properties and properties defining empty lists should be treated as equal.

getMap

@NotNull
public MapNode getMap(@NotNull
                               String property)

Get a property from a parsed YAML as a Map. Throws if the property is not defined, is of wrong type, or if any key or value is of wrong type.

Note: this method will not throw if the map is empty. It's not possible to tell which keys are meaningful and which are ignorable. Additional validation is necessary for the produced map.

getOptionalMap

@NotNull
public Optional<MapNode> getOptionalMap(@NotNull
                                                 String property)

Get a property from a parsed YAML as a Map if it's present. Throws if the property is defined but is of wrong type, or if any key or value is of wrong type.

Note: this method will not throw if the map is empty.

getNode

@NotNull
public Node getNode(@NotNull
                             String property)

Get a property from a parsed YAML as a generic Node. Throws if property is not defined.

getOptionalNode

@NotNull
public Optional<Node> getOptionalNode(@NotNull
                                               String property)

Get a property from a parsed YAML as a generic Node if it's present. Does not throw if the property is not defined.

getUnusedProperties

@NotNull
public List<String> getUnusedProperties()

Description copied from interface: Node

Visits recursively the whole structure and returns list of unused properties. Children of unused properties are not reported.

getProperties

@NotNull
public Collection<String> getProperties()