org.apache.brooklyn.util.collections

Class Jsonya.Navigator<T extends java.util.Map<?,?>>

java.lang.Object

org.apache.brooklyn.util.collections.Jsonya.Navigator<T>

Enclosing class:

Jsonya

public static class Jsonya.Navigator<T extends java.util.Map<?,?>>
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
Navigator(java.lang.Class<? extends java.util.Map> mapType)
Navigator(java.lang.Object backingStore, java.lang.Class<? extends java.util.Map> mapType)

Method Summary

Modifier and Type	Method and Description
Jsonya.Navigator<T>	add(java.lang.Object o1, java.lang.Object... others) adds the given items to the focus, whether a list or a map, creating the focus if it doesn't already exist.
Jsonya.Navigator<T>	addUnflattened(java.lang.Object o1, java.lang.Object... others) adds the given arguments to a list at this point (will not descend into maps, and will not flatten lists)
Jsonya.Navigator<T>	at(java.lang.Object pathSegment, java.lang.Object... furtherPathSegments) returns the navigator moved to focus at the indicated key sequence in the given map, creating the path needed
Jsonya.Navigator<T>	atArray(java.lang.Object[] furtherPathSegments)
Jsonya.Navigator<T>	atExisting(java.lang.Object pathSegment, java.lang.Object... furtherPathSegments) returns the navigator moved to focus at the indicated key sequence in the given map, failing if not available
java.lang.Object	get() returns the object at the focus, or null if none
<V> V	get(java.lang.Class<V> type) returns the object at the focus, casted to the given type, null if none
java.lang.Object	get(java.lang.Object pathSegment, java.lang.Object... furtherPathSegments) gets the object at the indicated path from the current focus (without changing the path to that focus; use at(Object, Object...) to change focus)
T	getFocusMap() returns a Map at the given focus, creating if needed (so never null), throwing if it exists already and is not a map
Maybe<T>	getFocusMapMaybe() as getFocusMap() but always wrapped in a Maybe, absent if null
Maybe<java.lang.Object>	getMaybe() as get() but always wrapped in a Maybe, absent if null
<V> Maybe<V>	getMaybe(java.lang.Class<V> type) as get(Class) but always wrapped in a Maybe, absent if null
java.lang.Object	getRoot() returns the object at the root
T	getRootMap() returns the Map at the root, throwing if root is not a map
Jsonya.Navigator<T>	list() ensures the given focus is a list
Jsonya.Navigator<T>	map() ensures the given focus is a map, creating if needed (and creating inside the list if it is in a list)
Jsonya.Navigator<T>	pop() pops the most recently pushed focus, so that it returns to the last location push()ed
Jsonya.Navigator<T>	push() pushes the current focus to a stack, so that this location will be restored on the corresponding pop()
Jsonya.Navigator<T>	put(java.util.Map map) as put(Object, Object, Object...) for the kv-pairs in the given map; ignores null for convenience
Jsonya.Navigator<T>	put(java.lang.Object k1, java.lang.Object v1, java.lang.Object... kvOthers) puts the given key-value pair at the current focus (or multiple such), creating a map if needed, replacing any values stored against keys supplied here; if you wish to merge deep maps, see add(Object, Object...)
Jsonya.Navigator<T>	putIfNotNull(java.lang.Object k1, java.lang.Object v1)
Jsonya.Navigator<T>	root()
java.lang.String	toString() Returns JSON serialized output for given focus in the given jsonya; applies a naive toString for specialized types
Jsonya.Navigator<T>	useTranslator(<any> translator) specifies a translator function to use when new data is added; by default everything is added as a literal (ie Functions#identity()), but if you want to do translation on the way in, set a translation function

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Navigator

public Navigator(java.lang.Object backingStore,
                 java.lang.Class<? extends java.util.Map> mapType)

Navigator

public Navigator(java.lang.Class<? extends java.util.Map> mapType)

Method Detail

get

public java.lang.Object get()

returns the object at the focus, or null if none

getMaybe

@Nonnull
public Maybe<java.lang.Object> getMaybe()

as get() but always wrapped in a Maybe, absent if null

get

public <V> V get(java.lang.Class<V> type)

returns the object at the focus, casted to the given type, null if none

Throws:

java.lang.ClassCastException - if object exists here but of the wrong type

getMaybe

@Nonnull
public <V> Maybe<V> getMaybe(java.lang.Class<V> type)

as get(Class) but always wrapped in a Maybe, absent if null

Throws:

java.lang.ClassCastException - if object exists here but of the wrong type

get

public java.lang.Object get(java.lang.Object pathSegment,
                            java.lang.Object... furtherPathSegments)

gets the object at the indicated path from the current focus (without changing the path to that focus; use at(Object, Object...) to change focus)

root

public Jsonya.Navigator<T> root()

getRoot

public java.lang.Object getRoot()

returns the object at the root

getRootMap

public T getRootMap()

returns the Map at the root, throwing if root is not a map

getFocusMap

public T getFocusMap()

returns a Map at the given focus, creating if needed (so never null), throwing if it exists already and is not a map

getFocusMapMaybe

@Nonnull
public Maybe<T> getFocusMapMaybe()

as getFocusMap() but always wrapped in a Maybe, absent if null

Throws:

java.lang.ClassCastException - if object exists here but of the wrong type

useTranslator

public Jsonya.Navigator<T> useTranslator(<any> translator)

specifies a translator function to use when new data is added; by default everything is added as a literal (ie Functions#identity()), but if you want to do translation on the way in, set a translation function

note that translation should be idempotent as implementation may apply it multiple times in certain cases

push

public Jsonya.Navigator<T> push()

pushes the current focus to a stack, so that this location will be restored on the corresponding pop()

pop

public Jsonya.Navigator<T> pop()

pops the most recently pushed focus, so that it returns to the last location push()ed

at

public Jsonya.Navigator<T> at(java.lang.Object pathSegment,
                              java.lang.Object... furtherPathSegments)

returns the navigator moved to focus at the indicated key sequence in the given map, creating the path needed

atArray

public Jsonya.Navigator<T> atArray(java.lang.Object[] furtherPathSegments)

atExisting

public Jsonya.Navigator<T> atExisting(java.lang.Object pathSegment,
                                      java.lang.Object... furtherPathSegments)

returns the navigator moved to focus at the indicated key sequence in the given map, failing if not available

map

public Jsonya.Navigator<T> map()

ensures the given focus is a map, creating if needed (and creating inside the list if it is in a list)

put

public Jsonya.Navigator<T> put(java.lang.Object k1,
                               java.lang.Object v1,
                               java.lang.Object... kvOthers)

puts the given key-value pair at the current focus (or multiple such), creating a map if needed, replacing any values stored against keys supplied here; if you wish to merge deep maps, see add(Object, Object...)

putIfNotNull

public Jsonya.Navigator<T> putIfNotNull(java.lang.Object k1,
                                        java.lang.Object v1)

put

public Jsonya.Navigator<T> put(java.util.Map map)

as put(Object, Object, Object...) for the kv-pairs in the given map; ignores null for convenience

list

public Jsonya.Navigator<T> list()

ensures the given focus is a list

add

public Jsonya.Navigator<T> add(java.lang.Object o1,
                               java.lang.Object... others)

adds the given items to the focus, whether a list or a map, creating the focus if it doesn't already exist. if there is just one argument being added and the focus doesn't exist, that item is set as the focus. if there are more than one argument the focus is made as a map (and an even number of arguments is required). to add items to a list which might not exist, precede by a call to list().

when adding items to a list, iterable and array arguments are flattened because that makes the most sense when working with deep maps (adding one map to another where both contain lists, for example); to prevent flattening use addUnflattened(Object, Object...)

when adding to a map, arguments will be treated as things to put into the map, accepting either multiple arguments, as key1, value1, key2, value2, ... (and must be an event number); or a single argument which must be a map, in which case the value for each key in the supplied map is added to any existing value against that key in the target map (in other words, it will do a "deep put", where nested maps are effectively merged)

this implementation will currently throw if you attempt to add a non-map to anything present which is not a list; auto-conversion to a list may be added in a future version

addUnflattened

public Jsonya.Navigator<T> addUnflattened(java.lang.Object o1,
                                          java.lang.Object... others)

adds the given arguments to a list at this point (will not descend into maps, and will not flatten lists)

toString

public java.lang.String toString()

Returns JSON serialized output for given focus in the given jsonya; applies a naive toString for specialized types

Overrides:

toString in class java.lang.Object