Class UpgradeContext

java.lang.Object

org.apache.maven.cling.invoker.LookupContext

org.apache.maven.cling.invoker.mvnup.UpgradeContext

All Implemented Interfaces:

AutoCloseable

public class UpgradeContext
extends LookupContext

Field Summary

Fields

Modifier and Type	Field	Description
Map<String,Goal>	goals
List<org.jline.utils.AttributedString>	header
org.jline.reader.LineReader	reader
org.jline.utils.AttributedStyle	style

Fields inherited from class org.apache.maven.cling.invoker.LookupContext

buildEventListener, closeables, coloredOutput, containerCapsule, containerCapsuleManaged, cwd, effectiveSettings, effectiveToolchains, eventSpyDispatcher, installationDirectory, installationSettingsPath, interactive, invokerRequest, localRepositoryPath, logger, loggerFactory, loggerLevel, lookup, projectSettingsPath, protoSession, pushedUserProperties, slf4jConfiguration, terminal, userDirectory, userSettingsPath, writer

Constructor Summary

Constructors

Constructor	Description
UpgradeContext(InvokerRequest invokerRequest, UpgradeOptions upgradeOptions)

Method Summary

Modifier and Type	Method	Description
void	action(String message)	Logs a performed action with an arrow icon.
void	addInHeader(String text)
void	addInHeader(org.jline.utils.AttributedStyle style, String text)
void	debug(String message)	Logs a debug message with current indentation.
void	detail(String message)	Logs detailed information with a bullet point.
void	failure(String message)	Logs an error with an X icon.
void	indent()	Increases the indentation level for nested logging.
void	info(String message)	Logs an informational message with current indentation.
UpgradeOptions	options()	Gets the UpgradeOptions from the invoker request.
void	println()	Prints a new line.
void	setIndentString(String indentString)	Sets the indentation string to use (e.g., " ", " ", "\t").
void	success(String message)	Logs a successful operation with a checkmark icon.
void	unindent()	Decreases the indentation level for nested logging.
void	warning(String message)	Logs a warning with a warning icon.

Methods inherited from class org.apache.maven.cling.invoker.LookupContext

close, closeContainer, doCloseContainer

Methods inherited from class java.lang.Object

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

Field Details

goals

public Map<String,Goal> goals

header

public List<org.jline.utils.AttributedString> header

style

public org.jline.utils.AttributedStyle style

reader

public org.jline.reader.LineReader reader

Constructor Details

UpgradeContext

public UpgradeContext(InvokerRequest invokerRequest,
 UpgradeOptions upgradeOptions)

Method Details

addInHeader

public void addInHeader(String text)

addInHeader

public void addInHeader(org.jline.utils.AttributedStyle style,
 String text)

indent

public void indent()

Increases the indentation level for nested logging.

unindent

public void unindent()

Decreases the indentation level for nested logging.

setIndentString

public void setIndentString(String indentString)

Sets the indentation string to use (e.g., " ", " ", "\t").

info

public void info(String message)

Logs an informational message with current indentation.

debug

public void debug(String message)

Logs a debug message with current indentation.

println

public void println()

Prints a new line.

success

public void success(String message)

Logs a successful operation with a checkmark icon.

failure

public void failure(String message)

Logs an error with an X icon.

warning

public void warning(String message)

Logs a warning with a warning icon.

detail

public void detail(String message)

Logs detailed information with a bullet point.

action

public void action(String message)

Logs a performed action with an arrow icon.

options

@Nonnull
public UpgradeOptions options()

Gets the UpgradeOptions from the invoker request. This provides convenient access to upgrade-specific options without casting.

Overrides:

options in class LookupContext

Returns:

the UpgradeOptions