Class Parameters

    • Constructor Detail

      • Parameters

        public Parameters()
    • Method Detail

      • getCorruptedCharacters

        public boolean getCorruptedCharacters()
      • setCorruptedCharacters

        public void setCorruptedCharacters​(boolean corruptedCharacters)
      • getCheckAllowedCharacters

        public boolean getCheckAllowedCharacters()
      • setCheckAllowedCharacters

        public void setCheckAllowedCharacters​(boolean checkAllowedCharacters)
      • getCheckCharacters

        public boolean getCheckCharacters()
      • setCheckCharacters

        public void setCheckCharacters​(boolean checkCharacters)
      • getCharset

        public String getCharset()
      • setCharset

        public void setCharset​(String charset)
      • getExtraCharsAllowed

        public String getExtraCharsAllowed()
      • setExtraCharsAllowed

        public void setExtraCharsAllowed​(String extraCharsAllowed)
      • reset

        public void reset()
        Description copied from class: StringParameters
        Reset this parameters object to its default values.

        Subclasses should override this method to set any initial values and instantiate any objects that require allocation. It is recommended that subclasses also call super.reset() in the override to ensure that the buffer is empty.

        Specified by:
        reset in interface IParameters
        Overrides:
        reset in class StringParameters
      • fromString

        public void fromString​(String data)
        Description copied from class: StringParameters
        Reset this parameters object to its default values and then load additional parameters from the provided data.

        Subclasses should not normally need to override this method unless they are maintaining complex values (eg, InlineCodeFinder) that require extra initialization as part of their parameter state.

        Specified by:
        fromString in interface IParameters
        Overrides:
        fromString in class StringParameters
        Parameters:
        data - the string holding the parameters. It must be formatted as the string generated by toString(). Line-breaks must be normalized to '\n'. It can also be null or empty, in such case the parameters are left with their current values. Use reset() to reset the parameters to their defaults.
      • toString

        public String toString()
        Description copied from class: StringParameters
        Serialize this parameters object to a string.

        Subclasses should not normally need to override this method unless they are maintaining complex values (eg, InlineCodeFinder) that require extra serialization as part of their parameter state.

        Specified by:
        toString in interface IParameters
        Overrides:
        toString in class StringParameters
        Returns:
        the string holding all the parameters.