Package org.apache.maven.api.cli

Class ParserRequest.Builder.ParserRequestImpl

java.lang.Object

org.apache.maven.api.cli.ParserRequest.Builder.ParserRequestImpl

All Implemented Interfaces:

ParserRequest

Enclosing class:

ParserRequest.Builder

private static class ParserRequest.Builder.ParserRequestImpl
extends Object
implements ParserRequest

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.maven.api.cli.ParserRequest

ParserRequest.Builder

Field Summary

Fields

Modifier and Type	Field	Description
private final List<String>	args
private final String	command
private final String	commandName
private final Path	cwd
private final OutputStream	err
private final InputStream	in
private final Logger	logger
private final Lookup	lookup
private final Path	mavenHome
private final MessageBuilderFactory	messageBuilderFactory
private final OutputStream	out
private final Path	userHome

Constructor Summary

Constructors

Modifier	Constructor	Description
private	ParserRequestImpl(String command, String commandName, List<String> args, Logger logger, MessageBuilderFactory messageBuilderFactory, Lookup lookup, Path cwd, Path mavenHome, Path userHome, InputStream in, OutputStream out, OutputStream err)

Method Summary

Modifier and Type	Method	Description
List<String>	args()	Returns the command-line arguments to be parsed.
String	command()	Returns the Maven command to be executed.
String	commandName()	Returns the Maven command name (ie "Maven").
Path	cwd()	Returns the current working directory for the Maven execution.
OutputStream	err()	Returns the error stream to be used for the Maven execution.
InputStream	in()	Returns the input stream to be used for the Maven execution.
Logger	logger()	Returns the logger to be used during the parsing process.
Lookup	lookup()	Per-request Lookup for customization.
Path	mavenHome()	Returns the Maven home directory.
MessageBuilderFactory	messageBuilderFactory()	Returns the factory for creating message builders.
OutputStream	out()	Returns the output stream to be used for the Maven execution.
Path	userHome()	Returns the user's home directory.

Methods inherited from class java.lang.Object

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

Field Details

command

private final String command

commandName

private final String commandName

logger

private final Logger logger

messageBuilderFactory

private final MessageBuilderFactory messageBuilderFactory

args

private final List<String> args

lookup

private final Lookup lookup

cwd

private final Path cwd

mavenHome

private final Path mavenHome

userHome

private final Path userHome

in

private final InputStream in

out

private final OutputStream out

err

private final OutputStream err

Constructor Details

ParserRequestImpl

private ParserRequestImpl(String command,
 String commandName,
 List<String> args,
 Logger logger,
 MessageBuilderFactory messageBuilderFactory,
 Lookup lookup,
 Path cwd,
 Path mavenHome,
 Path userHome,
 InputStream in,
 OutputStream out,
 OutputStream err)

Method Details

command

public String command()

Description copied from interface: ParserRequest

Returns the Maven command to be executed. This command is used in some invokers (ie forked) but also to present help to user.

Specified by:

command in interface ParserRequest

Returns:

the command string

commandName

public String commandName()

Description copied from interface: ParserRequest

Returns the Maven command name (ie "Maven"). This string is used in some invokers to complete error messages.

Specified by:

commandName in interface ParserRequest

Returns:

the command (human) name

logger

public Logger logger()

Description copied from interface: ParserRequest

Returns the logger to be used during the parsing process.

Specified by:

logger in interface ParserRequest

Returns:

the logger instance

messageBuilderFactory

public MessageBuilderFactory messageBuilderFactory()

Description copied from interface: ParserRequest

Returns the factory for creating message builders.

Specified by:

messageBuilderFactory in interface ParserRequest

Returns:

the message builder factory

args

public List<String> args()

Description copied from interface: ParserRequest

Returns the command-line arguments to be parsed.

Specified by:

args in interface ParserRequest

Returns:

a list of argument strings

lookup

public Lookup lookup()

Description copied from interface: ParserRequest

Per-request Lookup for customization.

Specified by:

lookup in interface ParserRequest

Returns:

a lookup possibly with custom components

cwd

public Path cwd()

Description copied from interface: ParserRequest

Returns the current working directory for the Maven execution. If not explicitly set, this value will be detected during parsing.

Specified by:

cwd in interface ParserRequest

Returns:

the current working directory path, or null if not set

mavenHome

public Path mavenHome()

Description copied from interface: ParserRequest

Returns the Maven home directory. If not explicitly set, this value will be detected during parsing.

Specified by:

mavenHome in interface ParserRequest

Returns:

the Maven home directory path, or null if not set

userHome

public Path userHome()

Description copied from interface: ParserRequest

Returns the user's home directory. If not explicitly set, this value will be detected during parsing.

Specified by:

userHome in interface ParserRequest

Returns:

the user's home directory path, or null if not set

in

public InputStream in()

Description copied from interface: ParserRequest

Returns the input stream to be used for the Maven execution. If not set, System.in will be used by default.

Specified by:

in in interface ParserRequest

Returns:

the input stream, or null if not set

out

public OutputStream out()

Description copied from interface: ParserRequest

Returns the output stream to be used for the Maven execution. If not set, System.out will be used by default.

Specified by:

out in interface ParserRequest

Returns:

the output stream, or null if not set

err

public OutputStream err()

Description copied from interface: ParserRequest

Returns the error stream to be used for the Maven execution. If not set, System.err will be used by default.

Specified by:

err in interface ParserRequest

Returns:

the error stream, or null if not set