Module de.powerstat.validation

Package de.powerstat.validation.values

Class BuildingNr

java.lang.Object

de.powerstat.validation.values.BuildingNr

All Implemented Interfaces:

IValueObject, Comparable<BuildingNr>

public final class BuildingNr
extends Object
implements Comparable<BuildingNr>, IValueObject

Address Building number. Possibly DSGVO relevant. TODO optimize constructor/compareTo

Field Summary

Fields

Modifier and Type	Field	Description
private final String	buildingNr	Building number.
private static final Pattern	BUILDINGNR_REGEXP	Building nr regexp.
private static final int	MAX_KNOWN_BUILDING_NR	Maximum known building nr in the world.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	BuildingNr(String buildingNr)	Constructor.

Method Summary

Modifier and Type	Method	Description
int	compareTo(BuildingNr obj)	Compare with another object.
boolean	equals(Object obj)	Is equal with another object.
int	hashCode()	Calculate hash code.
static BuildingNr	of(String buildingNr)	BuildingNr factory.
String	stringValue()	Returns the value of this BuildingNr as a string.
String	toString()	Returns the string representation of this BuildingNr.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

BUILDINGNR_REGEXP

private static final Pattern BUILDINGNR_REGEXP

Building nr regexp.

MAX_KNOWN_BUILDING_NR

private static final int MAX_KNOWN_BUILDING_NR

Maximum known building nr in the world.

See Also:

• Constant Field Values

buildingNr

private final String buildingNr

Building number.

Constructor Details

BuildingNr

private BuildingNr(String buildingNr)

Constructor.

Parameters:

buildingNr - Building number

Throws:

NullPointerException - if buildingNr is null

IllegalArgumentException - if buildingNr is not an correct buildingNr

Method Details

of

public static BuildingNr of(String buildingNr)

BuildingNr factory.

Parameters:

buildingNr - Building number

Returns:

BuildingNr object

stringValue

public String stringValue()

Returns the value of this BuildingNr as a string.

Specified by:

stringValue in interface IValueObject

Returns:

The text value represented by this object after conversion to type string.

hashCode

public int hashCode()

Calculate hash code.

Overrides:

hashCode in class Object

Returns:

Hash

See Also:

• Object.hashCode()

equals

public boolean equals(Object obj)

Is equal with another object.

Overrides:

equals in class Object

Parameters:

obj - Object

Returns:

true when equal, false otherwise

See Also:

• Object.equals(java.lang.Object)

toString

public String toString()

Returns the string representation of this BuildingNr. The exact details of this representation are unspecified and subject to change, but the following may be regarded as typical: "BuildingNr[buildingNr=42]"

Overrides:

toString in class Object

Returns:

String representation of this BuildingNr

See Also:

• Object.toString()

compareTo

public int compareTo(BuildingNr obj)

Compare with another object.

Specified by:

compareTo in interface Comparable<BuildingNr>

Parameters:

obj - Object to compare with

Returns:

0: equal; 1: greater; -1: smaller

See Also:

• TODO optimize (do regexp in constructor)