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 final class	VeraCliArgParser.ExtensionConverter
static final class	VeraCliArgParser.FeatureConverter
static final class	VeraCliArgParser.FileValidator	JCommander parameter validator for File, see IParameterValidator.
static final class	VeraCliArgParser.FlavourConverter	JCommander parameter converter for PDFAFlavour, see IStringConverter and PDFAFlavour.byFlavourId(String).
static final class	VeraCliArgParser.FormatConverter	JCommander parameter converter for FormatOption, see IStringConverter and FormatOption.fromOption(String).

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ADD_LOGS
static final String	DEBUG
static final String	DEBUG_FLAG
static final String	DEFAULT_FLAVOUR
static final String	DEFAULT_FLAVOUR_FLAG
static final String	DISABLE_ERROR_MESSAGES
static final String	EXTENSIONS
static final String	EXTENSIONS_FLAG
static final String	EXTRACT
static final String	EXTRACT_FLAG
static final String	FIX_METADATA
static final String	FIX_METADATA_FOLDER
static final String	FIX_METADATA_PREFIX
static final String	FLAVOUR
static final String	FLAVOUR_FLAG
static final String	FORMAT
static final String	HELP
static final String	HELP_FLAG
static final String	LIST
static final String	LIST_FLAG
static final String	LOAD_PROFILE
static final String	LOAD_PROFILE_FLAG
static final String	LOG_LEVEL
static final String	MAX_FAILURES
static final String	MAX_FAILURES_DISPLAYED
static final String	NON_PDF_EXTENSION
static final String	NUMBER_OF_PROCESSES_FLAG
static final String	PASSED
static final String	PASSWORD
static final String	POLICY_FILE
static final String	PROFILES_WIKI
static final String	PROFILES_WIKI_FLAG
static final String	PROGRESS
static final String	RECURSE
static final String	RECURSE_FLAG
static final String	SERVER_MODE
static final String	SUCCESS
static final String	USE_CONFIG
static final String	VALID_OFF
static final String	VALID_OFF_FLAG
static final String	VERA_PATH_FLAG
static final String	VERBOSE
static final String	VERBOSE_FLAG
static final String	VERSION

Constructor Summary

Constructors

Constructor	Description
VeraCliArgParser()

Method Summary

Modifier and Type	Method	Description
boolean	addLogs()
VeraAppConfig	appConfig(VeraAppConfig base)
void	checkParametersCompatibility()
EnumSet<ExtensionObjectType>	extensions()
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 Details

HELP_FLAG

public static final String HELP_FLAG

See Also:

• Constant Field Values

HELP

public static final String HELP

See Also:

• Constant Field Values

VERSION

public static final String VERSION

See Also:

• Constant Field Values

FLAVOUR_FLAG

public static final String FLAVOUR_FLAG

See Also:

• Constant Field Values

FLAVOUR

public static final String FLAVOUR

See Also:

• Constant Field Values

DEFAULT_FLAVOUR_FLAG

public static final String DEFAULT_FLAVOUR_FLAG

See Also:

• Constant Field Values

DEFAULT_FLAVOUR

public static final String DEFAULT_FLAVOUR

See Also:

• Constant Field Values

SUCCESS

public static final String SUCCESS

See Also:

• Constant Field Values

PASSED

public static final String PASSED

See Also:

• Constant Field Values

LIST_FLAG

public static final String LIST_FLAG

See Also:

• Constant Field Values

LIST

public static final String LIST

See Also:

• Constant Field Values

LOAD_PROFILE_FLAG

public static final String LOAD_PROFILE_FLAG

See Also:

• Constant Field Values

LOAD_PROFILE

public static final String LOAD_PROFILE

See Also:

• Constant Field Values

EXTRACT_FLAG

public static final String EXTRACT_FLAG

See Also:

• Constant Field Values

EXTRACT

public static final String EXTRACT

See Also:

• Constant Field Values

EXTENSIONS_FLAG

public static final String EXTENSIONS_FLAG

See Also:

• Constant Field Values

EXTENSIONS

public static final String EXTENSIONS

See Also:

• Constant Field Values

FORMAT

public static final String FORMAT

See Also:

• Constant Field Values

RECURSE_FLAG

public static final String RECURSE_FLAG

See Also:

• Constant Field Values

RECURSE

public static final String RECURSE

See Also:

• Constant Field Values

SERVER_MODE

public static final String SERVER_MODE

See Also:

• Constant Field Values

VERBOSE_FLAG

public static final String VERBOSE_FLAG

See Also:

• Constant Field Values

VERBOSE

public static final String VERBOSE

See Also:

• Constant Field Values

DEBUG_FLAG

public static final String DEBUG_FLAG

See Also:

• Constant Field Values

DEBUG

public static final String DEBUG

See Also:

• Constant Field Values

MAX_FAILURES_DISPLAYED

public static final String MAX_FAILURES_DISPLAYED

See Also:

• Constant Field Values

MAX_FAILURES

public static final String MAX_FAILURES

See Also:

• Constant Field Values

FIX_METADATA

public static final String FIX_METADATA

See Also:

• Constant Field Values

FIX_METADATA_PREFIX

public static final String FIX_METADATA_PREFIX

See Also:

• Constant Field Values

FIX_METADATA_FOLDER

public static final String FIX_METADATA_FOLDER

See Also:

• Constant Field Values

NON_PDF_EXTENSION

public static final String NON_PDF_EXTENSION

See Also:

• Constant Field Values

POLICY_FILE

public static final String POLICY_FILE

See Also:

• Constant Field Values

ADD_LOGS

public static final String ADD_LOGS

See Also:

• Constant Field Values

DISABLE_ERROR_MESSAGES

public static final String DISABLE_ERROR_MESSAGES

See Also:

• Constant Field Values

PASSWORD

public static final String PASSWORD

See Also:

• Constant Field Values

LOG_LEVEL

public static final String LOG_LEVEL

See Also:

• Constant Field Values

PROGRESS

public static final String PROGRESS

See Also:

• Constant Field Values

PROFILES_WIKI_FLAG

public static final String PROFILES_WIKI_FLAG

See Also:

• Constant Field Values

PROFILES_WIKI

public static final String PROFILES_WIKI

See Also:

• Constant Field Values

VALID_OFF_FLAG

public static final String VALID_OFF_FLAG

See Also:

• Constant Field Values

VALID_OFF

public static final String VALID_OFF

See Also:

• Constant Field Values

NUMBER_OF_PROCESSES_FLAG

public static final String NUMBER_OF_PROCESSES_FLAG

See Also:

• Constant Field Values

VERA_PATH_FLAG

public static final String VERA_PATH_FLAG

See Also:

• Constant Field Values

USE_CONFIG

public static final String USE_CONFIG

See Also:

• Constant Field Values

Constructor Details

VeraCliArgParser

public VeraCliArgParser()

Method Details

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 xml (mrr) report

logPassed

public boolean logPassed()

Returns:

true if log passed checks requested

extractFeatures

public boolean extractFeatures()

Returns:

true if PDF Feature extraction requested

extensions

public EnumSet<ExtensionObjectType> extensions()

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()