YamlMapping (eo-yaml 3.1.4 API)

All Superinterfaces:

Comparable<YamlNode>, YamlNode

All Known Implementing Classes:

StrictYamlMapping
```
public interface YamlMapping
extends YamlNode
```
A Yaml mapping.

Since:

1.0.0

Version:

$Id: e54299ece2dfa8894f7b5823ddd90b05a2471798 $

Author:

Mihai Andronache ([email protected])

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default LocalDate`	`date(String key)` Convenience method to directly read a LocalDate value from this map.
`default LocalDate`	`date(YamlNode key)` Convenience method to directly read a LocalDate value from this map.
`default LocalDateTime`	`dateTime(String key)` Convenience method to directly read a LocalDateTime value from this map.
`default LocalDateTime`	`dateTime(YamlNode key)` Convenience method to directly read a LocalDateTime value from this map.
`default double`	`doubleNumber(String key)` Convenience method to directly read a double value from this map.
`default double`	`doubleNumber(YamlNode key)` Convenience method to directly read a double value from this map.
`default float`	`floatNumber(String key)` Convenience method to directly read a float value from this map.
`default float`	`floatNumber(YamlNode key)` Convenience method to directly read a float value from this map.
`default String`	`indent(int indentation)` Indent this YamlMapping.
`default int`	`integer(String key)` Convenience method to directly read an integer value from this map.
`default int`	`integer(YamlNode key)` Convenience method to directly read an integer value from this map.
`Set<YamlNode>`	`keys()` Return the keys' set of this mapping. Pay attention: the keys are ordered.
`default long`	`longNumber(String key)` Convenience method to directly read a long value from this map.
`default long`	`longNumber(YamlNode key)` Convenience method to directly read a long value from this map.
`String`	`string(String key)` Get the String associated with the given key.
`String`	`string(YamlNode key)` Get the String associated with the given key.
`YamlNode`	`value(YamlNode key)` Get the YamlNode mapped to the specified key.
`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 interface com.amihaiemil.eoyaml.YamlNode
children, values

Methods inherited from interface java.lang.Comparable
compareTo

- Method Detail
  - yamlMapping
```
YamlMapping yamlMapping(String key)
```
    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
```
YamlMapping yamlMapping(YamlNode key)
```
    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
```
YamlSequence yamlSequence(String key)
```
    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
```
YamlSequence yamlSequence(YamlNode key)
```
    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
```
String string(String key)
```
    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
```
String string(YamlNode key)
```
    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.
  - value
```
YamlNode value(YamlNode key)
```
    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.
  - keys
```
Set<YamlNode> keys()
```
    Return the keys' set of this mapping.
    
    Pay attention: the keys are ordered.
    
    Returns:
    
    Set of YamlNode keys.
  - indent
```
default String indent(int indentation)
```
    Indent this YamlMapping. This is a default method since indentation logic should be identical for any kind of YamlMapping, regardless of its implementation.
    
    Specified by:
    
    indent in interface YamlNode
    
    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.
  - integer
```
default int integer(String key)
```
    Convenience method to directly read an integer value from this map. It is equivalent to:
```
     YamlMapping map = ...;
     int value = Integer.parseInt(map.string(...));
 
```
    Parameters:
    
    key - The key of the value.
    
    Returns:
    
    Found integer or -1 if there is no value for the key, or the value is not a Scalar.
    
    Throws:
    
    NumberFormatException - - if the Scalar value is not a parsable integer.
  - integer
```
default int integer(YamlNode key)
```
    Convenience method to directly read an integer value from this map. It is equivalent to:
```
     YamlMapping map = ...;
     int value = Integer.parseInt(map.string(...));
 
```
    Parameters:
    
    key - The key of the value.
    
    Returns:
    
    Found integer or -1 if there is no value for the key, or the value is not a Scalar.
    
    Throws:
    
    NumberFormatException - - if the Scalar value is not a parsable integer.
  - floatNumber
```
default float floatNumber(String key)
```
    Convenience method to directly read a float value from this map. It is equivalent to:
```
     YamlMapping map = ...;
     float value = Float.parseFloat(map.string(...));
 
```
    Parameters:
    
    key - The key of the value.
    
    Returns:
    
    Found float or -1 if there is no value for the key, or the value is not a Scalar.
    
    Throws:
    
    NumberFormatException - - if the Scalar value is not a parsable float.
  - floatNumber
```
default float floatNumber(YamlNode key)
```
    Convenience method to directly read a float value from this map. It is equivalent to:
```
     YamlMapping map = ...;
     float value = Float.parseFloat(map.string(...));
 
```
    Parameters:
    
    key - The key of the value.
    
    Returns:
    
    Found float or -1 if there is no value for the key, or the value is not a Scalar.
    
    Throws:
    
    NumberFormatException - - if the Scalar value is not a parsable float.
  - doubleNumber
```
default double doubleNumber(String key)
```
    Convenience method to directly read a double value from this map. It is equivalent to:
```
     YamlMapping map = ...;
     double value = Double.parseDouble(map.string(...));
 
```
    Parameters:
    
    key - The key of the value.
    
    Returns:
    
    Found double or -1.0 if there is no value for the key, or the value is not a Scalar.
    
    Throws:
    
    NumberFormatException - - if the Scalar value is not a parsable double.
  - doubleNumber
```
default double doubleNumber(YamlNode key)
```
    Convenience method to directly read a double value from this map. It is equivalent to:
```
     YamlMapping map = ...;
     double value = Double.parseDouble(map.string(...));
 
```
    Parameters:
    
    key - The key of the value.
    
    Returns:
    
    Found double or -1.0 if there is no value for the key, or the value is not a Scalar.
    
    Throws:
    
    NumberFormatException - - if the Scalar value is not a parsable double.
  - longNumber
```
default long longNumber(String key)
```
    Convenience method to directly read a long value from this map. It is equivalent to:
```
     YamlMapping map = ...;
     long value = Long.parseLong(map.string(...));
 
```
    Parameters:
    
    key - The key of the value.
    
    Returns:
    
    Found long or -1L if there is no value for the key, or the value is not a Scalar.
    
    Throws:
    
    NumberFormatException - - if the Scalar value is not a parsable long.
  - longNumber
```
default long longNumber(YamlNode key)
```
    Convenience method to directly read a long value from this map. It is equivalent to:
```
     YamlMapping map = ...;
     long value = Long.parseLong(map.string(...));
 
```
    Parameters:
    
    key - The key of the value.
    
    Returns:
    
    Found long or -1L if there is no value for the key, or the value is not a Scalar.
    
    Throws:
    
    NumberFormatException - - if the Scalar value is not a parsable long.
  - date
```
default LocalDate date(String key)
```
    Convenience method to directly read a LocalDate value from this map. It is equivalent to:
```
     YamlMapping map = ...;
     LocalDate date = LocalDate.parse(map.string(...));
 
```
    Parameters:
    
    key - The key of the value.
    
    Returns:
    
    Found LocalDate or null if there is no value for the key, or the value is not a Scalar.
    
    Throws:
    
    DateTimeParseException - - if the Scalar value cannot be parsed.
  - date
```
default LocalDate date(YamlNode key)
```
    Convenience method to directly read a LocalDate value from this map. It is equivalent to:
```
     YamlMapping map = ...;
     LocalDate date = LocalDate.parse(map.string(...));
 
```
    Parameters:
    
    key - The key of the value.
    
    Returns:
    
    Found LocalDate or null if there is no value for the key, or the value is not a Scalar.
    
    Throws:
    
    DateTimeParseException - - if the Scalar value cannot be parsed.
  - dateTime
```
default LocalDateTime dateTime(String key)
```
    Convenience method to directly read a LocalDateTime value from this map. It is equivalent to:
```
     YamlMapping map = ...;
     LocalDateTime dateTime = LocalDateTime.parse(map.string(...));
 
```
    Parameters:
    
    key - The key of the value.
    
    Returns:
    
    Found LocalDateTime or null if there is no value for the key, or the value is not a Scalar.
    
    Throws:
    
    DateTimeParseException - - if the Scalar value cannot be parsed.
  - dateTime
```
default LocalDateTime dateTime(YamlNode key)
```
    Convenience method to directly read a LocalDateTime value from this map. It is equivalent to:
```
     YamlMapping map = ...;
     LocalDateTime dateTime = LocalDateTime.parse(map.string(...));
 
```
    Parameters:
    
    key - The key of the value.
    
    Returns:
    
    Found LocalDateTime or null if there is no value for the key, or the value is not a Scalar.
    
    Throws:
    
    DateTimeParseException - - if the Scalar value cannot be parsed.

Interface YamlMapping

Method Summary

Methods inherited from interface com.amihaiemil.eoyaml.YamlNode

Methods inherited from interface java.lang.Comparable

Method Detail

yamlMapping

yamlMapping

yamlSequence

yamlSequence

string

string

value

keys

indent

integer

integer

floatNumber

floatNumber

doubleNumber

doubleNumber

longNumber

longNumber

date

date

dateTime

dateTime