Package net.sf.eBusx.geo

Class GeoMultiPoint.Builder

java.lang.Object

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

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

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

net.sf.eBusx.geo.GeoMultiPoint.Builder

Enclosing class:

GeoMultiPoint

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

Builder class used to create GeoMultiPoint instances. It is suggested that a new builder instance be created for each new multi-point instance rather than re-using builder instances.

Field Summary

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

mTargetClass

Method Summary

Modifier and Type	Method	Description
GeoMultiPoint.Builder	add(Position pos)	Appends position to positions list.
GeoMultiPoint.Builder	addAll(java.util.Collection<Position> positions)	Appends position collection to positions list.
GeoMultiPoint.Builder	addAll(Position[] positions)	Appends position array to positions list.
protected GeoMultiPoint	buildImpl()	Returns a new GeoMultiPoint instance configured from this Builder's validated settings.
GeoMultiPoint.Builder	positions(Position[] positions)	Sets positions list to the given position values.
protected GeoMultiPoint.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 GeoMultiPoint.Builder self()

Description copied from class: GeoObject.GeoBuilder

Returns subclass instance.

Specified by:

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

Returns:

builder instance reference.

buildImpl

protected GeoMultiPoint buildImpl()

Returns a new GeoMultiPoint instance configured from this Builder's validated settings.

Specified by:

buildImpl in class EMessageObject.Builder<GeoMultiPoint>

Returns:

new multi-point GeoJSON instance.

add

public GeoMultiPoint.Builder add(Position pos)

Appends position to positions list.

Parameters:

pos - append this position.

Returns:

this Builder instance.

Throws:

java.lang.NullPointerException - if pos is null.

See Also:

addAll(Position[]), addAll(Collection), positions(Position[])

addAll

public GeoMultiPoint.Builder addAll(Position[] positions)

Appends position array to positions list.

Parameters:

positions - append all positions to list.

Returns:

this Builder instance.

Throws:

java.lang.NullPointerException - if positions is null.

See Also:

add(Position), addAll(Collection), positions(Position[])

addAll

public GeoMultiPoint.Builder addAll(java.util.Collection<Position> positions)

Appends position collection to positions list.

Parameters:

positions - append all positions to list.

Returns:

this Builder instance.

Throws:

java.lang.NullPointerException - if positions is null.

See Also:

add(Position), addAll(Position[]), positions(Position[])

positions

public GeoMultiPoint.Builder positions(Position[] positions)

Sets positions list to the given position values. Note that all previously a-dded positions are removed from the list prior to adding these positions but after verifying that positions is not null.

Parameters:

positions - set position list

Returns:

this Builder instance.

Throws:

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

See Also:

add(Position), addAll(Position[]), addAll(Collection)