.. java:import:: java.io Serializable

.. java:import:: java.util HashMap

EnumFinderAbst
==============

.. java:package:: ru.bitec.gs.automation.util
   :noindex:

@SuppressWarnings

.. java:type:: public abstract class EnumFinderAbst<K, E extends Enum<E>> implements Serializable

   Абстрактная реализация EnumFinderAbst.
   Позволяет ставить в соответствие перечислению любой ключ.
   Соответствие должно быть 1 к 1.

Constructors
------------

EnumFinderAbst
^^^^^^^^^^^^^^

.. java:constructor:: protected EnumFinderAbst(E[] valueArray)
   :outertype: EnumFinderAbst

   Конструктор для использования в большинстве случаев.

   :param valueArray: массив возможных значений перечисления.

EnumFinderAbst
^^^^^^^^^^^^^^

.. java:constructor:: protected EnumFinderAbst(HashMap<K, E> tEnumMap)
   :outertype: EnumFinderAbst

Methods
-------

get
^^^

.. java:method:: public E get(K k)
   :outertype: EnumFinderAbst

   Ищет экземпляр перечисления, соответствующего переданному ключу.

   :param k: ключ, по которому будем искать
   :return: найденное значение Enum`а. Если соответствие не было найдено, будет возвращён ``null``

getDef
^^^^^^

.. java:method:: public E getDef(K k, E defEnumValue)
   :outertype: EnumFinderAbst

   Ищет значение перечисления соответсвующего переданной строке.

   :param k: ключ, по которому
   :param defEnumValue: значение по умолчанию
   :return: найденное значение Enum'a. Если соответсвие не было найдено, будет возвращёно значение по умолчанияю

getKey
^^^^^^

.. java:method:: protected abstract K getKey(E enumInstance)
   :outertype: EnumFinderAbst

   Метод должен возвращать ключ, соответсвующий переданному элементу перечислений. Если ключом является строка,
   например строковое представление элемента перечисления, необходимо, что бы метод приводил результат к верхнему
   регистру, для обеспечения регистронезависимого поиска.

   :param enumInstance: Элемент перечисления
   :return: Ключ, соответсвующий значению перечисления.

prepareKey
^^^^^^^^^^

.. java:method:: protected K prepareKey(K k)
   :outertype: EnumFinderAbst

   Метод подготавливает ключ для поиска перечисления в карте соответсвий.
   Если ключом является строка, необходимо, что бы метод приводил результат к верхнему регистру, для
   обеспечения регистронезависимого поиска.

   :param k: ключ
   :return: Ключ, соответсвующий значению перечисления.