Module de.powerstat.validation

Package de.powerstat.validation.values

Class BuildingName

java.lang.Object

de.powerstat.validation.values.BuildingName

All Implemented Interfaces:

IValueObject, Comparable<BuildingName>

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

Address Building name. Not DSGVO relevant.

Field Summary

Fields

Modifier and Type	Field	Description
private final String	buildingName	Building name.
private static final Pattern	BUILDNINGNAME_REGEXP	Building name regexp.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	BuildingName(String buildingName)	Constructor.

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Details

BUILDNINGNAME_REGEXP

private static final Pattern BUILDNINGNAME_REGEXP

Building name regexp.

buildingName

private final String buildingName

Building name.

Constructor Details

BuildingName

private BuildingName(String buildingName)

Constructor.

Parameters:

buildingName - Building name

Throws:

NullPointerException - if buildingName is null

IllegalArgumentException - if buildingName is not a correct building name

Method Details

of

public static BuildingName of(String buildingName)

BuildingName factory.

Parameters:

buildingName - Building name

Returns:

BuildingName object

stringValue

public String stringValue()

Returns the value of this BuildingName 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 BuildingName. The exact details of this representation are unspecified and subject to change, but the following may be regarded as typical: "BuildingName[buildingName=Rathaus]"

Overrides:

toString in class Object

Returns:

String representation of this BuildingName

See Also:

• Object.toString()

compareTo

public int compareTo(BuildingName obj)

Compare with another object.

Specified by:

compareTo in interface Comparable<BuildingName>

Parameters:

obj - Object to compare with

Returns:

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

See Also:

• Comparable.compareTo(java.lang.Object)