Class PositiveNegativeRestriction

    • Field Detail

      • positive

        private final boolean positive
      • includeZero

        private final boolean includeZero
      • type

        private final java.lang.String type
      • range

        private final java.lang.String range
    • Constructor Detail

      • PositiveNegativeRestriction

        public PositiveNegativeRestriction​(boolean positive,
                                           boolean includeZero)
        Creates a new restriction
        Parameters:
        positive - Whether the value must be positive
        includeZero - Whether zero is included as a valid value
    • Method Detail

      • isValid

        protected boolean isValid​(java.lang.Object value)
      • getPreamble

        public java.lang.String getPreamble()
        Description copied from interface: HelpHint
        Gets the preamble text that should be included
        Specified by:
        getPreamble in interface HelpHint
        Returns:
        Preamble text
      • getFormat

        public HelpFormat getFormat()
        Description copied from interface: HelpHint
        Gets the format of the provided help information
        Specified by:
        getFormat in interface HelpHint
        Returns:
        Help format
      • numContentBlocks

        public int numContentBlocks()
        Description copied from interface: HelpHint
        Gets the number of content blocks provided

        Help generators should consult the HelpHint.getFormat() return value to determine how to format the content blocks but they are not required to do so

        Specified by:
        numContentBlocks in interface HelpHint
        Returns:
        Number of content blocks
      • getContentBlock

        public java.lang.String[] getContentBlock​(int blockNumber)
        Description copied from interface: HelpHint
        Gets the content block with the given number
        Specified by:
        getContentBlock in interface HelpHint
        Parameters:
        blockNumber - Block number
        Returns:
        Content Block