Package org.apache.maven.cling.invoker

Class BaseParser

java.lang.Object

org.apache.maven.cling.invoker.BaseParser

All Implemented Interfaces:

Parser

Direct Known Subclasses:

EncryptParser, MavenParser

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 abstract Options	assembleOptions(List<Options> parsedOptions)
protected Path	getCwd(BaseParser.LocalContext context)
protected Path	getInstallationDirectory(BaseParser.LocalContext context)
protected abstract InvokerRequest	getInvokerRequest(BaseParser.LocalContext context)
protected List<String>	getJvmArguments(Path rootDirectory)
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 List<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<CoreExtension>	readCoreExtensionsDescriptor(BaseParser.LocalContext context)
protected List<CoreExtension>	readCoreExtensionsDescriptorFromFile(Path extensionsFile)

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)
                               throws ParserException,
IOException

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

Throws:

ParserException - if there's an error during parsing of the request

IOException - if there's an I/O error during the parsing process

getInvokerRequest

protected abstract InvokerRequest getInvokerRequest(BaseParser.LocalContext context)

getCwd

protected Path getCwd(BaseParser.LocalContext context)
               throws ParserException

Throws:

ParserException

getInstallationDirectory

protected Path getInstallationDirectory(BaseParser.LocalContext context)
                                 throws ParserException

Throws:

ParserException

getUserHomeDirectory

protected Path getUserHomeDirectory(BaseParser.LocalContext context)
                             throws ParserException

Throws:

ParserException

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)
                        throws ParserException

Throws:

ParserException

getRootDirectory

@Nullable
protected Path getRootDirectory(BaseParser.LocalContext context)
                         throws ParserException

Throws:

ParserException

populateSystemProperties

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

Throws:

ParserException

populateUserProperties

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

Throws:

ParserException

IOException

parseCliOptions

protected abstract List<Options> parseCliOptions(BaseParser.LocalContext context)
                                          throws ParserException,
IOException

Throws:

ParserException

IOException

assembleOptions

protected abstract Options assembleOptions(List<Options> parsedOptions)

readCoreExtensionsDescriptor

protected List<CoreExtension> readCoreExtensionsDescriptor(BaseParser.LocalContext context)
                                                    throws ParserException,
IOException

Throws:

ParserException

IOException

readCoreExtensionsDescriptorFromFile

protected List<CoreExtension> readCoreExtensionsDescriptorFromFile(Path extensionsFile)
                                                            throws ParserException,
IOException

Throws:

ParserException

IOException

getJvmArguments

protected List<String> getJvmArguments(Path rootDirectory)
                                throws ParserException

Throws:

ParserException