Index (IKE Maven Plugin Support 234 API)

A B C D E G H I M N P Q R S T V W
All Classes and Interfaces|All Packages|Serialized Form

A

AbstractGoalMojo - Class in network.ike.plugin.support: Common base class for IKE plugin mojos.
AbstractGoalMojo() - Constructor for class network.ike.plugin.support.AbstractGoalMojo: Default constructor — subclasses are instantiated by Maven's DI.

B

build() - Method in class network.ike.plugin.support.GoalReportBuilder: Render the accumulated body as a Markdown string.
bullet(String) - Method in class network.ike.plugin.support.GoalReportBuilder: Append a single bullet-list item (- text).

C

CandidateVersionResolver - Interface in network.ike.plugin.support.version: Resolves the available released versions of a Maven coordinate.
codeBlock(String, String) - Method in class network.ike.plugin.support.GoalReportBuilder: Append a fenced code block.
compare(String, String) - Method in class network.ike.plugin.support.version.MavenVersionComparator
confirm(String, boolean) - Method in class network.ike.plugin.support.ConsoleIkePrompter
confirm(String, boolean) - Method in interface network.ike.plugin.support.IkePrompter: Prompts for a yes/no confirmation.
confirm(String, boolean) - Method in class network.ike.plugin.support.ScriptedIkePrompter
ConsoleIkePrompter - Class in network.ike.plugin.support: Environment-aware IkePrompter (IKE-Network/ike-issues#385).
ConsoleIkePrompter(Log, boolean) - Constructor for class network.ike.plugin.support.ConsoleIkePrompter: Creates a prompter.
content() - Method in record class network.ike.plugin.support.GoalReportSpec: Returns the value of the content record component.

D

description() - Method in interface network.ike.plugin.support.GoalRef: One-line human description of what this goal does.

E

equals(Object) - Method in record class network.ike.plugin.support.GoalReportSpec: Indicates whether some other object is "equal to" this one.
execute() - Method in class network.ike.plugin.support.AbstractGoalMojo: Run the goal and write its report.

G

getLog() - Method in class network.ike.plugin.support.AbstractGoalMojo: Access the Maven logger injected by Maven 4's plugin DI.
getPrompter() - Method in class network.ike.plugin.support.AbstractGoalMojo: The IkePrompter for this goal — built lazily from the session's interactive flag (IKE-Network/ike-issues#385).
getSession() - Method in class network.ike.plugin.support.AbstractGoalMojo: Access the Maven session injected by Maven 4's plugin DI.
goal() - Method in record class network.ike.plugin.support.GoalReportSpec: Returns the value of the goal record component.
goalName() - Method in interface network.ike.plugin.support.GoalRef: The bare goal name as it appears in the mojo's @Mojo(name = ...) annotation, e.g.
GoalRef - Interface in network.ike.plugin.support: Compile-time identifier for a goal exported by an IKE Maven plugin.
GoalReport - Class in network.ike.plugin.support: Per-goal report writer for IKE plugins.
GoalReportBuilder - Class in network.ike.plugin.support: Fluent builder for the body of an IKE goal report.
GoalReportBuilder() - Constructor for class network.ike.plugin.support.GoalReportBuilder: Creates an empty report-body builder.
GoalReportSpec - Record Class in network.ike.plugin.support: The report a goal produces — which goal it is, where its report file lands, and the Markdown body.
GoalReportSpec(GoalRef, Path, String) - Constructor for record class network.ike.plugin.support.GoalReportSpec: Creates an instance of a GoalReportSpec record class.

H

hashCode() - Method in record class network.ike.plugin.support.GoalReportSpec: Returns a hash code value for this object.

I

IkePrompter - Interface in network.ike.plugin.support: Interactive-prompt abstraction for IKE plugin goals (IKE-Network/ike-issues#385).
INSTANCE - Static variable in class network.ike.plugin.support.version.MavenVersionComparator: Shared instance.
isInteractive() - Method in class network.ike.plugin.support.ConsoleIkePrompter
isInteractive() - Method in interface network.ike.plugin.support.IkePrompter: Whether an interactive input channel is available.
isInteractive() - Method in class network.ike.plugin.support.ScriptedIkePrompter

M

MavenVersionComparator - Class in network.ike.plugin.support.version: Comparator that orders Maven version strings the same way Maven 4's DefaultArtifactVersion does — broadly: split on ./-/_/digit-letter transitions, compare numeric segments numerically, alpha segments lexicographically with a few well-known qualifier ranks (alpha < beta < milestone < rc < snapshot < (release) < sp).

N

network.ike.plugin.support - package network.ike.plugin.support
network.ike.plugin.support.version - package network.ike.plugin.support.version

P

paragraph(String) - Method in class network.ike.plugin.support.GoalReportBuilder: Append a paragraph followed by a blank line.
pluginPrefix() - Method in interface network.ike.plugin.support.GoalRef: The plugin prefix, e.g.
projectRoot() - Method in record class network.ike.plugin.support.GoalReportSpec: Returns the value of the projectRoot record component.
prompt(String) - Method in class network.ike.plugin.support.ConsoleIkePrompter
prompt(String) - Method in interface network.ike.plugin.support.IkePrompter: Prompts for a free-text line of input.
prompt(String) - Method in class network.ike.plugin.support.ScriptedIkePrompter

Q

qualified() - Method in interface network.ike.plugin.support.GoalRef: The fully-qualified goal invocation, e.g.

R

raw(String) - Method in class network.ike.plugin.support.GoalReportBuilder: Append a pre-rendered Markdown fragment verbatim — the escape hatch for content a primitive does not cover (e.g.
reportPath(Path, GoalRef) - Static method in class network.ike.plugin.support.GoalReport: Resolve the report file path for a specific goal.
resolveCandidates(String, String, String) - Method in interface network.ike.plugin.support.version.CandidateVersionResolver: Look up all known released versions of groupId:artifactId.
resolveCandidates(String, String, String) - Method in class network.ike.plugin.support.version.SessionCandidateVersionResolver
resolveHighestCandidate(String, String, String) - Method in interface network.ike.plugin.support.version.CandidateVersionResolver: Convenience: return the highest released candidate strictly newer than currentVersion, or null if there isn't one.
runGoal() - Method in class network.ike.plugin.support.AbstractGoalMojo: Run this goal's work and return the report it produced.

S

ScriptedIkePrompter - Class in network.ike.plugin.support: Deterministic IkePrompter that replays a fixed script of answers (IKE-Network/ike-issues#385).
ScriptedIkePrompter(String...) - Constructor for class network.ike.plugin.support.ScriptedIkePrompter: Creates a prompter that replays the given answers in order.
section(String) - Method in class network.ike.plugin.support.GoalReportBuilder: Append a section heading (## title).
select(String, List) - Method in class network.ike.plugin.support.ConsoleIkePrompter
select(String, List) - Method in interface network.ike.plugin.support.IkePrompter: Prompts for a numbered selection from a list.
select(String, List) - Method in class network.ike.plugin.support.ScriptedIkePrompter
SessionCandidateVersionResolver - Class in network.ike.plugin.support.version: CandidateVersionResolver backed by the Maven 4 VersionRangeResolver service.
SessionCandidateVersionResolver(Session) - Constructor for class network.ike.plugin.support.version.SessionCandidateVersionResolver: Build a resolver bound to a Maven session.

T

table(List, List) - Method in class network.ike.plugin.support.GoalReportBuilder: Append a GitHub-flavoured Markdown table.
toString() - Method in record class network.ike.plugin.support.GoalReportSpec: Returns a string representation of this record class.

V

VersionResolverFailureException - Exception Class in network.ike.plugin.support.version: Thrown when a CandidateVersionResolver cannot reach its backing repository or fails to resolve a coordinate.
VersionResolverFailureException(String, Throwable) - Constructor for exception class network.ike.plugin.support.version.VersionResolverFailureException: Construct with a message and underlying cause.

W

write(Path, GoalRef, String, Log) - Static method in class network.ike.plugin.support.GoalReport: Write a goal's report to its per-goal file at the project root, overwriting any previous content.

A B C D E G H I M N P Q R S T V W
All Classes and Interfaces|All Packages|Serialized Form