001package com.pingidentity.arno.args;
002
003import com.unboundid.util.args.ArgumentException;
004import com.unboundid.util.args.FileArgument;
005
006public class FileArg {
007    public static final FileArgument get(final String name,
008                                         final Boolean required, final int max, final String description,
009                                         boolean fileMustExist, boolean parentMustExist, boolean mustBeFile,
010                                         boolean mustBeDirectory) throws ArgumentException {
011        return new FileArgument(null, name, required, max,
012                ArgumentConstraints.getPlaceHolder(name), description, fileMustExist,
013                parentMustExist, mustBeFile, mustBeDirectory);
014    }
015
016    public static final FileArgument get(final String name,
017                                         final Boolean required, final int max, final String description)
018            throws ArgumentException {
019        return new FileArgument(null, name, required, max,
020                ArgumentConstraints.getPlaceHolder(name), description);
021    }
022
023    public static final FileArgument getDir(final String name,
024                                            final Boolean required, final Boolean exists, final int max, final String description)
025            throws ArgumentException {
026        return get(name, required, max, description, exists, true, false, true);
027    }
028
029    public static final FileArgument getDirThatExists(final String name,
030                                                      final Boolean required, final int max, final String description)
031            throws ArgumentException {
032        return getDir(name, required, true, max, description);
033    }
034
035    public static final FileArgument getFile(final String name,
036                                             final Boolean required, final Boolean exists, final int max, final String description)
037            throws ArgumentException {
038        return get(name, required, max, description, exists, true, true, false);
039    }
040
041    public static final FileArgument getFileThatExists(final String name,
042                                                       final Boolean required, final int max, final String description)
043            throws ArgumentException {
044        return getFile(name, required, ArgumentConstraints.EXISTS, max, description);
045    }
046    public static final FileArgument getRequiredFileThatExists(final String name, final int max, final String description)
047            throws ArgumentException {
048        return getFileThatExists(name, ArgumentConstraints.REQUIRED, max, description);
049    }
050
051    public static final FileArgument getOptionalFileThatExists(final String name, final int max, final String description)
052            throws ArgumentException {
053        return getFileThatExists(name, ArgumentConstraints.OPTIONAL, max, description);
054    }
055
056    public static final FileArgument getOptionalSingleFileThatExists(final String name, final String description)
057            throws ArgumentException {
058        return getFileThatExists(name, ArgumentConstraints.OPTIONAL, ArgumentConstraints.UNIQUE, description);
059    }
060
061    public static final FileArgument getSingleDir(final String name,
062                                                  final Boolean required, final String description)
063            throws ArgumentException {
064        return get(name, required, ArgumentConstraints.UNIQUE, description);
065    }
066
067    public static final FileArgument getRequiredDir(final String name,
068                                                    final int max, final String description) throws ArgumentException {
069        return getDirThatExists(name, ArgumentConstraints.REQUIRED, max, description);
070    }
071
072    public static final FileArgument getRequiredSingleDir(final String name,
073                                                          final String description) throws ArgumentException {
074        return getRequiredDir(name, ArgumentConstraints.UNIQUE, description);
075    }
076
077    public static final FileArgument getOptionalDir(final String name,
078                                                    final int max, final String description) throws ArgumentException {
079        return get(name, ArgumentConstraints.OPTIONAL, max, description);
080    }
081
082    public static final FileArgument getOptionalSingleDir(final String name,
083                                                          final String description) throws ArgumentException {
084        return getOptionalDir(name, ArgumentConstraints.UNIQUE, description);
085    }
086
087}