Class EnumDoc

    • Constructor Detail

    • Method Detail

      • getChannelCategory

        public ChannelCategory getChannelCategory()
        Description copied from interface: Doc
        Gets the ChannelCategory of the Channel of this Doc.
        Returns:
        the ChannelCategory
      • self

        protected EnumDoc self()
        Description copied from class: AbstractDoc
        Gets an instance of the correct subclass of myself.
        Specified by:
        self in class AbstractDoc<java.lang.Integer>
        Returns:
        myself
      • initialValue

        public EnumDoc initialValue​(OptionsEnum initialValue)
        Initial-Value. Default: none
        Parameters:
        initialValue -
        Returns:
        myself
      • getUndefinedOption

        public OptionsEnum getUndefinedOption()
        Gets the Undefined-Option, i.e. the default Option if the value has not been set.
        Returns:
        the Undefined-Option
      • getOption

        public OptionsEnum getOption​(java.lang.Integer value)
        Gets the OptionsEnum from the integer value.
        Parameters:
        value - the integer value of the option
        Returns:
        the OptionsEnum
      • getOptionString

        public java.lang.String getOptionString​(java.lang.Integer value)
        Gets the name of the Option or 'UNDEFINED' if there is no option with that value
        Parameters:
        value - the integer value of the Option
        Returns:
        the name of the Option as a String