Class BaseParser

java.lang.Object

org.apache.maven.cling.invoker.BaseParser

All Implemented Interfaces:

Parser

Direct Known Subclasses:

EncryptParser, MavenParser, ShellParser, UpgradeParser

public abstract class BaseParser
extends Object
implements Parser

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BaseParser.LocalContext

Constructor Summary

Constructors

Constructor	Description
BaseParser()

Method Summary

Modifier and Type	Method	Description
protected CIInfo	detectCI(BaseParser.LocalContext context)
protected void	failIfFileNotExists(BaseParser.LocalContext context, String fileName, String message)
protected Path	getCwd(BaseParser.LocalContext context)
protected Path	getInstallationDirectory(BaseParser.LocalContext context)
protected InvokerRequest	getInvokerRequest(BaseParser.LocalContext context)
protected Path	getRootDirectory(BaseParser.LocalContext context)
protected Path	getTopDirectory(BaseParser.LocalContext context)
protected Path	getUserHomeDirectory(BaseParser.LocalContext context)
protected void	mayOverrideDirectorySystemProperty(BaseParser.LocalContext context, String javaSystemPropertyKey, Path value)	This method is needed to "align" values used later on for interpolations and path calculations.
protected abstract Options	parseCliOptions(BaseParser.LocalContext context)
InvokerRequest	parseInvocation(ParserRequest parserRequest)	Parses the given ParserRequest to create an InvokerRequest.
protected Map<String,String>	populateSystemProperties(BaseParser.LocalContext context)
protected Map<String,String>	populateUserProperties(BaseParser.LocalContext context)
protected List<CoreExtensions>	readCoreExtensionsDescriptor(BaseParser.LocalContext context)	Important: This method must return list of CoreExtensions in precedence order.
protected List<CoreExtension>	readCoreExtensionsDescriptorFromFile(Path extensionsFile)
protected void	validate(BaseParser.LocalContext context)
protected List<CoreExtension>	validateCoreExtensionsDescriptorFromFile(Path extensionFile, List<CoreExtension> coreExtensions)

Methods inherited from class java.lang.Object

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

Constructor Details

BaseParser

public BaseParser()

Method Details

parseInvocation

public InvokerRequest parseInvocation(ParserRequest parserRequest)

Description copied from interface: Parser

Parses the given ParserRequest to create an InvokerRequest. This method does interpret tool arguments.

Specified by:

parseInvocation in interface Parser

Parameters:

parserRequest - the request containing all necessary information for parsing

Returns:

the parsed invoker request. Caller must start by checking InvokerRequest.parsingFailed() as if there are parser errors, this request may not be fully processed and should immediately be failed.

validate

protected void validate(BaseParser.LocalContext context)

failIfFileNotExists

protected void failIfFileNotExists(BaseParser.LocalContext context,
 String fileName,
 String message)

getInvokerRequest

protected InvokerRequest getInvokerRequest(BaseParser.LocalContext context)

getCwd

protected Path getCwd(BaseParser.LocalContext context)

getInstallationDirectory

protected Path getInstallationDirectory(BaseParser.LocalContext context)

getUserHomeDirectory

protected Path getUserHomeDirectory(BaseParser.LocalContext context)

mayOverrideDirectorySystemProperty

protected void mayOverrideDirectorySystemProperty(BaseParser.LocalContext context,
 String javaSystemPropertyKey,
 Path value)

This method is needed to "align" values used later on for interpolations and path calculations. We enforce "canonical" paths, so IF key and canonical path value disagree, let override it.

getTopDirectory

protected Path getTopDirectory(BaseParser.LocalContext context)

getRootDirectory

@Nullable
protected Path getRootDirectory(BaseParser.LocalContext context)

populateSystemProperties

protected Map<String,String> populateSystemProperties(BaseParser.LocalContext context)

populateUserProperties

protected Map<String,String> populateUserProperties(BaseParser.LocalContext context)

parseCliOptions

protected abstract Options parseCliOptions(BaseParser.LocalContext context)

readCoreExtensionsDescriptor

protected List<CoreExtensions> readCoreExtensionsDescriptor(BaseParser.LocalContext context)

Important: This method must return list of CoreExtensions in precedence order.

readCoreExtensionsDescriptorFromFile

protected List<CoreExtension> readCoreExtensionsDescriptorFromFile(Path extensionsFile)

validateCoreExtensionsDescriptorFromFile

protected List<CoreExtension> validateCoreExtensionsDescriptorFromFile(Path extensionFile,
 List<CoreExtension> coreExtensions)

detectCI

@Nullable
protected CIInfo detectCI(BaseParser.LocalContext context)