JsonRepresentation (Isis RestfulObjects Viewer AppLib 2.3.0)

java.lang.Object
- org.apache.isis.viewer.restfulobjects.applib.JsonRepresentation

Direct Known Subclasses:

DomainRepresentation, ErrorRepresentation, LinkRepresentation
```
public class JsonRepresentation
extends Object
```
A wrapper around JsonNode that provides some additional helper methods.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`JsonRepresentation.HasExtensions`
`static interface`	`JsonRepresentation.HasLinks`
`static interface`	`JsonRepresentation.HasLinkToSelf`
`static interface`	`JsonRepresentation.HasLinkToUp`

Field Summary

Fields
Modifier and Type	Field and Description
`static org.joda.time.format.DateTimeFormatter`	`_HHmmss`
`protected org.codehaus.jackson.JsonNode`	`jsonNode`
`static org.joda.time.format.DateTimeFormatter`	`yyyyMMdd`
`static org.joda.time.format.DateTimeFormatter`	`yyyyMMddTHHmmssZ`

Constructor Summary

Constructors
Constructor and Description

JsonRepresentation(org.codehaus.jackson.JsonNode jsonNode)

Constructors
Constructor and Description
`JsonRepresentation(org.codehaus.jackson.JsonNode jsonNode)`

Method Summary

Methods
Modifier and Type	Method and Description
`JsonRepresentation`	`arrayAdd(boolean value)`
`JsonRepresentation`	`arrayAdd(double value)`
`JsonRepresentation`	`arrayAdd(float value)`
`JsonRepresentation`	`arrayAdd(int value)`
`JsonRepresentation`	`arrayAdd(org.codehaus.jackson.JsonNode value)`
`JsonRepresentation`	`arrayAdd(JsonRepresentation value)`
`JsonRepresentation`	`arrayAdd(long value)`
`JsonRepresentation`	`arrayAdd(Object value)`
`JsonRepresentation`	`arrayAdd(String value)`
`JsonRepresentation`	`arrayGet(int i)`
`Iterable<JsonRepresentation>`	`arrayIterable()`
`<T> Iterable<T>`	`arrayIterable(Class<T> requiredType)`
`Iterator<JsonRepresentation>`	`arrayIterator()`
`<T> Iterator<T>`	`arrayIterator(Class<T> requiredType)`
`JsonRepresentation`	`arraySetElementAt(int i, JsonRepresentation objectRepr)`
`<T extends JsonRepresentation> T`	`as(Class<T> cls)` Convenience to simply "downcast".
`String`	`asArg()`
`JsonRepresentation`	`asArray()`
`protected org.codehaus.jackson.node.ArrayNode`	`asArrayNode()` Convert underlying representation into an array.
`BigDecimal`	`asBigDecimal()` Use `isBigDecimal()` to check first, if required.
`BigDecimal`	`asBigDecimal(String format)` Use `isBigDecimal()` to check first, if required.
`BigInteger`	`asBigInteger()` Use `isBigInteger()` to check first, if required.
`BigInteger`	`asBigInteger(String format)`
`Boolean`	`asBoolean()` Use `isBoolean()` to check first, if required.
`Byte`	`asByte()` Use `isIntegralNumber()` to test if number (it is not possible to check if a byte, however).
`Character`	`asChar()` Use `isString()` to check if string (it is not possible to check if a character, however).
`Date`	`asDate()`
`Date`	`asDateTime()`
`Double`	`asDouble()` Use `isDouble()` to check first, if required.
`Float`	`asFloat()` Use `isNumber()` to test if number (it is not possible to check if a float, however).
`InputStream`	`asInputStream()`
`Integer`	`asInt()` Use `isInt()` to check first, if required.
`org.codehaus.jackson.JsonNode`	`asJsonNode()`
`LinkRepresentation`	`asLink()` Use `isLink()` to check first, if required.
`Long`	`asLong()` Use `isLong()` to check first, if required.
`JsonRepresentation`	`asMap()`
`JsonRepresentation`	`asNull()` Either returns a `JsonRepresentation` that indicates that the wrapped node has `null` value (ie `isNull()`), or returns `null` if there was no node with the provided path.
`Number`	`asNumber()`
`protected org.codehaus.jackson.node.ObjectNode`	`asObjectNode()` Convert underlying representation into an object (map).
`Short`	`asShort()` Use `isIntegralNumber()` to check if number (it is not possible to check if a short, however).
`String`	`asString()` Use `isString()` to check first, if required.
`Date`	`asTime()`
`String`	`asUrlEncoded()`
`JsonRepresentation`	`ensureArray()` A reciprocal of the behaviour of the automatic dereferencing of arrays that occurs when there is only a single instance.
`boolean`	`equals(Object obj)`
`JsonRepresentation`	`getArray(String path)`
`JsonRepresentation`	`getArrayEnsured(String path)`
`BigDecimal`	`getBigDecimal(String path)` Use `isBigDecimal(String)` to check first, if required.
`BigDecimal`	`getBigDecimal(String path, String formatRequested)` Use `isBigDecimal(String)` to check first, if required.
`BigInteger`	`getBigInteger(String path)` Use `isBigInteger(String)` to check first, if required.
`BigInteger`	`getBigInteger(String path, String formatRequested)` Use `isBigInteger(String)` to check first, if required.
`Boolean`	`getBoolean(String path)` Use `isBoolean(String)` to check first, if required.
`Byte`	`getByte(String path)` Use `isIntegralNumber(String)` to test if number (it is not possible to check if a byte, however).
`Character`	`getChar(String path)` Use `isString(String)` to check if string (it is not possible to check if a character, however).
`Date`	`getDate(String path)`
`Date`	`getDateTime(String path)`
`Double`	`getDouble(String path)` Use `isDouble(String)` to check first, if required.
`Float`	`getFloat(String path)` Use `isDecimal(String)` to test if a decimal value
`Integer`	`getInt(String path)` Use `isInt(String)` to check first, if required.
`LinkRepresentation`	`getLink(String path)` Use `isLink(String)` to check first, if required.
`Long`	`getLong(String path)` Use `isLong(String)` to check first, if required.
`JsonRepresentation`	`getMap(String path)`
`JsonRepresentation`	`getNull(String path)` Either returns a `JsonRepresentation` that indicates that the wrapped node has `null` value (ie `isNull()`), or returns `null` if there was no node with the provided path.
`JsonRepresentation`	`getRepresentation(String pathTemplate, Object... args)`
`Short`	`getShort(String path)` Use `isIntegralNumber(String)` to check if number (it is not possible to check if a short, however).
`String`	`getString(String path)` Use `isString(String)` to check first, if required.
`Date`	`getTime(String path)`
`int`	`hashCode()`
`boolean`	`isArray()`
`boolean`	`isArray(String path)`
`boolean`	`isBigDecimal()`
`boolean`	`isBigDecimal(String path)`
`boolean`	`isBigInteger()`
`boolean`	`isBigInteger(String path)`
`boolean`	`isBoolean()`
`boolean`	`isBoolean(String path)`
`boolean`	`isDecimal()`
`boolean`	`isDecimal(String path)`
`boolean`	`isDouble()` Deprecated. - use `isDecimal()`
`boolean`	`isDouble(String path)` Deprecated. - use `isDecimal(String)`
`boolean`	`isInt()`
`boolean`	`isInt(String path)`
`boolean`	`isIntegralNumber()` Is a long, an int or a `BigInteger`.
`boolean`	`isIntegralNumber(String path)` Is a long, an int or a `BigInteger`.
`boolean`	`isLink()`
`boolean`	`isLink(org.codehaus.jackson.JsonNode node)`
`boolean`	`isLink(String path)`
`boolean`	`isLong()`
`boolean`	`isLong(String path)`
`boolean`	`isMap()`
`boolean`	`isMap(String path)`
`boolean`	`isNull()`
`Boolean`	`isNull(String path)` Indicates that the wrapped node has `null` value (ie `isNull()`), or returns `null` if there was no node with the provided path.
`boolean`	`isNumber()`
`boolean`	`isNumber(String path)`
`boolean`	`isString()`
`boolean`	`isString(String path)`
`boolean`	`isValue()` Node is a value (nb: could be `null`).
`boolean`	`mapHas(String key)`
`Iterable<Map.Entry<String,JsonRepresentation>>`	`mapIterable()`
`Iterator<Map.Entry<String,JsonRepresentation>>`	`mapIterator()`
`JsonRepresentation`	`mapPut(Iterable<Map.Entry<String,JsonRepresentation>> entries)`
`JsonRepresentation`	`mapPut(Map.Entry<String,JsonRepresentation> entry)`
`JsonRepresentation`	`mapPut(String key, BigDecimal value)`
`JsonRepresentation`	`mapPut(String key, BigInteger value)`
`JsonRepresentation`	`mapPut(String key, boolean value)`
`JsonRepresentation`	`mapPut(String key, Boolean value)`
`JsonRepresentation`	`mapPut(String key, byte value)`
`JsonRepresentation`	`mapPut(String key, Byte value)`
`JsonRepresentation`	`mapPut(String key, char value)`
`JsonRepresentation`	`mapPut(String key, Character value)`
`JsonRepresentation`	`mapPut(String key, double value)`
`JsonRepresentation`	`mapPut(String key, Double value)`
`JsonRepresentation`	`mapPut(String key, float value)`
`JsonRepresentation`	`mapPut(String key, Float value)`
`JsonRepresentation`	`mapPut(String key, int value)`
`JsonRepresentation`	`mapPut(String key, Integer value)`
`JsonRepresentation`	`mapPut(String key, org.codehaus.jackson.JsonNode value)`
`JsonRepresentation`	`mapPut(String key, JsonRepresentation value)`
`JsonRepresentation`	`mapPut(String key, List<Object> value)`
`JsonRepresentation`	`mapPut(String key, long value)`
`JsonRepresentation`	`mapPut(String key, Long value)`
`JsonRepresentation`	`mapPut(String key, Object value)`
`JsonRepresentation`	`mapPut(String key, short value)`
`JsonRepresentation`	`mapPut(String key, Short value)`
`JsonRepresentation`	`mapPut(String key, String value)`
`LinkRepresentation`	`mapValueAsLink()` Convert a representation that contains a single node representing a link into a `LinkRepresentation`.
`static JsonRepresentation`	`newArray()`
`static JsonRepresentation`	`newArray(int initialSize)`
`static JsonRepresentation`	`newMap(String... keyValuePairs)`
`int`	`size()`
`String`	`toString()`

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

Field Detail

jsonNode

protected final org.codehaus.jackson.JsonNode jsonNode

yyyyMMdd

public static final org.joda.time.format.DateTimeFormatter yyyyMMdd

yyyyMMddTHHmmssZ

public static final org.joda.time.format.DateTimeFormatter yyyyMMddTHHmmssZ

_HHmmss

public static final org.joda.time.format.DateTimeFormatter _HHmmss

Constructor Detail

JsonRepresentation

public JsonRepresentation(org.codehaus.jackson.JsonNode jsonNode)

Method Detail

newMap

public static JsonRepresentation newMap(String... keyValuePairs)

newArray

public static JsonRepresentation newArray()

newArray

public static JsonRepresentation newArray(int initialSize)

asJsonNode

public org.codehaus.jackson.JsonNode asJsonNode()

size
```
public int size()
```

isValue
```
public boolean isValue()
```
Node is a value (nb: could be null).

getRepresentation

public JsonRepresentation getRepresentation(String pathTemplate,
                                   Object... args)

isArray
```
public boolean isArray(String path)
```

isArray
```
public boolean isArray()
```

getArray

public JsonRepresentation getArray(String path)

asArray
```
public JsonRepresentation asArray()
```

getArrayEnsured

public JsonRepresentation getArrayEnsured(String path)

isMap
```
public boolean isMap(String path)
```

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

getMap

public JsonRepresentation getMap(String path)

asMap
```
public JsonRepresentation asMap()
```

isNumber
```
public boolean isNumber(String path)
```

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

asNumber
```
public Number asNumber()
```

isIntegralNumber

public boolean isIntegralNumber(String path)

Is a long, an int or a BigInteger.

isIntegralNumber
```
public boolean isIntegralNumber()
```
Is a long, an int or a BigInteger.

getDate
```
public Date getDate(String path)
```

asDate
```
public Date asDate()
```

getDateTime
```
public Date getDateTime(String path)
```

asDateTime
```
public Date asDateTime()
```

getTime
```
public Date getTime(String path)
```

asTime
```
public Date asTime()
```

isBoolean

public boolean isBoolean(String path)

isBoolean
```
public boolean isBoolean()
```

getBoolean
```
public Boolean getBoolean(String path)
```
Use isBoolean(String) to check first, if required.

asBoolean
```
public Boolean asBoolean()
```
Use isBoolean() to check first, if required.

getByte
```
public Byte getByte(String path)
```
Use isIntegralNumber(String) to test if number (it is not possible to check if a byte, however).

asByte
```
public Byte asByte()
```
Use isIntegralNumber() to test if number (it is not possible to check if a byte, however).

getShort
```
public Short getShort(String path)
```
Use isIntegralNumber(String) to check if number (it is not possible to check if a short, however).

asShort
```
public Short asShort()
```
Use isIntegralNumber() to check if number (it is not possible to check if a short, however).

getChar
```
public Character getChar(String path)
```
Use isString(String) to check if string (it is not possible to check if a character, however).

asChar
```
public Character asChar()
```
Use isString() to check if string (it is not possible to check if a character, however).

isInt
```
public boolean isInt(String path)
```

isInt
```
public boolean isInt()
```

getInt
```
public Integer getInt(String path)
```
Use isInt(String) to check first, if required.

asInt
```
public Integer asInt()
```
Use isInt() to check first, if required.

isLong
```
public boolean isLong(String path)
```

isLong
```
public boolean isLong()
```

getLong
```
public Long getLong(String path)
```
Use isLong(String) to check first, if required.

asLong
```
public Long asLong()
```
Use isLong() to check first, if required.

getFloat
```
public Float getFloat(String path)
```
Use isDecimal(String) to test if a decimal value

asFloat
```
public Float asFloat()
```
Use isNumber() to test if number (it is not possible to check if a float, however).

isDecimal

public boolean isDecimal(String path)

isDecimal
```
public boolean isDecimal()
```

isDouble

@Deprecated
public boolean isDouble(String path)

Deprecated. - use isDecimal(String)

isDouble
```
@Deprecated
public boolean isDouble()
```
Deprecated. - use isDecimal()

getDouble
```
public Double getDouble(String path)
```
Use isDouble(String) to check first, if required.

asDouble
```
public Double asDouble()
```
Use isDouble() to check first, if required.

isBigInteger

public boolean isBigInteger(String path)

isBigInteger
```
public boolean isBigInteger()
```

getBigInteger
```
public BigInteger getBigInteger(String path)
```
Use isBigInteger(String) to check first, if required.

getBigInteger

public BigInteger getBigInteger(String path,
                       String formatRequested)

Use isBigInteger(String) to check first, if required.

asBigInteger
```
public BigInteger asBigInteger()
```
Use isBigInteger() to check first, if required.

asBigInteger

public BigInteger asBigInteger(String format)

isBigDecimal

public boolean isBigDecimal(String path)

isBigDecimal
```
public boolean isBigDecimal()
```

getBigDecimal
```
public BigDecimal getBigDecimal(String path)
```
Use isBigDecimal(String) to check first, if required.

getBigDecimal

public BigDecimal getBigDecimal(String path,
                       String formatRequested)

Use isBigDecimal(String) to check first, if required.

asBigDecimal
```
public BigDecimal asBigDecimal()
```
Use isBigDecimal() to check first, if required.

asBigDecimal
```
public BigDecimal asBigDecimal(String format)
```
Use isBigDecimal() to check first, if required.

isString
```
public boolean isString(String path)
```

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

getString
```
public String getString(String path)
```
Use isString(String) to check first, if required.

asString
```
public String asString()
```
Use isString() to check first, if required.

asArg
```
public String asArg()
```

isLink
```
public boolean isLink()
```

isLink
```
public boolean isLink(String path)
```

isLink

public boolean isLink(org.codehaus.jackson.JsonNode node)

getLink

public LinkRepresentation getLink(String path)

Use isLink(String) to check first, if required.

asLink
```
public LinkRepresentation asLink()
```
Use isLink() to check first, if required.

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

isNull
```
public Boolean isNull(String path)
```
Indicates that the wrapped node has null value (ie isNull()), or returns null if there was no node with the provided path.

getNull
```
public JsonRepresentation getNull(String path)
```
Either returns a JsonRepresentation that indicates that the wrapped node has null value (ie isNull()), or returns null if there was no node with the provided path.
Use isNull(String) to check first, if required.

asNull
```
public JsonRepresentation asNull()
```
Either returns a JsonRepresentation that indicates that the wrapped node has null value (ie isNull()), or returns null if there was no node with the provided path.
Use isNull() to check first, if required.

mapValueAsLink
```
public LinkRepresentation mapValueAsLink()
```
Convert a representation that contains a single node representing a link into a LinkRepresentation.

asInputStream
```
public InputStream asInputStream()
```

asArrayNode

protected org.codehaus.jackson.node.ArrayNode asArrayNode()

Convert underlying representation into an array.

asObjectNode
```
protected org.codehaus.jackson.node.ObjectNode asObjectNode()
```
Convert underlying representation into an object (map).

as
```
public <T extends JsonRepresentation> T as(Class<T> cls)
```
Convenience to simply "downcast".
In fact, the method creates a new instance of the specified type, which shares the underlying jsonNode.

asUrlEncoded
```
public String asUrlEncoded()
```

arrayAdd

public JsonRepresentation arrayAdd(Object value)

arrayAdd

public JsonRepresentation arrayAdd(JsonRepresentation value)

arrayAdd

public JsonRepresentation arrayAdd(String value)

arrayAdd

public JsonRepresentation arrayAdd(org.codehaus.jackson.JsonNode value)

arrayAdd

public JsonRepresentation arrayAdd(long value)

arrayAdd

public JsonRepresentation arrayAdd(int value)

arrayAdd

public JsonRepresentation arrayAdd(double value)

arrayAdd

public JsonRepresentation arrayAdd(float value)

arrayAdd

public JsonRepresentation arrayAdd(boolean value)

arrayIterable

public Iterable<JsonRepresentation> arrayIterable()

arrayIterable

public <T> Iterable<T> arrayIterable(Class<T> requiredType)

arrayIterator

public Iterator<JsonRepresentation> arrayIterator()

arrayIterator

public <T> Iterator<T> arrayIterator(Class<T> requiredType)

arrayGet

public JsonRepresentation arrayGet(int i)

arraySetElementAt

public JsonRepresentation arraySetElementAt(int i,
                                   JsonRepresentation objectRepr)

mapHas
```
public boolean mapHas(String key)
```

mapPut

public JsonRepresentation mapPut(String key,
                        List<Object> value)

mapPut

public JsonRepresentation mapPut(String key,
                        Object value)

mapPut

public JsonRepresentation mapPut(String key,
                        JsonRepresentation value)

mapPut

public JsonRepresentation mapPut(String key,
                        String value)

mapPut

public JsonRepresentation mapPut(String key,
                        org.codehaus.jackson.JsonNode value)

mapPut

public JsonRepresentation mapPut(String key,
                        byte value)

mapPut

public JsonRepresentation mapPut(String key,
                        Byte value)

mapPut

public JsonRepresentation mapPut(String key,
                        short value)

mapPut

public JsonRepresentation mapPut(String key,
                        Short value)

mapPut

public JsonRepresentation mapPut(String key,
                        int value)

mapPut

public JsonRepresentation mapPut(String key,
                        Integer value)

mapPut

public JsonRepresentation mapPut(String key,
                        long value)

mapPut

public JsonRepresentation mapPut(String key,
                        Long value)

mapPut

public JsonRepresentation mapPut(String key,
                        float value)

mapPut

public JsonRepresentation mapPut(String key,
                        Float value)

mapPut

public JsonRepresentation mapPut(String key,
                        double value)

mapPut

public JsonRepresentation mapPut(String key,
                        Double value)

mapPut

public JsonRepresentation mapPut(String key,
                        boolean value)

mapPut

public JsonRepresentation mapPut(String key,
                        Boolean value)

mapPut

public JsonRepresentation mapPut(String key,
                        char value)

mapPut

public JsonRepresentation mapPut(String key,
                        Character value)

mapPut

public JsonRepresentation mapPut(String key,
                        BigInteger value)

mapPut

public JsonRepresentation mapPut(Iterable<Map.Entry<String,JsonRepresentation>> entries)

mapPut

public JsonRepresentation mapPut(Map.Entry<String,JsonRepresentation> entry)

mapPut

public JsonRepresentation mapPut(String key,
                        BigDecimal value)

mapIterable

public Iterable<Map.Entry<String,JsonRepresentation>> mapIterable()

mapIterator

public Iterator<Map.Entry<String,JsonRepresentation>> mapIterator()

ensureArray
```
public JsonRepresentation ensureArray()
```
A reciprocal of the behaviour of the automatic dereferencing of arrays that occurs when there is only a single instance.

See Also:
toJsonNode(List)

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class Object

equals
```
public boolean equals(Object obj)
```
Overrides:

equals in class Object

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

toString in class Object

Class JsonRepresentation

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

jsonNode

yyyyMMdd

yyyyMMddTHHmmssZ

_HHmmss

Constructor Detail

JsonRepresentation

Method Detail

newMap

newArray

newArray

asJsonNode

size

isValue

getRepresentation

isArray

isArray

getArray

asArray

getArrayEnsured

isMap

isMap

getMap

asMap

isNumber

isNumber

asNumber

isIntegralNumber

isIntegralNumber

getDate

asDate

getDateTime

asDateTime

getTime

asTime

isBoolean

isBoolean

getBoolean

asBoolean

getByte

asByte

getShort

asShort

getChar

asChar

isInt

isInt

getInt

asInt

isLong

isLong

getLong

asLong

getFloat

asFloat

isDecimal

isDecimal

isDouble

isDouble

getDouble

asDouble

isBigInteger

isBigInteger

getBigInteger

getBigInteger

asBigInteger

asBigInteger

isBigDecimal

isBigDecimal

getBigDecimal

getBigDecimal

asBigDecimal

asBigDecimal

isString