Package io.github.duckasteroid.agentdocs.publish

Enum Class AgentDocsDistribution

java.lang.Object

java.lang.Enum<AgentDocsDistribution>

io.github.duckasteroid.agentdocs.publish.AgentDocsDistribution

All Implemented Interfaces:

Serializable, Comparable<AgentDocsDistribution>, Constable

public enum AgentDocsDistribution
extends Enum<AgentDocsDistribution>

Controls how a project's packaged agent docs are made discoverable to consumers.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
EMBEDDED	Copy the docs into the project's own jar (under a reserved resource path) and advertise them via an Agent-Docs: classpath manifest attribute.
SIDECAR	Package the docs as a separate agent-docs classifier zip attached to Maven publications (the original mechanism), and advertise their existence via an Agent-Docs: maven manifest attribute on the main jar.

Method Summary

Modifier and Type	Method	Description
static AgentDocsDistribution	valueOf(String name)	Returns the enum constant of this class with the specified name.
static AgentDocsDistribution[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

EMBEDDED

public static final AgentDocsDistribution EMBEDDED

Copy the docs into the project's own jar (under a reserved resource path) and advertise them via an Agent-Docs: classpath manifest attribute. No separate sidecar artifact is published; no Maven-coordinate resolution is required to discover them.

SIDECAR

public static final AgentDocsDistribution SIDECAR

Package the docs as a separate agent-docs classifier zip attached to Maven publications (the original mechanism), and advertise their existence via an Agent-Docs: maven manifest attribute on the main jar.

Method Details

values

public static AgentDocsDistribution[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static AgentDocsDistribution valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null