Package net.sf.eBusx.geo

Class BoundingBox.Builder

java.lang.Object

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

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

net.sf.eBusx.geo.BoundingBox.Builder

Enclosing class:

BoundingBox

public static final class BoundingBox.Builder
extends EField.Builder<BoundingBox>

A Builder instance is the only was to create a BoundingBox instance. The only way to obtain a Builder instance is via BoundingBox.builder(). Use the builder instance to set the bounding box latitude and longitude points and then call EMessageObject.Builder.build() to generate the bounding box instance.

It is recommended that a new builder instance be used for each new bounding box instance. Builder instance re-use is discouraged.

Field Summary

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

mTargetClass

Method Summary

Modifier and Type	Method	Description
protected BoundingBox	buildImpl()	Returns a new bounding box instance based on this builder's settings.
BoundingBox.Builder	maxLatitude(java.math.BigDecimal max)	Sets northern bounding box latitude.
BoundingBox.Builder	maxLongitude(java.math.BigDecimal max)	Sets eastern bounding box longitude.
BoundingBox.Builder	minLatitude(java.math.BigDecimal min)	Sets southern bounding box latitude.
BoundingBox.Builder	minLongitude(java.math.BigDecimal min)	Sets western bounding box longitude.
protected Validator	validate(Validator problems)	Checks if: all four bounding box points are set, minimum latitude ≤ maximum latitude, and minimum longitude ≤ maximum longitude.

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

validate

protected Validator validate(Validator problems)

Checks if:

1. all four bounding box points are set,
2. minimum latitude ≤ maximum latitude, and
3. minimum longitude ≤ maximum longitude.

Overrides:

validate in class EField.Builder<BoundingBox>

Parameters:

problems - add each detected problem to this validator.

Returns:

problem

See Also:

Validator

buildImpl

protected BoundingBox buildImpl()

Returns a new bounding box instance based on this builder's settings.

Specified by:

buildImpl in class EMessageObject.Builder<BoundingBox>

Returns:

new bounding box instance.

minLatitude

public BoundingBox.Builder minLatitude(java.math.BigDecimal min)

Sets southern bounding box latitude. Returns this Builder instance so that builder method calls can be chained.

Parameters:

min - southern or minimum latitude.

Returns:

this Builder instance.

Throws:

java.lang.NullPointerException - if min is null.

java.lang.IllegalArgumentException - if min < GeoObject.MIN_LATITUDE or > GeoObject.MAX_LATITUDE.

maxLatitude

public BoundingBox.Builder maxLatitude(java.math.BigDecimal max)

Sets northern bounding box latitude. Returns this Builder instance so that builder method calls can be chained.

Parameters:

max - northern or maximum latitude.

Returns:

this Builder instance.

Throws:

java.lang.NullPointerException - if max is null.

java.lang.IllegalArgumentException - if max < GeoObject.MIN_LATITUDE or > GeoObject.MAX_LATITUDE.

minLongitude

public BoundingBox.Builder minLongitude(java.math.BigDecimal min)

Sets western bounding box longitude. Returns this Builder instance so that builder method calls can be chained.

Parameters:

min - western or minimum latitude.

Returns:

this Builder instance.

Throws:

java.lang.NullPointerException - if min is null.

java.lang.IllegalArgumentException - if min < GeoObject.MIN_LONGITUDE or > GeoObject.MAX_LONGITUDE.

maxLongitude

public BoundingBox.Builder maxLongitude(java.math.BigDecimal max)

Sets eastern bounding box longitude. Returns this Builder instance so that builder method calls can be chained.

Parameters:

max - eastern or maximum latitude.

Returns:

this Builder instance.

Throws:

java.lang.NullPointerException - if max is null.

java.lang.IllegalArgumentException - if max < GeoObject.MIN_LONGITUDE or > GeoObject.MAX_LONGITUDE.