Package com.helger.base.id.factory

Class StringIDFactory

java.lang.Object
com.helger.base.id.factory.StringIDFactory
All Implemented Interfaces:
IBaseIDFactory, IIDFactory<String>, IStringIDFactory
Direct Known Subclasses:
StringIDFromGlobalIntIDFactory, StringIDFromGlobalLongIDFactory, StringIDFromGlobalPersistentIntIDFactory, StringIDFromGlobalPersistentLongIDFactory, StringIDFromIntIDFactory, StringIDFromLongIDFactory
public class StringIDFactory extends Object implements IStringIDFactory
An IStringIDFactory implementation that uses a constant prefix and an int supplied from GlobalIDFactory.getNewIntID() to create unique IDs.
Author:
Philip Helger

  • Constructor Details

    • StringIDFactory

      public StringIDFactory(@NonNull IStringIDFactory aBaseFactory)
      Constructor using the default prefix.
      Parameters:
      aBaseFactory - The base string ID factory to use. May not be null.

    • StringIDFactory

      public StringIDFactory(@NonNull String sPrefix, @NonNull IStringIDFactory aBaseFactory)
      Constructor with a custom prefix.
      Parameters:
      sPrefix - The prefix to prepend to each generated ID. May not be null.
      aBaseFactory - The base string ID factory to use. May not be null.

  • Method Details

    • getPrefix

      public @NonNull String getPrefix()
      Returns:
      The prefix used for all generated IDs. Never null.

    • getNewID

      public @NonNull String getNewID()
      Specified by:
      getNewID in interface IIDFactory<String>
      Returns:
      The new unique ID. May never be null.

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object