gov.usgs.earthquake.nshmp.geo.json

Class Feature.Builder

java.lang.Object

gov.usgs.earthquake.nshmp.geo.json.Feature.Builder

Enclosing class:

Feature

public static class Feature.Builder
extends Object

A single-use feature builder. Repeat calls to builder methods overwrite previous calls; reusing feature instances is not recommended.

Method Summary

Modifier and Type	Method and Description
Feature.Builder	bbox(double[] bbox) Set the optional bbox (bounding box) field of this feature.
Feature	build() Return a new GeoJSON feature.
Feature.Builder	id(int id) Set the optional id field of this feature as an integer.
Feature.Builder	id(String id) Set the optional id field of this feature as a string.
Feature.Builder	properties(Map<String,?> properties) Set the properties of this feature.
String	toJson() Return the serialized form of a new GeoJSON feature.
void	write(Path path) Write the serialized form of a new GeoJSON feature to the file at path.

Methods inherited from class java.lang.Object

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

Method Detail

id

public Feature.Builder id(int id)

Set the optional id field of this feature as an integer.

Parameters:

id - to set

Returns:

this feature

id

public Feature.Builder id(String id)

Set the optional id field of this feature as a string.

Parameters:

id - to set

Returns:

this builder

bbox

public Feature.Builder bbox(double[] bbox)

Set the optional bbox (bounding box) field of this feature. See the GeoJSON specification

Parameters:

bbox - to set

Returns:

this builder

Throws:

IllegalArgument

properties

public Feature.Builder properties(Map<String,?> properties)

Set the properties of this feature.

Parameters:

properties - to set

Returns:

this builder

build

public Feature build()

Return a new GeoJSON feature.

toJson

public String toJson()

Return the serialized form of a new GeoJSON feature.

Throws:

IllegalStateException - if builder is empty

write

public void write(Path path)
           throws IOException

Write the serialized form of a new GeoJSON feature to the file at path.

Throws:

IllegalStateException - if builder is empty

IOException