StrictYamlMapping (eo-yaml 3.1.0 API)

java.lang.Object
- com.amihaiemil.eoyaml.StrictYamlMapping

All Implemented Interfaces:

YamlMapping, YamlNode, Comparable<YamlNode>
```
public final class StrictYamlMapping
extends Object
```
Decorator for a YamlMapping which throws YamlNodenotFoundException, instead of returning null, if a given key doesn't exist in the mapping, or if it points to a different type of node than the demanded one.

It is based on the fail-fast and null-is-bad idea
see here: http://www.yegor256.com/2014/05/13/why-null-is-bad.html

Since:

1.0.0

Version:

$Id: 2d119c9bfff8cd392064636b19323266da858d02 $

Author:

Mihai Andronache (amihaiemil@gmail.com)

Constructor Summary

Constructors
Constructor and Description

StrictYamlMapping(YamlMapping decorated)
Ctor.

Constructors
Constructor and Description
`StrictYamlMapping(YamlMapping decorated)` Ctor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(YamlNode other)` Compare this Mapping to another node. A Mapping is always considered greater than a Scalar or a Sequence. If other is a Mapping, their integer lengths are compared - the one with the greater length is considered greater.
`boolean`	`equals(Object other)` Equals method for YamlMapping.
`int`	`hashCode()`
`String`	`indent(int indentation)` Indent this YamlMapping.
`Set<YamlNode>`	`keys()` Return the keys' set of this mapping. Pay attention: the keys are ordered.
`String`	`string(String key)` Get the String associated with the given key.
`String`	`string(YamlNode key)` Get the String associated with the given key.
`String`	`toString()`
`YamlNode`	`value(YamlNode key)` Get the YamlNode mapped to the specified key.
`Collection<YamlNode>`	`values()` Fetch the values.
`YamlMapping`	`yamlMapping(String key)` Get the Yaml mapping associated with the given key.
`YamlMapping`	`yamlMapping(YamlNode key)` Get the Yaml mapping associated with the given key.
`YamlSequence`	`yamlSequence(String key)` Get the Yaml sequence associated with the given key.
`YamlSequence`	`yamlSequence(YamlNode key)` Get the Yaml sequence associated with the given key.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.amihaiemil.eoyaml.YamlNode
children

- Constructor Detail
  - StrictYamlMapping
```
public StrictYamlMapping(YamlMapping decorated)
```
    Ctor.
    
    Parameters:
    
    decorated - Original YamlMapping
- Method Detail
  - values
```
public Collection<YamlNode> values()
```
    Description copied from interface: YamlNode
    
    Fetch the values.
    
    Returns:
    
    Collection of YamlNode
  - yamlMapping
```
public YamlMapping yamlMapping(String key)
```
    Description copied from interface: YamlMapping
    
    Get the Yaml mapping associated with the given key.
    
    Parameters:
    
    key - String key
    
    Returns:
    
    Yaml mapping or null if the key is missing, or not pointing to a mapping.
  - yamlMapping
```
public YamlMapping yamlMapping(YamlNode key)
```
    Description copied from interface: YamlMapping
    
    Get the Yaml mapping associated with the given key.
    
    Parameters:
    
    key - Yaml node (mapping or sequence) key
    
    Returns:
    
    Yaml mapping or null if the key is missing, or not pointing to a mapping.
  - yamlSequence
```
public YamlSequence yamlSequence(String key)
```
    Description copied from interface: YamlMapping
    
    Get the Yaml sequence associated with the given key.
    
    Parameters:
    
    key - String key
    
    Returns:
    
    Yaml sequence or null if the key is missing, or not pointing to a sequence.
  - yamlSequence
```
public YamlSequence yamlSequence(YamlNode key)
```
    Description copied from interface: YamlMapping
    
    Get the Yaml sequence associated with the given key.
    
    Parameters:
    
    key - Yaml node (mapping or sequence) key
    
    Returns:
    
    Yaml sequence or null if the key is missing, or not pointing to a sequence
  - string
```
public String string(String key)
```
    Description copied from interface: YamlMapping
    
    Get the String associated with the given key.
    
    Parameters:
    
    key - String key
    
    Returns:
    
    String or null if the key is missing, or not pointing to a scalar.
  - string
```
public String string(YamlNode key)
```
    Description copied from interface: YamlMapping
    
    Get the String associated with the given key.
    
    Parameters:
    
    key - Yaml node (mapping or sequence) key
    
    Returns:
    
    String or null if the key is missing, or not pointing to a scalar.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - indent
```
public String indent(int indentation)
```
    Description copied from interface: YamlMapping
    
    Indent this YamlMapping. This is a default method since indentation logic should be identical for any kind of YamlMapping, regardless of its implementation.
    
    Parameters:
    
    indentation - Indentation to start with. Usually, it's 0, since we don't want to have spaces at the beginning. But in the case of nested YamlNodes, this value may be greater than 0.
    
    Returns:
    
    String indented YamlMapping, by the specified indentation.
  - keys
```
public Set<YamlNode> keys()
```
    Description copied from interface: YamlMapping
    
    Return the keys' set of this mapping.
    
    Pay attention: the keys are ordered.
    
    Returns:
    
    Set of YamlNode keys.
  - value
```
public YamlNode value(YamlNode key)
```
    Description copied from interface: YamlMapping
    
    Get the YamlNode mapped to the specified key.
    
    Parameters:
    
    key - YamlNode key. Could be a simple scalar, a YamlMapping or a YamlSequence.
    
    Returns:
    
    The found YamlNode or null if nothing is found.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object other)
```
    Equals method for YamlMapping. It returns true if the compareTo(...) method returns 0.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    other - The YamlMapping to which this is compared.
    
    Returns:
    
    True or false.
  - compareTo
```
public int compareTo(YamlNode other)
```
    Compare this Mapping to another node.
    
    A Mapping is always considered greater than a Scalar or a Sequence.
    If other is a Mapping, their integer lengths are compared - the one with the greater length is considered greater. If the lengths are equal, then the 2 Mappings are equal if all elements are equal (K==K and V==V). If the elements are not identical, the comparison of the first unequal elements is returned.
    
    Specified by:
    
    compareTo in interface Comparable<YamlNode>
    
    Parameters:
    
    other - The other AbstractNode.
    
    Returns:
    
    a value < 0 if this < other
    0 if this == other or
    a value > 0 if this > other

Class StrictYamlMapping

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.amihaiemil.eoyaml.YamlNode

Constructor Detail

StrictYamlMapping

Method Detail

values

yamlMapping

yamlMapping

yamlSequence

yamlSequence

string

string

toString

indent

keys

value

hashCode

equals

compareTo