Package net.sf.eBusx.geo

Class GeoCollection.Builder

java.lang.Object

net.sf.eBus.messages.EMessageObject.Builder<M>

net.sf.eBus.messages.EField.Builder<F>

net.sf.eBusx.geo.GeoObject.GeoBuilder<GeoCollection,GeoCollection.Builder>

net.sf.eBusx.geo.GeoCollection.Builder

Enclosing class:

GeoCollection

public static final class GeoCollection.Builder
extends GeoObject.GeoBuilder<GeoCollection,GeoCollection.Builder>

Builder class used to create GeoJSON collection instance. A Builder instance is obtained by calling GeoCollection.builder() method.

See Also:

GeoCollection.builder()

Field Summary

Fields inherited from class net.sf.eBus.messages.EMessageObject.Builder

mTargetClass

Method Summary

Modifier and Type	Method	Description
GeoCollection.Builder	add(GeoObject geometry)	Appends geometry to geometries list.
GeoCollection.Builder	addAll(java.util.Collection<GeoObject> geometries)	Appends geometries collection to geometries list.
GeoCollection.Builder	addAll(GeoObject[] geometries)	Appends geometries array to geometries list.
protected GeoCollection	buildImpl()	Returns a new GeoCollection instance created from this builder's settings.
GeoCollection.Builder	geometries(GeoObject[] geometries)	Sets geometries list to given array.
protected GeoCollection.Builder	self()	Returns subclass instance.

Methods inherited from class net.sf.eBusx.geo.GeoObject.GeoBuilder

boundingBox, type

Methods inherited from class net.sf.eBus.messages.EField.Builder

validate

Methods inherited from class net.sf.eBus.messages.EMessageObject.Builder

build

Methods inherited from class java.lang.Object

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

Method Detail

self

protected GeoCollection.Builder self()

Description copied from class: GeoObject.GeoBuilder

Returns subclass instance.

Specified by:

self in class GeoObject.GeoBuilder<GeoCollection,GeoCollection.Builder>

Returns:

builder instance reference.

buildImpl

protected GeoCollection buildImpl()

Returns a new GeoCollection instance created from this builder's settings.

Specified by:

buildImpl in class EMessageObject.Builder<GeoCollection>

Returns:

GeoCollection instance.

add

public GeoCollection.Builder add(GeoObject geometry)

Appends geometry to geometries list.

Parameters:

geometry - append this geometry.

Returns:

this Builder instance.

Throws:

java.lang.NullPointerException - if geometry is null.

addAll

public GeoCollection.Builder addAll(@Nullable
                                    GeoObject[] geometries)

Appends geometries array to geometries list. Geometries array may be null or empty. If this is the case nothing is done.

Parameters:

geometries - append all geometries to list.

Returns:

this Builder instance.

addAll

public GeoCollection.Builder addAll(@Nullable
                                    java.util.Collection<GeoObject> geometries)

Appends geometries collection to geometries list. Geometries collection may be null or empty.

Parameters:

geometries - append all geometries to list.

Returns:

this Builder instance.

geometries

public GeoCollection.Builder geometries(GeoObject[] geometries)

Sets geometries list to given array. Note that all previously added geometries are removed from the list prior to adding these geometries but after determining that the array is not null.

Parameters:

geometries - GeoJSON geometries.

Returns:

this Builder instance.

Throws:

java.lang.NullPointerException - if geometries is null. If this exception is thrown then geometries list is unchanged.