Package net.sf.eBusx.geo

Class GeoPolygon.Builder

java.lang.Object

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

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

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

net.sf.eBusx.geo.GeoPolygon.Builder

Enclosing class:

GeoPolygon

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

Builder class used to create GeoPolygon instances. A Builder instance is obtained by calling GeoPolygon.builder() method.

Field Summary

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

mTargetClass

Method Summary

Modifier and Type	Method	Description
GeoPolygon.Builder	add(LineString ring)	Appends linear ring to rings list.
GeoPolygon.Builder	addAll(java.util.Collection<LineString> rings)	Appends linear rings collection to linear rings list.
GeoPolygon.Builder	addAll(LineString[] rings)	Appends linear rings array to linear rings list.
protected GeoPolygon	buildImpl()	Returns a new GeoPolygon instance created from this builder's validated settings.
GeoPolygon.Builder	linearRings(LineString[] rings)	Sets linear rings list to the given linear ring values.
protected GeoPolygon.Builder	self()	Returns subclass instance.
protected Validator	validate(Validator problems)	Check if: at least one linear ring was provided, each linear ring has at least four positions, and each linear ring is is closed.

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

boundingBox, type

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 GeoPolygon.Builder self()

Description copied from class: GeoObject.GeoBuilder

Returns subclass instance.

Specified by:

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

Returns:

builder instance reference.

validate

protected Validator validate(Validator problems)

Check if:

1. at least one linear ring was provided,
2. each linear ring has at least four positions, and
3. each linear ring is is closed.

Note: does not validate if rings are properly ordered or follow the "right-hand rule" as mentioned in GeoJSON specification.

Overrides:

validate in class EField.Builder<GeoPolygon>

Parameters:

problems - append detected problems to this validator.

Returns:

problems to allow for method chaining.

See Also:

Validator

buildImpl

protected GeoPolygon buildImpl()

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

Specified by:

buildImpl in class EMessageObject.Builder<GeoPolygon>

Returns:

new GeoJSON polygon instance.

add

public GeoPolygon.Builder add(LineString ring)

Appends linear ring to rings list.

Parameters:

ring - add this linear ring.

Returns:

this Builder instance.

Throws:

java.lang.NullPointerException - if ring is null.

java.lang.IllegalArgumentException - if ring has < 4 positions or is not closed.

See Also:

addAll(LineString[]), addAll(Collection), linearRings(LineString[])

addAll

public GeoPolygon.Builder addAll(LineString[] rings)

Appends linear rings array to linear rings list.

Parameters:

rings - append all rings to list.

Returns:

this Builder instance.

Throws:

java.lang.NullPointerException - if rings is null or rings contains a null value.

java.lang.IllegalArgumentException - if rings contains an invalid ring.

See Also:

add(LineString), addAll(Collection), linearRings(LineString[])

addAll

public GeoPolygon.Builder addAll(java.util.Collection<LineString> rings)

Appends linear rings collection to linear rings list.

Parameters:

rings - append all rings to list.

Returns:

this Builder instance.

Throws:

java.lang.NullPointerException - if rings is null or contains a null ring.

java.lang.IllegalArgumentException - if rings contains an invalid ring.

See Also:

add(LineString), addAll(LineString[]), linearRings(LineString[])

linearRings

public GeoPolygon.Builder linearRings(LineString[] rings)

Sets linear rings list to the given linear ring values. Note that all previously added rings are removed from the list prior to adding these rings but only after validating the linear rings array.

Parameters:

rings - set linear rings list to this array.

Returns:

this Builder instance.

Throws:

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

See Also:

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