org.verapdf.cli.commands

Class VeraCliArgParser

java.lang.Object

org.verapdf.cli.commands.VeraCliArgParser

public class VeraCliArgParser
extends Object

This class holds all command-line options used by VeraPDF application.

Author:

Timur Kamalov

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	VeraCliArgParser.FlavourConverter JCommander parameter converter for PDFAFlavour, see IStringConverter and PDFAFlavour#byFlavourId(String).
static class	VeraCliArgParser.FormatConverter JCommander parameter converter for FormatOption, see IStringConverter and FormatOption#fromOption(String).
static class	VeraCliArgParser.ProfileFileValidator JCommander parameter validator for File, see IParameterValidator.

Constructor Summary

Constructors

Constructor and Description
VeraCliArgParser()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	extractFeatures()
boolean	fixMetadata()
PDFAFlavour	getFlavour()
FormatOption	getFormat()
List<String>	getPdfPaths()
File	getProfileFile()
String	getProfilesWikiPath()
String	getReportFile()
String	getReportFolder()
boolean	isHelp()
boolean	isLoadingConfig()
boolean	isOverwriteReportFile()
boolean	isRecurse()
boolean	isVerbose()
boolean	listProfiles()
boolean	logPassed()
int	maxFailures()
int	maxFailuresDisplayed()
String	policyProfilePath()
String	prefix()
String	saveFolder()
boolean	showVersion()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

VeraCliArgParser

public VeraCliArgParser()

Method Detail

showVersion

public boolean showVersion()

Returns:

true if version information requested

listProfiles

public boolean listProfiles()

Returns:

true if list of supported profiles requested

isVerbose

public boolean isVerbose()

Returns:

true if to output failed rules to text output

maxFailuresDisplayed

public int maxFailuresDisplayed()

Returns:

maximum amount of failed checks displayed for each rule

maxFailures

public int maxFailures()

Returns:

maximum amount of failed checks

fixMetadata

public boolean fixMetadata()

Returns:

true if metadata fix is enabled

prefix

public String prefix()

Returns:

the prefix of the saved file

saveFolder

public String saveFolder()

Returns:

the folder to save the fixed file to

policyProfilePath

public String policyProfilePath()

Returns:

the policy profile path

isRecurse

public boolean isRecurse()

Returns:

true if to recursively process sub-dirs

isHelp

public boolean isHelp()

Returns:

true if help requested

getFormat

public FormatOption getFormat()

Returns:

true if verbose output requested

logPassed

public boolean logPassed()

Returns:

true if log passed checks requested

extractFeatures

public boolean extractFeatures()

Returns:

true if PDF Feature extraction requested

getFlavour

public PDFAFlavour getFlavour()

Returns:

the validation flavour string id

getProfileFile

public File getProfileFile()

Returns:

the File object for the validation profile

getPdfPaths

public List<String> getPdfPaths()

Returns:

the list of file paths

getProfilesWikiPath

public String getProfilesWikiPath()

Returns:

path to validation profiles wiki

isLoadingConfig

public boolean isLoadingConfig()

Returns:

true if config is loaded from default file

getReportFolder

public String getReportFolder()

Returns:

folder for reports

getReportFile

public String getReportFile()

Returns:

output file for report

isOverwriteReportFile

public boolean isOverwriteReportFile()

Returns:

true if existing result file must be overwritten