Package org.eclipse.aether

Class RepositoryEvent

java.lang.Object

org.eclipse.aether.RepositoryEvent

public final class RepositoryEvent
extends java.lang.Object

An event describing an action performed by the repository system. Note that events which indicate the end of an action like RepositoryEvent.EventType.ARTIFACT_RESOLVED are generally fired in both the success and the failure case. Use getException() to check whether an event denotes success or failure.

See Also:

RepositoryListener, RepositoryEvent.Builder

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RepositoryEvent.Builder	A builder to create events.
static class	RepositoryEvent.EventType	The type of the repository event.

Field Summary

Fields

Modifier and Type	Field	Description
private Artifact	artifact
private java.util.List<java.lang.Exception>	exceptions
private java.io.File	file
private Metadata	metadata
private ArtifactRepository	repository
private RepositorySystemSession	session
private RequestTrace	trace
private RepositoryEvent.EventType	type

Constructor Summary

Constructors

Constructor	Description
RepositoryEvent(RepositoryEvent.Builder builder)

Method Summary

Modifier and Type	Method	Description
Artifact	getArtifact()	Gets the artifact involved in the event (if any).
java.lang.Exception	getException()	Gets the exception that caused the event (if any).
java.util.List<java.lang.Exception>	getExceptions()	Gets the exceptions that caused the event (if any).
java.io.File	getFile()	Gets the file involved in the event (if any).
Metadata	getMetadata()	Gets the metadata involved in the event (if any).
ArtifactRepository	getRepository()	Gets the repository involved in the event (if any).
RepositorySystemSession	getSession()	Gets the repository system session during which the event occurred.
RequestTrace	getTrace()	Gets the trace information about the request during which the event occurred.
RepositoryEvent.EventType	getType()	Gets the type of the event.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

type

private final RepositoryEvent.EventType type

session

private final RepositorySystemSession session

artifact

private final Artifact artifact

metadata

private final Metadata metadata

repository

private final ArtifactRepository repository

file

private final java.io.File file

exceptions

private final java.util.List<java.lang.Exception> exceptions

trace

private final RequestTrace trace

Constructor Detail

RepositoryEvent

RepositoryEvent(RepositoryEvent.Builder builder)

Method Detail

getType

public RepositoryEvent.EventType getType()

Gets the type of the event.

Returns:

The type of the event, never null.

getSession

public RepositorySystemSession getSession()

Gets the repository system session during which the event occurred.

Returns:

The repository system session during which the event occurred, never null.

getArtifact

public Artifact getArtifact()

Gets the artifact involved in the event (if any).

Returns:

The involved artifact or null if none.

getMetadata

public Metadata getMetadata()

Gets the metadata involved in the event (if any).

Returns:

The involved metadata or null if none.

getFile

public java.io.File getFile()

Gets the file involved in the event (if any).

Returns:

The involved file or null if none.

getRepository

public ArtifactRepository getRepository()

Gets the repository involved in the event (if any).

Returns:

The involved repository or null if none.

getException

public java.lang.Exception getException()

Gets the exception that caused the event (if any). As a rule of thumb, an event accompanied by an exception indicates a failure of the corresponding action. If multiple exceptions occurred, this method returns the first exception.

Returns:

The exception or null if none.

getExceptions

public java.util.List<java.lang.Exception> getExceptions()

Gets the exceptions that caused the event (if any). As a rule of thumb, an event accompanied by exceptions indicates a failure of the corresponding action.

Returns:

The exceptions, never null.

getTrace

public RequestTrace getTrace()

Gets the trace information about the request during which the event occurred.

Returns:

The trace information or null if none.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object