Skip to contentPackage: Id
Id
Coverage
1: /*
2: * *************************************************************************************************************************************************************
3: *
4: * TheseFoolishThings: Miscellaneous utilities
5: * http://tidalwave.it/projects/thesefoolishthings
6: *
7: * Copyright (C) 2009 - 2024 by Tidalwave s.a.s. (http://tidalwave.it)
8: *
9: * *************************************************************************************************************************************************************
10: *
11: * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
12: * You may obtain a copy of the License at
13: *
14: * http://www.apache.org/licenses/LICENSE-2.0
15: *
16: * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
17: * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
18: *
19: * *************************************************************************************************************************************************************
20: *
21: * git clone https://bitbucket.org/tidalwave/thesefoolishthings-src
22: * git clone https://github.com/tidalwave-it/thesefoolishthings-src
23: *
24: * *************************************************************************************************************************************************************
25: */
26: package it.tidalwave.util;
27:
28: import javax.annotation.Nonnull;
29: import javax.annotation.concurrent.Immutable;
30: import java.util.UUID;
31: import java.io.Serializable;
32: import lombok.EqualsAndHashCode;
33: import lombok.RequiredArgsConstructor;
34:
35: /***************************************************************************************************************************************************************
36: *
37: * An opaque wrapper for identifiers.
38: *
39: * @author Fabrizio Giudici
40: * @it.tidalwave.javadoc.stable
41: *
42: **************************************************************************************************************************************************************/
43: @Immutable @RequiredArgsConstructor @EqualsAndHashCode
44: public class Id implements Serializable, Comparable<Id>, StringValue
45: {
46: private static final long serialVersionUID = 3309234234279593043L;
47:
48: @Nonnull
49: private final Object value;
50:
51: /***********************************************************************************************************************************************************
52: * @param value the id value
53: * @return the new instance
54: * @since 3.2-ALPHA-2
55: **********************************************************************************************************************************************************/
56: @Nonnull
57: public static Id of (@Nonnull final Object value)
58: {
59: return new Id(value);
60: }
61:
62: /***********************************************************************************************************************************************************
63: * @return the new instance
64: * @since 3.2-ALPHA-9
65: **********************************************************************************************************************************************************/
66: @Nonnull
67: public static Id ofUuid()
68: {
69: return of(UUID.randomUUID().toString());
70: }
71:
72: /***********************************************************************************************************************************************************
73: * {@inheritDoc}
74: **********************************************************************************************************************************************************/
75: @Override @Nonnull
76: public String stringValue()
77: {
78:• return (value instanceof StringValue) ? ((StringValue)value).stringValue() : value.toString();
79: }
80:
81: /***********************************************************************************************************************************************************
82: * {@inheritDoc}
83: **********************************************************************************************************************************************************/
84: // @Override
85: public int compareTo (final Id other)
86: {
87: return stringValue().compareTo(other.stringValue());
88: }
89:
90: /***********************************************************************************************************************************************************
91: * {@inheritDoc}
92: **********************************************************************************************************************************************************/
93: @Override @Nonnull
94: public String toString()
95: {
96: return stringValue();
97: }
98: }