Module de.powerstat.validation

Package de.powerstat.validation.values

Class Neighbourhood

java.lang.Object

de.powerstat.validation.values.Neighbourhood

All Implemented Interfaces:

IValueObject, Comparable<Neighbourhood>

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

Address Neighbourhood. Not DSGVO relevant.

Field Summary

Fields

Modifier and Type	Field	Description
private final String	neighbourhood	Neighbourhood.
private static final Pattern	NEIGHBOURHOOD_REGEXP	Neighbourhood fregexp.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Neighbourhood(String neighbourhood)	Constructor.

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Details

NEIGHBOURHOOD_REGEXP

private static final Pattern NEIGHBOURHOOD_REGEXP

Neighbourhood fregexp.

neighbourhood

private final String neighbourhood

Neighbourhood.

Constructor Details

Neighbourhood

private Neighbourhood(String neighbourhood)

Constructor.

Parameters:

neighbourhood - Neighbourhood

Throws:

NullPointerException - if neighbourhood is null

IllegalArgumentException - if neighbourhood is not a correct neighbourhood

Method Details

of

public static Neighbourhood of(String neighbourhood)

Neighbourhood factory.

Parameters:

neighbourhood - Neighbourhood

Returns:

Neighbourhood object

stringValue

public String stringValue()

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

Overrides:

toString in class Object

Returns:

String representation of this Neighbourhood

See Also:

• Object.toString()

compareTo

public int compareTo(Neighbourhood obj)

Compare with another object.

Specified by:

compareTo in interface Comparable<Neighbourhood>

Parameters:

obj - Object to compare with

Returns:

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

See Also:

• Comparable.compareTo(java.lang.Object)