Annotation Type Path


  • @Retention(RUNTIME)
    @Target(FIELD)
    public @interface Path
    Annotation that marks that an options value must be a valid path to a file/directory
    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      boolean executable
      Gets/Sets whether the given file must be executable
      PathKind kind
      Gets/Sets the kind of file that is expected
      boolean mustExist
      Gets/Sets whether the given file must exist
      boolean readable
      Gets/Sets whether the given file must be readable
      boolean writable
      Gets/Sets whether the given file must be writable
    • Element Detail

      • mustExist

        boolean mustExist
        Gets/Sets whether the given file must exist
        Returns:
        True if it must exist, false otherwise
        Default:
        false
      • writable

        boolean writable
        Gets/Sets whether the given file must be writable
        Returns:
        True if must be writable, false otherwise
        Default:
        true
      • readable

        boolean readable
        Gets/Sets whether the given file must be readable
        Returns:
        True if must be readable, false otherwise
        Default:
        true
      • executable

        boolean executable
        Gets/Sets whether the given file must be executable
        Returns:
        True if must be executable, false otherwise
        Default:
        false
      • kind

        PathKind kind
        Gets/Sets the kind of file that is expected
        Returns:
        Expected file kind
        Default:
        com.github.rvesse.airline.annotations.restrictions.PathKind.ANY