Package 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	Description
static class	VeraCliArgParser.FeatureConverter
static class	VeraCliArgParser.FileValidator	JCommander parameter validator for File, see IParameterValidator.
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).

Field Summary

Fields

Modifier and Type	Field	Description
static String	USE_CONFIG

Constructor Summary

Constructors

Constructor	Description
VeraCliArgParser()

Method Summary

Modifier and Type	Method	Description
boolean	addLogs()
VeraAppConfig	appConfig(VeraAppConfig base)
void	checkParametersCompatibility()
boolean	extractFeatures()
FeatureExtractorConfig	featureExtractorConfig()
MetadataFixerConfig	fixerConfig()
boolean	fixMetadata()
static List<String>	getBaseVeraPDFParameters(VeraCliArgParser cliArgParser)
PDFAFlavour	getDefaultFlavour()
PDFAFlavour	getFlavour()
FormatOption	getFormat()
Level	getLoggerLevel()
int	getLoggerLevel(Level level)
int	getLogLevel()
int	getNumberOfProcesses()
String	getPassword()
List<String>	getPdfPaths()
File	getPolicyFile()
String	getPolicyFileName()
File	getProfileFile()
String	getProfilesWikiPath()
boolean	getShowProgress()
File	getVeraCLIPath()
boolean	isDebug()
boolean	isDisableErrorMessages()
boolean	isHelp()
boolean	isMultiprocessing()
boolean	isPolicy()
boolean	isRecurse()
boolean	isServerMode()
boolean	isValidationOff()
boolean	isVerbose()
boolean	listProfiles()
boolean	logPassed()
int	maxFailures()
int	maxFailuresDisplayed()
boolean	nonPdfExt()
String	prefix()
ProcessorConfig	processorConfig(ProcessType procType, PluginsCollectionConfig plugConfig)
String	saveFolder()
void	setValuesFromConfig(ConfigManager configManager)
boolean	showVersion()
boolean	useConfig()
ValidatorConfig	validatorConfig()

Methods inherited from class java.lang.Object

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

Field Detail

USE_CONFIG

public static final String USE_CONFIG

See Also:

Constant Field Values

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

isDebug

public boolean isDebug()

Returns:

true if to output file names of all processed files

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

addLogs

public boolean addLogs()

Returns:

true if adding logs to xml report is enabled

getLogLevel

public int getLogLevel()

Returns:

logging level set by user: 0 - OFF 1 - SEVERE 2 - WARNING, SEVERE (default) 3 - CONFIG, INFO, WARNING, SEVERE 4 - ALL

getLoggerLevel

public Level getLoggerLevel()

getLoggerLevel

public int getLoggerLevel(Level level)

getShowProgress

public boolean getShowProgress()

Returns:

number of checks per which set by user:

prefix

public String prefix()

Returns:

the prefix of the saved file

saveFolder

public String saveFolder()

Returns:

the folder to save the fixed file to

nonPdfExt

public boolean nonPdfExt()

isRecurse

public boolean isRecurse()

Returns:

true if to recursively process sub-dirs

isServerMode

public boolean isServerMode()

Returns:

true if server mode enabled

isHelp

public boolean isHelp()

Returns:

true if help requested

getFormat

public FormatOption getFormat()

Returns:

format if policy file is not specified, otherwise ignore all report format settings and always use mrr report

logPassed

public boolean logPassed()

Returns:

true if log passed checks requested

extractFeatures

public boolean extractFeatures()

Returns:

true if PDF Feature extraction requested

getDefaultFlavour

public PDFAFlavour getDefaultFlavour()

getFlavour

public PDFAFlavour getFlavour()

Returns:

the validation flavour string id

getProfileFile

public File getProfileFile()

Returns:

the File object for the validation profile

getPolicyFile

public File getPolicyFile()

Returns:

the File object for the validation profile

isPolicy

public boolean isPolicy()

getPolicyFileName

public String getPolicyFileName()

getVeraCLIPath

public File getVeraCLIPath()

getNumberOfProcesses

public int getNumberOfProcesses()

useConfig

public boolean useConfig()

getPdfPaths

public List<String> getPdfPaths()

Returns:

the list of file paths

getProfilesWikiPath

public String getProfilesWikiPath()

Returns:

path to validation profiles wiki

isValidationOff

public boolean isValidationOff()

isDisableErrorMessages

public boolean isDisableErrorMessages()

getPassword

public String getPassword()

setValuesFromConfig

public void setValuesFromConfig(ConfigManager configManager)

isMultiprocessing

public boolean isMultiprocessing()

validatorConfig

public ValidatorConfig validatorConfig()

featureExtractorConfig

public FeatureExtractorConfig featureExtractorConfig()

fixerConfig

public MetadataFixerConfig fixerConfig()

appConfig

public VeraAppConfig appConfig(VeraAppConfig base)

processorConfig

public ProcessorConfig processorConfig(ProcessType procType,
                                       PluginsCollectionConfig plugConfig)
                                throws VeraPDFException

Throws:

VeraPDFException

getBaseVeraPDFParameters

public static List<String> getBaseVeraPDFParameters(VeraCliArgParser cliArgParser)

checkParametersCompatibility

public void checkParametersCompatibility()