Package de.espirit.firstspirit.access.editor.value

Interface Option

All Superinterfaces:
Comparable<Option>, Label
public interface Option extends Comparable<Option>, Label
Option is the persistence object for option based editors.

Note: Implementations must override equals() based on the textual key to operate correctly.

Since:
4.0.17
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getKey()
    Get a textual key of this option.
    Object
    getValue()
    Get the value of this option.
    boolean
    ignore(@NotNull Language language)
    Indicates whether this Option should be ignored and therefore hidden in the gui for the provided language.

    Methods inherited from interface java.lang.Comparable

    compareTo

    Methods inherited from interface de.espirit.firstspirit.access.editor.value.Label

    getLabel, getLabel, putLabel, putLabel

  • Method Details

    • getValue

      @ApiDoc(comment="Get the value of this option.", since="4.0.17") Object getValue()
      Get the value of this option.
      Returns:
      The option's value.
      Since:
      4.0.17

    • getKey

      @ApiDoc(comment="Get a textual key of this option.", since="4.0.17") String getKey()
      Get a textual key of this option.
      Returns:
      The option's key.
      Since:
      4.0.17

    • ignore

      @ApiDoc(comment="Indicates whether this Option should be ignored and therefore hidden in the gui for the provided language.", since="4.2.34") boolean ignore(@NotNull @NotNull Language language)
      Indicates whether this Option should be ignored and therefore hidden in the gui for the provided language.
      Parameters:
      language - the language to check the ignore flag against.
      Returns:
      true if this Option should be ignored for the given language, false otherwise.
      Since:
      4.2.34