gov.usgs.earthquake.nshmp.geo.json

Class Properties

java.lang.Object

gov.usgs.earthquake.nshmp.geo.json.Properties

public final class Properties
extends Object

GeoJSON properties helper class.

GeoJSON properties serialize to/from a Map<String, Object>. To simplify repeated property map creation where only one property might be changing, this class provides a reusable builder. The class also provides methods to help get and set simplestyle-spec (v1.1.0) properties that may be considered when rendering GeoJSON online.

If a property map contains arrays or other nested objects as values, use get(String) and cast to the appropriate type:

• Arrays of any type deserialize to List<?>
• Objects deserialize to Map<String,?>

Author:

Peter Powers, Brandon Clayton

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Properties.Builder Reusable property map builder.
static class	Properties.Style Identifiers for simplestyle-spec (v1.1.0) properties.

Method Summary

Modifier and Type	Method and Description
static Properties.Builder	builder() Return a reusable property map builder that preserves the order in which properties are added.
boolean	containsKey(Properties.Style key) Return whether the supplied key exists in the property map
boolean	containsKey(String key) Return whether the supplied key exists in the property map
Object	get(String key) Return the value for the specified key as an object.
<T> T	get(String key, Class<T> classOfT) Return the value for the specified key as an object of the specified class.
boolean	getBoolean(String key) Return the value for the specified key as an boolean.
double	getDouble(Properties.Style key) Return the value for the specified simplestyle key as an double.
double	getDouble(String key) Return the value for specified key as an double.
int	getInt(String key) Return the value for the specified key as an int.
String	getString(Properties.Style key) Return the value for the specified simplestyle key as an String.
String	getString(String key) Return the value for specified key as an String.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

containsKey

public boolean containsKey(String key)

Return whether the supplied key exists in the property map

Parameters:

key - to check for

containsKey

public boolean containsKey(Properties.Style key)

Return whether the supplied key exists in the property map

Parameters:

key - get value for

get

public Object get(String key)

Return the value for the specified key as an object. Note that this method may return null as the property value.

Parameters:

key - to get value for

Throws:

IllegalArgumentException - if no such property key exists

get

public <T> T get(String key,
                 Class<T> classOfT)

Return the value for the specified key as an object of the specified class.

Type Parameters:

T - the type of the desired object

Parameters:

key - to get value for

classOfT - the class of T

Throws:

IllegalArgumentException - if no such property key exists

getBoolean

public boolean getBoolean(String key)

Return the value for the specified key as an boolean.

Throws:

IllegalArgumentException - if no such property key exists

getInt

public int getInt(String key)

Return the value for the specified key as an int.

Throws:

IllegalArgumentException - if no such property key exists

getDouble

public double getDouble(String key)

Return the value for specified key as an double.

Throws:

IllegalArgumentException - if no such property key exists

getDouble

public double getDouble(Properties.Style key)

Return the value for the specified simplestyle key as an double.

Throws:

NullPointerException - if no such property key exists

getString

public String getString(String key)

Return the value for specified key as an String.

Throws:

NullPointerException - if no such property key exists

getString

public String getString(Properties.Style key)

Return the value for the specified simplestyle key as an String.

Throws:

NullPointerException - if no such property key exists

builder

public static Properties.Builder builder()

Return a reusable property map builder that preserves the order in which properties are added. build() returns a copy of the internal map instance.