YamlMap (Geotools modules 21.0 API)

Object
- YamlObject<Map<String,Object>>
- - YamlMap

All Implemented Interfaces:: Iterable<String>

public class YamlMap
extends YamlObject<Map<String,Object>>
implements Iterable<String>

Wrapper around a parsed Yaml mapping.

Field Summary
- Fields inherited from class YamlObject
  raw

Constructor Summary

Constructors
Constructor and Description

YamlMap(Object obj)
Yaml mapping.

Constructors
Constructor and Description
`YamlMap(Object obj)` Yaml mapping.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Boolean`	`bool(String key)` Boolean access.
`Boolean`	`boolOr(String key, Boolean def)` Boolean access.
`Double`	`doub(String key)` Double access.
`Double`	`doubOr(String key, Double def)` Double access.
`static YamlMap`	`from(Object... pairs)` Quick inline map creation.
`Object`	`get(String key)` Value access
`boolean`	`has(String key)` Check if mapping available for key
`Integer`	`integer(String key)` Integer access.
`Integer`	`intOr(String key, Integer def)` Integer access.
`Iterator<String>`	`iterator()` Iterate over keys.
`String`	`key(int i)` Access key by index, order provided by `iterator()`.
`YamlMap`	`map(String key)` Access value as a YamlMap
`YamlObject<?>`	`obj(String key)` Access value as a Yaml wrapper.
`YamlSeq`	`seq(String key)` Access value as a YamlSeq
`String`	`str(String key)` String access.
`String`	`strOr(String key, String def)` String access.

Methods inherited from class YamlObject
convert, create, lookup, lookupY, map, raw, seq, toString

Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface Iterable
forEach, spliterator

- Constructor Detail
  - YamlMap
```
public YamlMap(Object obj)
```
    Yaml mapping.
    
    Parameters:
    
    obj - Wrapped Map
    
    Throws:
    
    IllegalArgumentException - Map is required
- Method Detail
  - from
```
public static YamlMap from(Object... pairs)
```
    Quick inline map creation.
    
    Parameters:
    
    pairs - Key value pairs
    
    Returns:
    
    Map of provided key value pairs.
  - str
```
public String str(String key)
```
    String access.
    
    Parameters:
    
    key -
    
    Returns:
    
    String access, converting if necessary.
  - strOr
```
public String strOr(String key,
                    String def)
```
    String access.
    
    Parameters:
    
    key -
    
    def - default if value not provided
    
    Returns:
    
    String access, converting if necessary.
  - integer
```
public Integer integer(String key)
```
    Integer access.
    
    Parameters:
    
    key -
    
    Returns:
    
    Integer access, converting if necessary.
  - intOr
```
public Integer intOr(String key,
                     Integer def)
```
    Integer access.
    
    Parameters:
    
    key -
    
    def - default if value not provided
    
    Returns:
    
    Integer access, converting if necessary.
  - doub
```
public Double doub(String key)
```
    Double access.
    
    Parameters:
    
    key -
    
    Returns:
    
    Integer access, converting if necessary.
  - doubOr
```
public Double doubOr(String key,
                     Double def)
```
    Double access.
    
    Parameters:
    
    key -
    
    def - default if value not provided
    
    Returns:
    
    Integer access, converting if necessary.
  - bool
```
public Boolean bool(String key)
```
    Boolean access.
    
    Parameters:
    
    key -
    
    Returns:
    
    Boolean access, converting if necessary.
  - boolOr
```
public Boolean boolOr(String key,
                      Boolean def)
```
    Boolean access.
    
    Parameters:
    
    key -
    
    def - default if value not provided
    
    Returns:
    
    Boolean access, converting if necessary.
  - has
```
public boolean has(String key)
```
    Check if mapping available for key
    
    Parameters:
    
    key -
    
    Returns:
    
    true if mapping available for key
  - get
```
public Object get(String key)
```
    Value access
    
    Parameters:
    
    key -
    
    Returns:
    
    Value access
  - obj
```
public YamlObject<?> obj(String key)
```
    Access value as a Yaml wrapper.
    Wrappers are provided for Map and List
    
    Parameters:
    
    key -
    
    Returns:
    
    Access as Yaml wrapper
  - map
```
public YamlMap map(String key)
```
    Access value as a YamlMap
    
    Parameters:
    
    key -
    
    Returns:
    
    Access as YamlMap
  - seq
```
public YamlSeq seq(String key)
```
    Access value as a YamlSeq
    
    Parameters:
    
    key -
    
    Returns:
    
    Access as YamlSeq
  - key
```
public String key(int i)
```
    Access key by index, order provided by iterator().
    
    Parameters:
    
    i - index
    
    Returns:
    
    key access by index
  - iterator
```
public Iterator<String> iterator()
```
    Iterate over keys.
    
    Specified by:
    
    iterator in interface Iterable<String>

Class YamlMap

Field Summary

Fields inherited from class YamlObject

Constructor Summary

Method Summary

Methods inherited from class YamlObject

Methods inherited from class Object

Methods inherited from interface Iterable

Constructor Detail

YamlMap

Method Detail

from

str

strOr

integer

intOr

doub

doubOr

bool

boolOr

has

get

obj

map

seq

key

iterator