Class PathRestriction

    • Field Detail

      • mustExist

        private final boolean mustExist
      • readable

        private final boolean readable
      • writable

        private final boolean writable
      • executable

        private final boolean executable
    • Constructor Detail

      • PathRestriction

        public PathRestriction​(boolean mustExist,
                               boolean readable,
                               boolean writable,
                               boolean executable,
                               PathKind kind)
        Creates a new path restriction
        Parameters:
        mustExist - Whether the path must exist
        readable - Whether the path must be readable, if the specific path does not exist then this check validates that the first parent in the path that exists is readable
        writable - Whether the path must be writable, if the specific path does not exist then this check validates that the first parent in the path that exists is writable
        executable - Whether the path must be executable, if the specific path does not exist then this check validates that the first parent in the path that exists is executable
        kind -
    • Method Detail

      • validate

        protected void validate​(java.lang.String title,
                                java.lang.String path)
      • notExecutable

        private void notExecutable​(java.lang.String title,
                                   java.lang.String path)
      • notWritable

        private void notWritable​(java.lang.String title,
                                 java.lang.String path)
      • notReadable

        private void notReadable​(java.lang.String title,
                                 java.lang.String path)
      • 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