java.lang.Object
- com.floragunn.codova.documents.DocNode

All Implemented Interfaces:

Document<Object>, Map<String,Object>

Direct Known Subclasses:

JacksonJsonNodeAdapter
```
public abstract class DocNode
extends Object
implements Map<String,Object>, Document<Object>
```

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class DocNode.DocNodeParserBuilder
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K extends Object,V extends Object>

Field Summary

Fields
Modifier and Type Field Description

static DocNode EMPTY

protected String key

static DocNode NULL

Constructor Summary

Constructors
Constructor Description

DocNode()

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`static DocNode`	`array(Object... array)`
`void`	`clear()`
`boolean`	`containsValue(Object value)`
`boolean`	`equals(Object obj)`
`List<?>`	`findByJsonPath(String jsonPath)`
`com.floragunn.fluent.collections.ImmutableList<DocNode>`	`findNodesByJsonPath(String jsonPath)`
`DocNode`	`findSingleNodeByJsonPath(String jsonPath)`
`<T> T`	`findSingleValueByJsonPath(String jsonPath, Class<T> type)`
`DocNode`	`flatten()`
`Object`	`get(Object key)`
`abstract Object`	`get(String attribute)`
`<R> R`	`get(String attribute, ValidatingFunction<String,R> conversionFunction, Object expected)`
`Object`	`get(String attribute, String... attributePath)`
`<R> com.floragunn.fluent.collections.ImmutableList<R>`	`getAsList(String attribute, ValidatingFunction<String,R> conversionFunction, Object expected)`
`<R> com.floragunn.fluent.collections.ImmutableList<R>`	`getAsListFromNodes(String attribute, ValidatingFunction<DocNode,R> conversionFunction)`
`<R> com.floragunn.fluent.collections.ImmutableList<R>`	`getAsListFromNodes(String attribute, ValidatingFunction<DocNode,R> conversionFunction, Object expected)`
`abstract com.floragunn.fluent.collections.ImmutableList<DocNode>`	`getAsListOfNodes(String attribute)`
`com.floragunn.fluent.collections.ImmutableList<String>`	`getAsListOfStrings(String attribute)`
`abstract DocNode`	`getAsNode(String attribute)`
`DocNode`	`getAsNode(String attribute, String... moreAttributes)`
`String`	`getAsString(String attribute)`
`BigDecimal`	`getBigDecimal(String attribute)`
`Boolean`	`getBoolean(String attribute)`
`<R> R`	`getFromNode(String attribute, ValidatingFunction<DocNode,R> conversionFunction, Object expected)`
`String`	`getKey()`
`<R> com.floragunn.fluent.collections.ImmutableList<R>`	`getList(String attribute, ValidatingFunction<String,R> conversionFunction, Object expected)`
`<R> com.floragunn.fluent.collections.ImmutableList<R>`	`getListFromNodes(String attribute, ValidatingFunction<DocNode,R> conversionFunction, Object expected)`
`com.floragunn.fluent.collections.ImmutableList<String>`	`getListOfStrings(String attribute)`
`Number`	`getNumber(String attribute)`
`boolean`	`hasAny(String... keys)`
`boolean`	`hasNonNull(String attribute)`
`boolean`	`isFlat()`
`abstract boolean`	`isList()`
`abstract boolean`	`isList(String attribute)`
`abstract boolean`	`isMap()`
`boolean`	`isNull()`
`boolean`	`isNumber()`
`boolean`	`isScalar()`
`boolean`	`isString()`
`static DocNode`	`of(String key, Object value)`
`static DocNode`	`of(String k1, Object v1, String k2, Object v2)`
`static DocNode`	`of(String k1, Object v1, String k2, Object v2, String k3, Object v3)`
`static DocNode`	`of(String k1, Object v1, String k2, Object v2, String k3, Object v3, String k4, Object v4)`
`static DocNode`	`of(String k1, Object v1, String k2, Object v2, String k3, Object v3, String k4, Object v4, String k5, Object v5, Object... more)`
`static DocNode.DocNodeParserBuilder`	`parse(ContentType contentType)`
`static DocNode.DocNodeParserBuilder`	`parse(Format format)`
`static DocNode`	`parse(UnparsedDocument<?> unparsedDoc)`
`Object`	`put(String key, Object value)`
`void`	`putAll(Map<? extends String,? extends Object> m)`
`Object`	`remove(Object key)`
`abstract DocNode`	`splitDottedAttributeNamesToTree()`
`Object`	`toBasicObject()`
`String`	`toJsonString()`
`abstract com.floragunn.fluent.collections.ImmutableList<Object>`	`toList()`
`com.floragunn.fluent.collections.ImmutableList<DocNode>`	`toListOfNodes()`
`com.floragunn.fluent.collections.ImmutableList<String>`	`toListOfStrings()`
`abstract com.floragunn.fluent.collections.ImmutableMap<String,Object>`	`toMap()`
`Map<String,DocNode>`	`toMapOfNodes()`
`Map<String,Object>`	`toNormalizedMap()`
`Number`	`toNumber()`
`String`	`toString()`
`protected String`	`toString(int maxChars)`
`String`	`toString(Format format)`
`String`	`toYamlString()`
`DocNode`	`with(Document<?> other)`
`DocNode`	`with(String key, Object value)`
`DocNode`	`without(String... attrs)`
`static DocNode`	`wrap(Object object)`

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

Methods inherited from interface com.floragunn.codova.documents.Document
meta, toBytes, toDeepBasicObject, toDocNode, toPrettyJsonString, toSmile

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, containsKey, entrySet, forEach, getOrDefault, hashCode, isEmpty, keySet, merge, putIfAbsent, remove, replace, replace, replaceAll, size, values

Field Detail

EMPTY
```
public static final DocNode EMPTY
```

NULL
```
public static final DocNode NULL
```

key
```
protected String key
```

Constructor Detail
- DocNode
```
public DocNode()
```

Method Detail

parse

public static DocNode.DocNodeParserBuilder parse(Format format)

parse

public static DocNode.DocNodeParserBuilder parse(ContentType contentType)

parse

public static DocNode parse(UnparsedDocument<?> unparsedDoc)
                     throws DocumentParseException

Throws:: DocumentParseException

of

public static DocNode of(String key,
                         Object value)

of

public static DocNode of(String k1,
                         Object v1,
                         String k2,
                         Object v2)

of

public static DocNode of(String k1,
                         Object v1,
                         String k2,
                         Object v2,
                         String k3,
                         Object v3)

of

public static DocNode of(String k1,
                         Object v1,
                         String k2,
                         Object v2,
                         String k3,
                         Object v3,
                         String k4,
                         Object v4)

of

public static DocNode of(String k1,
                         Object v1,
                         String k2,
                         Object v2,
                         String k3,
                         Object v3,
                         String k4,
                         Object v4,
                         String k5,
                         Object v5,
                         Object... more)

wrap

public static DocNode wrap(Object object)

array

public static DocNode array(Object... array)

get

public abstract Object get(String attribute)

getAsListOfNodes

public abstract com.floragunn.fluent.collections.ImmutableList<DocNode> getAsListOfNodes(String attribute)

getAsNode

public abstract DocNode getAsNode(String attribute)

toMap

public abstract com.floragunn.fluent.collections.ImmutableMap<String,Object> toMap()

isMap
```
public abstract boolean isMap()
```

isList
```
public abstract boolean isList()
```

isList

public abstract boolean isList(String attribute)

isScalar
```
public boolean isScalar()
```

toList

public abstract com.floragunn.fluent.collections.ImmutableList<Object> toList()

splitDottedAttributeNamesToTree

public abstract DocNode splitDottedAttributeNamesToTree()
                                                 throws UnexpectedDocumentStructureException

Throws:: UnexpectedDocumentStructureException

toBasicObject
```
public Object toBasicObject()
```
Specified by:

toBasicObject in interface Document<Object>

toMapOfNodes

public Map<String,DocNode> toMapOfNodes()

toListOfNodes

public com.floragunn.fluent.collections.ImmutableList<DocNode> toListOfNodes()

isNull
```
public boolean isNull()
```

isString
```
public boolean isString()
```

isNumber
```
public boolean isNumber()
```

hasAny

public boolean hasAny(String... keys)

with

public DocNode with(Document<?> other)

with

public DocNode with(String key,
                    Object value)

without

public DocNode without(String... attrs)

get

public Object get(String attribute,
                  String... attributePath)

getAsNode

public DocNode getAsNode(String attribute,
                         String... moreAttributes)

toListOfStrings

public com.floragunn.fluent.collections.ImmutableList<String> toListOfStrings()

getAsString

public String getAsString(String attribute)

getNumber

public Number getNumber(String attribute)
                 throws ConfigValidationException

Throws:: ConfigValidationException

getBigDecimal

public BigDecimal getBigDecimal(String attribute)
                         throws ConfigValidationException

Throws:: ConfigValidationException

getBoolean

public Boolean getBoolean(String attribute)
                   throws ConfigValidationException

Throws:: ConfigValidationException

get

public <R> R get(String attribute,
                 ValidatingFunction<String,R> conversionFunction,
                 Object expected)
          throws ConfigValidationException

Throws:: ConfigValidationException

getFromNode

public <R> R getFromNode(String attribute,
                         ValidatingFunction<DocNode,R> conversionFunction,
                         Object expected)
                  throws ConfigValidationException

Throws:: ConfigValidationException

getList

public <R> com.floragunn.fluent.collections.ImmutableList<R> getList(String attribute,
                                                                     ValidatingFunction<String,R> conversionFunction,
                                                                     Object expected)
                                                              throws ConfigValidationException

Throws:: ConfigValidationException

getListFromNodes

public <R> com.floragunn.fluent.collections.ImmutableList<R> getListFromNodes(String attribute,
                                                                              ValidatingFunction<DocNode,R> conversionFunction,
                                                                              Object expected)
                                                                       throws ConfigValidationException

Throws:: ConfigValidationException

getAsList

public <R> com.floragunn.fluent.collections.ImmutableList<R> getAsList(String attribute,
                                                                       ValidatingFunction<String,R> conversionFunction,
                                                                       Object expected)
                                                                throws ConfigValidationException

Throws:: ConfigValidationException

getAsListFromNodes

public <R> com.floragunn.fluent.collections.ImmutableList<R> getAsListFromNodes(String attribute,
                                                                                ValidatingFunction<DocNode,R> conversionFunction)
                                                                         throws ConfigValidationException

Throws:: ConfigValidationException

getAsListFromNodes

public <R> com.floragunn.fluent.collections.ImmutableList<R> getAsListFromNodes(String attribute,
                                                                                ValidatingFunction<DocNode,R> conversionFunction,
                                                                                Object expected)
                                                                         throws ConfigValidationException

Throws:: ConfigValidationException

getListOfStrings

public com.floragunn.fluent.collections.ImmutableList<String> getListOfStrings(String attribute)
                                                                        throws ConfigValidationException

Throws:: ConfigValidationException

getAsListOfStrings

public com.floragunn.fluent.collections.ImmutableList<String> getAsListOfStrings(String attribute)

hasNonNull

public boolean hasNonNull(String attribute)

containsValue
```
public boolean containsValue(Object value)
```
Specified by:

containsValue in interface Map<String,Object>

get
```
public Object get(Object key)
```
Specified by:

get in interface Map<String,Object>

getKey
```
public String getKey()
```

findByJsonPath

public List<?> findByJsonPath(String jsonPath)

findNodesByJsonPath

public com.floragunn.fluent.collections.ImmutableList<DocNode> findNodesByJsonPath(String jsonPath)

findSingleValueByJsonPath

public <T> T findSingleValueByJsonPath(String jsonPath,
                                       Class<T> type)

findSingleNodeByJsonPath

public DocNode findSingleNodeByJsonPath(String jsonPath)

put

public Object put(String key,
                  Object value)

Specified by:: put in interface Map<String,Object>

remove
```
public Object remove(Object key)
```
Specified by:

remove in interface Map<String,Object>

putAll

public void putAll(Map<? extends String,? extends Object> m)

Specified by:: putAll in interface Map<String,Object>

clear
```
public void clear()
```
Specified by:

clear in interface Map<String,Object>

toNormalizedMap

public Map<String,Object> toNormalizedMap()

toNumber

public Number toNumber()
                throws ConfigValidationException

Throws:: ConfigValidationException

toString
```
public String toString(Format format)
```
Specified by:

toString in interface Document<Object>

toJsonString
```
public String toJsonString()
```
Specified by:

toJsonString in interface Document<Object>

toYamlString
```
public String toYamlString()
```
Specified by:

toYamlString in interface Document<Object>

toString
```
public String toString()
```
Overrides:

toString in class Object

toString

protected String toString(int maxChars)

equals
```
public boolean equals(Object obj)
```
Specified by:

equals in interface Map<String,Object>

Overrides:

equals in class Object

flatten
```
public DocNode flatten()
```

isFlat
```
public boolean isFlat()
```

Modifier and Type	Field	Description
`static DocNode`	`EMPTY`
`protected String`	`key`
`static DocNode`	`NULL`

Class DocNode

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.floragunn.codova.documents.Document

Methods inherited from interface java.util.Map

Field Detail

EMPTY

NULL

key

Constructor Detail

DocNode

Method Detail

parse

parse

parse

of

of

of

of

of

wrap

array

get

getAsListOfNodes

getAsNode

toMap

isMap

isList

isList

isScalar

toList

splitDottedAttributeNamesToTree

toBasicObject

toMapOfNodes

toListOfNodes

isNull

isString

isNumber

hasAny

with

with

without

get

getAsNode

toListOfStrings

getAsString

getNumber

getBigDecimal

getBoolean

get

getFromNode

getList

getListFromNodes

getAsList

getAsListFromNodes

getAsListFromNodes

getListOfStrings

getAsListOfStrings

hasNonNull

containsValue

get

getKey

findByJsonPath

findNodesByJsonPath

findSingleValueByJsonPath

findSingleNodeByJsonPath

put

remove

putAll

clear

toNormalizedMap

toNumber

toString

toJsonString

toYamlString

toString