gov.usgs.earthquake.nshmp.geo

Class LocationList.Builder

java.lang.Object

gov.usgs.earthquake.nshmp.geo.LocationList.Builder

Enclosing class:

LocationList

public static final class LocationList.Builder
extends Object

A reusable builder of LocationLists. Repeat calls to build() will return multiple lists in series with each new list containing all the Locations of the one before it. Builders do not permit the addition of null elements.

Use LocationList.builder() to create new builder instances.

Method Summary

Modifier and Type	Method and Description
LocationList.Builder	add(double lat, double lon) Add a new Location specified by the supplied latitude and longitude and a depth of 0 km to the LocationList.
LocationList.Builder	add(double lat, double lon, double depth) Add a new Location specified by the supplied latitude, longitude, and depth to the LocationList.
LocationList.Builder	add(Location... locs) Add each Location in locs to the LocationList .
LocationList.Builder	add(Location loc) Add a Location to the LocationList.
LocationList.Builder	addAll(Iterable<Location> locs) Add each Location in locs to the LocationList .
LocationList	build() Return a newly created LocationList.

Methods inherited from class java.lang.Object

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

Method Detail

add

public LocationList.Builder add(Location loc)

Add a Location to the LocationList.

Parameters:

loc - to add

Returns:

this Builder

add

public LocationList.Builder add(double lat,
                                double lon)

Add a new Location specified by the supplied latitude and longitude and a depth of 0 km to the LocationList.

Parameters:

lat - latitude in decimal degrees

lon - longitude in decimal degrees

Returns:

this Builder

Throws:

IllegalArgumentException - if any values are out of range

See Also:

Coordinates

add

public LocationList.Builder add(double lat,
                                double lon,
                                double depth)

Add a new Location specified by the supplied latitude, longitude, and depth to the LocationList.

Parameters:

lat - latitude in decimal degrees

lon - longitude in decimal degrees

depth - in km (positive down)

Returns:

this Builder

Throws:

IllegalArgumentException - if any values are out of range

See Also:

Coordinates

add

public LocationList.Builder add(Location... locs)

Add each Location in locs to the LocationList .

Parameters:

locs - to add

Returns:

this Builder

addAll

public LocationList.Builder addAll(Iterable<Location> locs)

Add each Location in locs to the LocationList .

Parameters:

locs - to add

Returns:

this Builder

build

public LocationList build()

Return a newly created LocationList.

Returns:

a new ordered collection of Locations

Throws:

IllegalStateException - if the list to be returned is empty