Id.java

  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. import javax.annotation.Nonnull;
  28. import javax.annotation.concurrent.Immutable;
  29. import java.util.UUID;
  30. import java.io.Serializable;
  31. import lombok.EqualsAndHashCode;
  32. import lombok.RequiredArgsConstructor;

  33. /***************************************************************************************************************************************************************
  34.  *
  35.  * An opaque wrapper for identifiers.
  36.  *
  37.  * @author  Fabrizio Giudici
  38.  * @it.tidalwave.javadoc.stable
  39.  *
  40.  **************************************************************************************************************************************************************/
  41. @Immutable @RequiredArgsConstructor @EqualsAndHashCode
  42. public class Id implements Serializable, Comparable<Id>, StringValue
  43.   {
  44.     private static final long serialVersionUID = 3309234234279593043L;

  45.     @Nonnull
  46.     private final Object value;

  47.     /***********************************************************************************************************************************************************
  48.      * @param value   the id value
  49.      * @return        the new instance
  50.      * @since         3.2-ALPHA-2
  51.      **********************************************************************************************************************************************************/
  52.     @Nonnull
  53.     public static Id of (@Nonnull final Object value)
  54.       {
  55.         return new Id(value);
  56.       }

  57.     /***********************************************************************************************************************************************************
  58.      * @return        the new instance
  59.      * @since         3.2-ALPHA-9
  60.      **********************************************************************************************************************************************************/
  61.     @Nonnull
  62.     public static Id ofUuid()
  63.       {
  64.         return of(UUID.randomUUID().toString());
  65.       }

  66.     /***********************************************************************************************************************************************************
  67.      * {@inheritDoc}
  68.      **********************************************************************************************************************************************************/
  69.     @Override @Nonnull
  70.     public String stringValue()
  71.       {
  72.         return (value instanceof StringValue) ? ((StringValue)value).stringValue() : value.toString();
  73.       }

  74.     /***********************************************************************************************************************************************************
  75.      * {@inheritDoc}
  76.      **********************************************************************************************************************************************************/
  77. //    @Override
  78.     public int compareTo (final Id other)
  79.       {
  80.         return stringValue().compareTo(other.stringValue());
  81.       }

  82.     /***********************************************************************************************************************************************************
  83.      * {@inheritDoc}
  84.      **********************************************************************************************************************************************************/
  85.     @Override @Nonnull
  86.     public String toString()
  87.       {
  88.         return stringValue();
  89.       }
  90.   }