1 /*
2 * Copyright (C) 2020-2023 Dipl.-Inform. Kai Hofmann. All rights reserved!
3 */
4 package de.powerstat.validation.values;
5
6
7 import java.util.Objects;
8 import java.util.regex.Pattern;
9
10 import de.powerstat.validation.interfaces.IValueObject;
11
12
13 /**
14 * Address Neighbourhood.
15 *
16 * Not DSGVO relevant.
17 */
18 public final class Neighbourhood implements Comparable<Neighbourhood>, IValueObject
19 {
20 /* *
21 * Cache for singletons.
22 */
23 // private static final Map<String, Neighbourhood> CACHE = new WeakHashMap<>();
24
25 /**
26 * Neighbourhood fregexp.
27 */
28 private static final Pattern NEIGHBOURHOOD_REGEXP = Pattern.compile("^[\\p{L}][\\p{L}\\p{Digit}. -]*$"); //$NON-NLS-1$
29
30 /**
31 * Neighbourhood.
32 */
33 private final String neighbourhood;
34
35
36 /**
37 * Constructor.
38 *
39 * @param neighbourhood Neighbourhood
40 * @throws NullPointerException if neighbourhood is null
41 * @throws IllegalArgumentException if neighbourhood is not a correct neighbourhood
42 */
43 private Neighbourhood(final String neighbourhood)
44 {
45 super();
46 Objects.requireNonNull(neighbourhood, "neighbourhood"); //$NON-NLS-1$
47 if ((neighbourhood.length() < 1) || (neighbourhood.length() > 64))
48 {
49 throw new IllegalArgumentException("Neighbourhood with wrong length"); //$NON-NLS-1$
50 }
51 if (!Neighbourhood.NEIGHBOURHOOD_REGEXP.matcher(neighbourhood).matches())
52 {
53 throw new IllegalArgumentException("Neighbourhood with wrong format"); //$NON-NLS-1$
54 }
55 this.neighbourhood = neighbourhood;
56 }
57
58
59 /**
60 * Neighbourhood factory.
61 *
62 * @param neighbourhood Neighbourhood
63 * @return Neighbourhood object
64 */
65 public static Neighbourhood of(final String neighbourhood)
66 {
67 /*
68 synchronized (Neighbourhood.class)
69 {
70 Neighbourhood obj = Neighbourhood.CACHE.get(neighbourhood);
71 if (obj != null)
72 {
73 return obj;
74 }
75 obj = new Neighbourhood(neighbourhood);
76 Neighbourhood.CACHE.put(neighbourhood, obj);
77 return obj;
78 }
79 */
80 return new Neighbourhood(neighbourhood);
81 }
82
83
84 /**
85 * Returns the value of this Neighbourhood as a string.
86 *
87 * @return The text value represented by this object after conversion to type string.
88 */
89 @Override
90 public String stringValue()
91 {
92 return this.neighbourhood;
93 }
94
95
96 /**
97 * Calculate hash code.
98 *
99 * @return Hash
100 * @see java.lang.Object#hashCode()
101 */
102 @Override
103 public int hashCode()
104 {
105 return this.neighbourhood.hashCode();
106 }
107
108
109 /**
110 * Is equal with another object.
111 *
112 * @param obj Object
113 * @return true when equal, false otherwise
114 * @see java.lang.Object#equals(java.lang.Object)
115 */
116 @Override
117 public boolean equals(final Object obj)
118 {
119 if (this == obj)
120 {
121 return true;
122 }
123 if (!(obj instanceof Neighbourhood))
124 {
125 return false;
126 }
127 final Neighbourhood other = (Neighbourhood)obj;
128 return this.neighbourhood.equals(other.neighbourhood);
129 }
130
131
132 /**
133 * Returns the string representation of this Neighbourhood.
134 *
135 * The exact details of this representation are unspecified and subject to change, but the following may be regarded as typical:
136 *
137 * "Neighbourhood[neighbourhood=...]"
138 *
139 * @return String representation of this Neighbourhood
140 * @see java.lang.Object#toString()
141 */
142 @Override
143 public String toString()
144 {
145 final var builder = new StringBuilder(29);
146 builder.append("Neighbourhood[neighbourhood=").append(this.neighbourhood).append(']'); //$NON-NLS-1$
147 return builder.toString();
148 }
149
150
151 /**
152 * Compare with another object.
153 *
154 * @param obj Object to compare with
155 * @return 0: equal; 1: greater; -1: smaller
156 * @see java.lang.Comparable#compareTo(java.lang.Object)
157 */
158 @Override
159 public int compareTo(final Neighbourhood obj)
160 {
161 Objects.requireNonNull(obj, "obj"); //$NON-NLS-1$
162 return this.neighbourhood.compareTo(obj.neighbourhood);
163 }
164
165 }