Class EnumFactory<E extends java.lang.Enum<E>>


  • public class EnumFactory<E extends java.lang.Enum<E>>
    extends java.lang.Object
    Enum Factory for managing mapping between Enum name and Enum label
    Author:
    dcaruana
    • Constructor Summary

      Constructors 
      Constructor Description
      EnumFactory​(java.lang.Class<E> enumClass)  
      EnumFactory​(java.lang.Class<E> enumClass, E defaultEnum)  
      EnumFactory​(java.lang.Class<E> enumClass, E defaultEnum, boolean caseSensitive)  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      E fromLabel​(java.lang.String label)
      Gets enum from label
      java.lang.Enum<E> getDefaultEnum()
      Gets the default enum
      java.lang.String getDefaultLabel()
      Gets the default label
      java.lang.String label​(E e)
      Gets the label for the specified enum
      E toEnum​(java.lang.String label)
      Gets enum from label NOTE: If specified label is invalid, the default enum is returned
      boolean validLabel​(java.lang.String label)
      Is valid label?
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • EnumFactory

        public EnumFactory​(java.lang.Class<E> enumClass)
      • EnumFactory

        public EnumFactory​(java.lang.Class<E> enumClass,
                           E defaultEnum)
      • EnumFactory

        public EnumFactory​(java.lang.Class<E> enumClass,
                           E defaultEnum,
                           boolean caseSensitive)
        Parameters:
        caseSensitive - case-sensitive lookup for Enum label
    • Method Detail

      • getDefaultEnum

        public java.lang.Enum<E> getDefaultEnum()
        Gets the default enum
        Returns:
        default enum (or null, if no default specified)
      • getDefaultLabel

        public java.lang.String getDefaultLabel()
        Gets the default label
        Returns:
        label of default enum (or null, if no default specified)
      • label

        public java.lang.String label​(E e)
        Gets the label for the specified enum
        Parameters:
        e - enum
        Returns:
        label (or null, if no label specified)
      • validLabel

        public boolean validLabel​(java.lang.String label)
        Is valid label?
        Parameters:
        label - String
        Returns:
        true => valid, false => does not exist for this enum
      • fromLabel

        public E fromLabel​(java.lang.String label)
        Gets enum from label
        Parameters:
        label - String
        Returns:
        enum (or null, if no enum has specified label)
      • toEnum

        public E toEnum​(java.lang.String label)
        Gets enum from label NOTE: If specified label is invalid, the default enum is returned
        Parameters:
        label - String
        Returns:
        enum (or default enum, if label is invalid)