Class RangeRestriction

    • Field Detail

      • min

        private final java.lang.Object min
      • max

        private final java.lang.Object max
      • minInclusive

        private final boolean minInclusive
      • maxInclusive

        private final boolean maxInclusive
      • singleValue

        private final boolean singleValue
      • comparator

        private final java.util.Comparator<java.lang.Object> comparator
    • Constructor Detail

      • RangeRestriction

        public RangeRestriction​(java.lang.Object min,
                                boolean minInclusive,
                                java.lang.Object max,
                                boolean maxInclusive,
                                java.util.Comparator<java.lang.Object> comparator)
    • Method Detail

      • inRange

        protected boolean inRange​(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