Modul de.zocher_regel.util
Package de.zocher_regel.util

Schnittstelle KeyAble

Alle bekannten Implementierungsklassen:
Cmd, PropertyEntry, UtilSetting
public interface KeyAble
UtilSetting can not be inherited because it is an enum. This interface circumvents this restriction.

  • Methodenübersicht

    Modifizierer und Typ
    Methode
    Beschreibung
    default boolean
    checkValueType(Object valueObject)
    Has the value given as parameter the type given be the default value?
    default Object
    getDefault()
    A typical implementation, e. g. enum UtilSetting, has a default value that defines the type of the value as well.
    default boolean
    isInvisible()
    A menu entry may be invisible.
    default String
    key()
    In case of Setting the key consists of the enum class name and the enum instance name.
    default String
    keyWithPlaceholders()
    Augment the key of the command by placeholdes for logging messages (e. g. "%1$s").
    default int
    msgParmsCount()
    A NLS logging message may have up to 4 parameters.
    default String
    name()
    The implementation, e. g. enum UtilSetting, has this method to return the name of the enum instance (e. g.

  • Methodendetails

    • checkValueType

      default boolean checkValueType(Object valueObject)
      Has the value given as parameter the type given be the default value?
      Parameter:
      valueObject - the value to be checked (effectively a String)
      Gibt zurück:
      if the value is correct

    • getDefault

      default Object getDefault()
      A typical implementation, e. g. enum UtilSetting, has a default value that defines the type of the value as well.
      Gibt zurück:
      the default value of the enum instance

    • name

      default String name()
      The implementation, e. g. enum UtilSetting, has this method to return the name of the enum instance (e. g. BeepLevel) without package name.
      Gibt zurück:
      the name

    • isInvisible

      default boolean isInvisible()
      A menu entry may be invisible.
      Gibt zurück:
      menu entry is invisible.

    • key

      default String key()
      In case of Setting the key consists of the enum class name and the enum instance name.
      Gibt zurück:
      the key (e. g. "de.zocher_regel.util.UtilSetting.BeepLevel")

    • keyWithPlaceholders

      default String keyWithPlaceholders()
      Augment the key of the command by placeholdes for logging messages (e. g. "%1$s"). The number of placeholders is given by the method msgParmsCount().
      Gibt zurück:
      Key with format string for NLS enabled logging messages. The may have up to 4 parameters.

    • msgParmsCount

      default int msgParmsCount()
      A NLS logging message may have up to 4 parameters.
      Gibt zurück:
      0 there are no parameters by default)