Id.java

  1. /*
  2.  * *********************************************************************************************************************
  3.  *
  4.  * TheseFoolishThings: Miscellaneous utilities
  5.  * http://tidalwave.it/projects/thesefoolishthings
  6.  *
  7.  * Copyright (C) 2009 - 2023 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
  12.  * the License. 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
  17.  * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the License for the
  18.  * specific language governing permissions and limitations under the License.
  19.  *
  20.  * *********************************************************************************************************************
  21.  *
  22.  * git clone https://bitbucket.org/tidalwave/thesefoolishthings-src
  23.  * git clone https://github.com/tidalwave-it/thesefoolishthings-src
  24.  *
  25.  * *********************************************************************************************************************
  26.  */
  27. package it.tidalwave.util;

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

  46.     @Nonnull
  47.     private final Object value;

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

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

  71.     /*******************************************************************************************************************
  72.      *
  73.      * {@inheritDoc}
  74.      *
  75.      ******************************************************************************************************************/
  76.     @Override @Nonnull
  77.     public String stringValue()
  78.       {
  79.         return (value instanceof StringValue) ? ((StringValue)value).stringValue() : value.toString();
  80.       }

  81.     /*******************************************************************************************************************
  82.      *
  83.      * {@inheritDoc}
  84.      *
  85.      ******************************************************************************************************************/
  86. //    @Override
  87.     public int compareTo (final Id other)
  88.       {
  89.         return stringValue().compareTo(other.stringValue());
  90.       }

  91.     /*******************************************************************************************************************
  92.      *
  93.      * {@inheritDoc}
  94.      *
  95.      ******************************************************************************************************************/
  96.     @Override @Nonnull
  97.     public String toString()
  98.       {
  99.         return stringValue();
  100.       }
  101.   }