IJsonObject (org.spincast:spincast-framework 0.9.22 API)

All Superinterfaces:

Iterable<Map.Entry<String,Object>>

All Known Implementing Classes:

JsonObject
```
public interface IJsonObject
extends Iterable<Map.Entry<String,Object>>
```
Represents a Json object "{}", and makes it easier to get its properties in a typed way.

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class IJsonObject.KeyNotFoundException
Exception thrown when a key is not found on a IJsonObject object.

Nested Classes
Modifier and Type	Interface and Description
`static class`	`IJsonObject.KeyNotFoundException` Exception thrown when a `key` is not found on a `IJsonObject` object.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`Object`	`get(String key)` Gets a property.
`Object`	`get(String key, Object defaultValue)` Gets a property.
`BigDecimal`	`getBigDecimal(String key)` Gets a property as `BigDecimal`.
`BigDecimal`	`getBigDecimal(String key, BigDecimal defaultValue)` Gets a property as `BigDecimal`.
`Boolean`	`getBoolean(String key)` Gets a property as `Boolean`.
`Boolean`	`getBoolean(String key, Boolean defaultValue)` Gets a property as `Boolean`.
`byte[]`	`getBytesFromBase64String(String key)` Gets a byte array, from a base 64 encoded property.
`byte[]`	`getBytesFromBase64String(String key, byte[] defaultValue)` Gets a byte array, from a base 64 encoded property.
`Date`	`getDate(String key)` Gets a UTC timezoned date from a `ISO 8601` date property.
`Date`	`getDate(String key, Date defaultValue)` Gets a UTC timezoned date from a `ISO 8601` date property.
`Double`	`getDouble(String key)` Gets a property as `Double`.
`Double`	`getDouble(String key, Double defaultValue)` Gets a property as `Double`.
`Float`	`getFloat(String key)` Gets a property as `Float`.
`Float`	`getFloat(String key, Float defaultValue)` Gets a property as `Float`.
`Integer`	`getInteger(String key)` Gets a property as `Integer`.
`Integer`	`getInteger(String key, Integer defaultValue)` Gets a property as `Integer`.
`IJsonArray`	`getJsonArray(String key)` Gets a property as `IJsonArray`.
`IJsonArray`	`getJsonArray(String key, IJsonArray defaultValue)` Gets a property as `IJsonArray`.
`IJsonObject`	`getJsonObject(String key)` Gets a property as `IJsonObject`.
`IJsonObject`	`getJsonObject(String key, IJsonObject defaultValue)` Gets a property as `IJsonObject`.
`Long`	`getLong(String key)` Gets a property as `Long`.
`Long`	`getLong(String key, Long defaultValue)` Gets a property as `Long`.
`String`	`getString(String key)` Gets a property as `String`.
`String`	`getString(String key, String defaultValue)` Gets a property as `String`.
`Map<String,Object>`	`getUnderlyingMap()` The underlying map.
`boolean`	`isKeyExists(String key)` Does the object contain the specified key?
`void`	`put(String key, Object value)` Adds a property to the object.
`void`	`remove(String key)` Removes a property from the object.
`void`	`removeAll()` Removes all properties from the object.
`String`	`toJsonString()` Gets the `Json` String representation of the object.
`String`	`toJsonString(boolean pretty)` Gets the `Json` String representation of the object.

Methods inherited from interface java.lang.Iterable
forEach, iterator, spliterator

- Method Detail
  - put
```
void put(String key,
         Object value)
```
    Adds a property to the object.
  - remove
```
void remove(String key)
```
    Removes a property from the object.
  - removeAll
```
void removeAll()
```
    Removes all properties from the object.
  - isKeyExists
```
boolean isKeyExists(String key)
```
    Does the object contain the specified key?
  - get
```
Object get(String key)
    throws IJsonObject.KeyNotFoundException
```
    Gets a property.
    
    Returns:
    
    the value of the property or null if not found.
    
    Throws:
    
    IJsonObject.KeyNotFoundException
  - get
```
Object get(String key,
           Object defaultValue)
```
    Gets a property.
    
    Returns:
    
    the value of the property or the specified defaultValue if not found.
  - getJsonObject
```
IJsonObject getJsonObject(String key)
                   throws IJsonObject.KeyNotFoundException
```
    Gets a property as IJsonObject.
    
    Returns:
    
    the value of the property or null if not found.
    
    Throws:
    
    IJsonObject.KeyNotFoundException
  - getJsonObject
```
IJsonObject getJsonObject(String key,
                          IJsonObject defaultValue)
```
    Gets a property as IJsonObject.
    
    Returns:
    
    the value of the property or the specified defaultValue if not found.
  - getJsonArray
```
IJsonArray getJsonArray(String key)
                 throws IJsonObject.KeyNotFoundException
```
    Gets a property as IJsonArray.
    
    Returns:
    
    the value of the property or null if not found.
    
    Throws:
    
    IJsonObject.KeyNotFoundException
  - getJsonArray
```
IJsonArray getJsonArray(String key,
                        IJsonArray defaultValue)
```
    Gets a property as IJsonArray.
    
    Returns:
    
    the value of the property or the specified defaultValue if not found.
  - getString
```
String getString(String key)
          throws IJsonObject.KeyNotFoundException
```
    Gets a property as String.
    
    Returns:
    
    the value of the property or null if not found.
    
    Throws:
    
    IJsonObject.KeyNotFoundException
  - getString
```
String getString(String key,
                 String defaultValue)
```
    Gets a property as String.
    
    Returns:
    
    the value of the property or the specified defaultValue if not found.
  - getInteger
```
Integer getInteger(String key)
            throws IJsonObject.KeyNotFoundException
```
    Gets a property as Integer.
    
    Returns:
    
    the value of the property or null if not found.
    
    Throws:
    
    IJsonObject.KeyNotFoundException
  - getInteger
```
Integer getInteger(String key,
                   Integer defaultValue)
```
    Gets a property as Integer.
    
    Returns:
    
    the value of the property or the specified defaultValue if not found.
  - getLong
```
Long getLong(String key)
      throws IJsonObject.KeyNotFoundException
```
    Gets a property as Long.
    
    Returns:
    
    the value of the property or null if not found.
    
    Throws:
    
    IJsonObject.KeyNotFoundException
  - getLong
```
Long getLong(String key,
             Long defaultValue)
```
    Gets a property as Long.
    
    Returns:
    
    the value of the property or the specified defaultValue if not found.
  - getFloat
```
Float getFloat(String key)
        throws IJsonObject.KeyNotFoundException
```
    Gets a property as Float.
    
    Returns:
    
    the value of the property or null if not found.
    
    Throws:
    
    IJsonObject.KeyNotFoundException
  - getFloat
```
Float getFloat(String key,
               Float defaultValue)
```
    Gets a property as Float.
    
    Returns:
    
    the value of the property or the specified defaultValue if not found.
  - getDouble
```
Double getDouble(String key)
          throws IJsonObject.KeyNotFoundException
```
    Gets a property as Double.
    
    Returns:
    
    the value of the property or null if not found.
    
    Throws:
    
    IJsonObject.KeyNotFoundException
  - getDouble
```
Double getDouble(String key,
                 Double defaultValue)
```
    Gets a property as Double.
    
    Returns:
    
    the value of the property or the specified defaultValue if not found.
  - getBoolean
```
Boolean getBoolean(String key)
            throws IJsonObject.KeyNotFoundException
```
    Gets a property as Boolean.
    
    Returns:
    
    the value of the property or null if not found.
    
    Throws:
    
    IJsonObject.KeyNotFoundException
  - getBoolean
```
Boolean getBoolean(String key,
                   Boolean defaultValue)
```
    Gets a property as Boolean.
    
    Returns:
    
    the value of the property or the specified defaultValue if not found.
  - getBigDecimal
```
BigDecimal getBigDecimal(String key)
                  throws IJsonObject.KeyNotFoundException
```
    Gets a property as BigDecimal.
    
    Returns:
    
    the value of the property or null if not found.
    
    Throws:
    
    IJsonObject.KeyNotFoundException
  - getBigDecimal
```
BigDecimal getBigDecimal(String key,
                         BigDecimal defaultValue)
```
    Gets a property as BigDecimal.
    
    Returns:
    
    the value of the property or the specified defaultValue if not found.
  - getBytesFromBase64String
```
byte[] getBytesFromBase64String(String key)
                         throws IJsonObject.KeyNotFoundException
```
    Gets a byte array, from a base 64 encoded property.
    
    Returns:
    
    the value of the property or null if not found.
    
    Throws:
    
    IJsonObject.KeyNotFoundException
  - getBytesFromBase64String
```
byte[] getBytesFromBase64String(String key,
                                byte[] defaultValue)
```
    Gets a byte array, from a base 64 encoded property.
    
    Returns:
    
    the value of the property or the specified defaultValue if not found.
  - getDate
```
Date getDate(String key)
      throws IJsonObject.KeyNotFoundException
```
    Gets a UTC timezoned date from a ISO 8601 date property.
    
    Returns:
    
    the value of the property or null if not found.
    
    Throws:
    
    IJsonObject.KeyNotFoundException
  - getDate
```
Date getDate(String key,
             Date defaultValue)
```
    Gets a UTC timezoned date from a ISO 8601 date property.
    
    Returns:
    
    the value of the property or the specified defaultValue if not found.
  - toJsonString
```
String toJsonString()
```
    Gets the Json String representation of the object.
  - toJsonString
```
String toJsonString(boolean pretty)
```
    Gets the Json String representation of the object.
    
    Parameters:
    
    pretty - ff true, the generated String will be formatted.
  - getUnderlyingMap
```
Map<String,Object> getUnderlyingMap()
```
    The underlying map.

Interface IJsonObject

Nested Class Summary

Method Summary

Methods inherited from interface java.lang.Iterable

Method Detail

put

remove

removeAll

isKeyExists

get

get

getJsonObject

getJsonObject

getJsonArray

getJsonArray

getString

getString

getInteger

getInteger

getLong

getLong

getFloat

getFloat

getDouble

getDouble

getBoolean

getBoolean

getBigDecimal

getBigDecimal

getBytesFromBase64String

getBytesFromBase64String

getDate

getDate

toJsonString

toJsonString

getUnderlyingMap