Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  /*
   * Licensed to the Apache Software Foundation (ASF) under one
   * or more contributor license agreements.  See the NOTICE file
   * distributed with this work for additional information
   * regarding copyright ownership.  The ASF licenses this file
   * to you under the Apache License, Version 2.0 (the
   * "License"); you may not use this file except in compliance
   * with the License.  You may obtain a copy of the License at
   *
  * http://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing,
  * software distributed under the License is distributed on an
  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  * KIND, either express or implied.  See the License for the
  * specific language governing permissions and limitations
  * under the License.
  */
 package net.sourceforge.argparse4j.impl.type;
 
 import java.io.File;
 
ArgumentType subclass for File type, using fluent style API. This object can convert path string to java.io.File object. The command-line programs traditionally accept the file path "-" as standard input. This object supports this when acceptSystemIn() is used. Also there are several convenient verification features such as checking readability or existence.
 
 public class FileArgumentType implements ArgumentType<File> {
 
     private boolean acceptSystemIn = false;
     private boolean verifyExists = false;
     private boolean verifyNotExists = false;
     private boolean verifyIsFile = false;
     private boolean verifyIsDirectory = false;
     private boolean verifyCanRead = false;
     private boolean verifyCanWrite = false;
     private boolean verifyCanWriteParent = false;
     private boolean verifyCanExecute = false;
     private boolean verifyIsAbsolute = false;
 
     public FileArgumentType() {
     }

    
If the argument is "-", accept it as standard input. If this method is used, all verification methods will be ignored.

Returns:
this
 
     public FileArgumentType acceptSystemIn() {
          = true;
         return this;
     }

    
Verifies that the specified path exists. If the verification fails, error will be reported.

Returns:
this
 
     public FileArgumentType verifyExists() {
          = true;
         return this;
     }

    
Verifies that the specified path does not exist. If the verification fails, error will be reported.

Returns:
this
 
     public FileArgumentType verifyNotExists() {
          = true;
         return this;
     }

    
Verifies that the specified path is a regular file. If the verification fails, error will be reported.

Returns:
this
 
     public FileArgumentType verifyIsFile() {
          = true;
         return this;
     }

    
Verifies that the specified path is a directory. If the verification fails, error will be reported.

Returns:
this
         = true;
        return this;
    }

    
Verifies that the specified path is readable. If the verification fails, error will be reported.

Returns:
this
    public FileArgumentType verifyCanRead() {
         = true;
        return this;
    }

    
Verifies that the specified path is writable. If the verification fails, error will be reported.

Returns:
this
    public FileArgumentType verifyCanWrite() {
         = true;
        return this;
    }

    
Verifies that the parent directory of the specified path is writable. If the verification fails, error will be reported.

Returns:
this
         = true;
        return this;
    }

    
Verifies that the specified path is executable. If the verification fails, error will be reported.

Returns:
this
         = true;
        return this;
    }

    
Verifies that the specified path is an absolute path. If the verification fails, error will be reported.

Returns:
this
         = true;
        return this;
    }
    @Override
    public File convert(ArgumentParser parserArgument argString value)
            throws ArgumentParserException {
        File file = new File(value);
        if ( && !isSystemIn(file)) {
            verifyIsAbsolute(parserargfile);
        }
        if ( && !isSystemIn(file)) {
            verifyExists(parserargfile);
        }
        if ( && !isSystemIn(file)) {
            verifyNotExists(parserargfile);
        }
        if ( && !isSystemIn(file)) {
            verifyIsFile(parserargfile);
        }
        if ( && !isSystemIn(file)) {
            verifyIsDirectory(parserargfile);
        }
        if ( && !isSystemIn(file)) {
            verifyCanRead(parserargfile);
        }
        if ( && !isSystemIn(file)) {
            verifyCanWrite(parserargfile);
        }
        if ( && !isSystemIn(file)) {
            verifyCanWriteParent(parserargfile);
        }
        if ( && !isSystemIn(file)) {
            verifyCanExecute(parserargfile);
        }
        return file;
    }
    private void verifyExists(ArgumentParser parserArgument argFile file)
            throws ArgumentParserException {
        if (!file.exists()) {
            throw new ArgumentParserException(String.format(
                    "File not found: '%s'"file), parserarg);
        }
    }
    private void verifyNotExists(ArgumentParser parserArgument argFile file)
            throws ArgumentParserException {
        if (file.exists()) {
            throw new ArgumentParserException(String.format("File found: '%s'",
                    file), parserarg);
        }
    }
    private void verifyIsFile(ArgumentParser parserArgument argFile file)
            throws ArgumentParserException {
        if (!file.isFile()) {
            throw new ArgumentParserException(String.format("Not a file: '%s'",
                    file), parserarg);
        }
    }
    private void verifyIsDirectory(ArgumentParser parserArgument arg,
            File filethrows ArgumentParserException {
        if (!file.isDirectory()) {
            throw new ArgumentParserException(String.format(
                    "Not a directory: '%s'"file), parserarg);
        }
    }
    private void verifyCanRead(ArgumentParser parserArgument argFile file)
            throws ArgumentParserException {
        if (!file.canRead()) {
            throw new ArgumentParserException(String.format(
                    "Insufficient permissions to read file: '%s'"file),
                    parserarg);
        }
    }
    private void verifyCanWrite(ArgumentParser parserArgument argFile file)
            throws ArgumentParserException {
        if (!file.canWrite()) {
            throw new ArgumentParserException(String.format(
                    "Insufficient permissions to write file: '%s'"file),
                    parserarg);
        }
    }
    private void verifyCanWriteParent(ArgumentParser parserArgument arg,
            File filethrows ArgumentParserException {
        File parent = file.getParentFile();
        if (parent == null || !parent.canWrite()) {
            throw new ArgumentParserException(String.format(
                    "Cannot write parent of file: '%s'"file), parserarg);
        }
    }
    private void verifyCanExecute(ArgumentParser parserArgument argFile file)
            throws ArgumentParserException {
        if (!file.canExecute()) {
            throw new ArgumentParserException(String.format(
                    "Insufficient permissions to execute file: '%s'"file),
                    parserarg);
        }
    }
    private void verifyIsAbsolute(ArgumentParser parserArgument argFile file)
            throws ArgumentParserException {
        if (!file.isAbsolute()) {
            throw new ArgumentParserException(String.format(
                    "Not an absolute file: '%s'"file), parserarg);
        }
    }
    private boolean isSystemIn(File file) {
        return  && file.getPath().equals("-");
    }
New to GrepCode? Check out our FAQ X