You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by be...@apache.org on 2011/02/12 00:31:17 UTC
svn commit: r1069983 -
/maven/maven-3/trunk/maven-core/src/main/java/org/apache/maven/eventspy/EventSpy.java
Author: bentmann
Date: Fri Feb 11 23:31:17 2011
New Revision: 1069983
URL: http://svn.apache.org/viewvc?rev=1069983&view=rev
Log:
o Extended API docs
Modified:
maven/maven-3/trunk/maven-core/src/main/java/org/apache/maven/eventspy/EventSpy.java
Modified: maven/maven-3/trunk/maven-core/src/main/java/org/apache/maven/eventspy/EventSpy.java
URL: http://svn.apache.org/viewvc/maven/maven-3/trunk/maven-core/src/main/java/org/apache/maven/eventspy/EventSpy.java?rev=1069983&r1=1069982&r2=1069983&view=diff
==============================================================================
--- maven/maven-3/trunk/maven-core/src/main/java/org/apache/maven/eventspy/EventSpy.java (original)
+++ maven/maven-3/trunk/maven-core/src/main/java/org/apache/maven/eventspy/EventSpy.java Fri Feb 11 23:31:17 2011
@@ -34,16 +34,42 @@ public interface EventSpy
interface Context
{
+ /**
+ * Gets key-value pairs providing information about the Maven runtime.
+ *
+ * @return The key-value pairs, never {@code null}.
+ */
Map<String, Object> getData();
}
+ /**
+ * Initializes the spy.
+ *
+ * @param context The event spy context, never {@code null}.
+ */
void init( Context context )
throws Exception;
+ /**
+ * Notifies the spy of some build event/operation.
+ *
+ * @param event The event, never {@@code null}.
+ * @see org.apache.maven.settings.building.SettingsBuildingRequest
+ * @see org.apache.maven.settings.building.SettingsBuildingResult
+ * @see org.apache.maven.execution.MavenExecutionRequest
+ * @see org.apache.maven.execution.MavenExecutionResult
+ * @see org.apache.maven.project.DependencyResolutionRequest
+ * @see org.apache.maven.project.DependencyResolutionResultt
+ * @see org.apache.maven.execution.ExecutionEvent
+ * @see org.sonatype.aether.RepositoryEvent
+ */
void onEvent( Object event )
throws Exception;
+ /**
+ * Notifies the spy of Maven's termination, allowing it to free any resources allocated by it.
+ */
void close()
throws Exception;
Re: svn commit: r1069983 - /maven/maven-3/trunk/maven-core/src/main/java/org/apache/maven/eventspy/EventSpy.java
Posted by Olivier Lamy <ol...@apache.org>.
Thanks !
--
Olivier
send from a mobile
Le 12 févr. 2011 00:31, <be...@apache.org> a écrit :
> Author: bentmann
> Date: Fri Feb 11 23:31:17 2011
> New Revision: 1069983
>
> URL: http://svn.apache.org/viewvc?rev=1069983&view=rev
> Log:
> o Extended API docs
>
> Modified:
>
maven/maven-3/trunk/maven-core/src/main/java/org/apache/maven/eventspy/EventSpy.java
>
> Modified:
maven/maven-3/trunk/maven-core/src/main/java/org/apache/maven/eventspy/EventSpy.java
> URL:
http://svn.apache.org/viewvc/maven/maven-3/trunk/maven-core/src/main/java/org/apache/maven/eventspy/EventSpy.java?rev=1069983&r1=1069982&r2=1069983&view=diff
>
==============================================================================
> ---
maven/maven-3/trunk/maven-core/src/main/java/org/apache/maven/eventspy/EventSpy.java
(original)
> +++
maven/maven-3/trunk/maven-core/src/main/java/org/apache/maven/eventspy/EventSpy.java
Fri Feb 11 23:31:17 2011
> @@ -34,16 +34,42 @@ public interface EventSpy
> interface Context
> {
>
> + /**
> + * Gets key-value pairs providing information about the Maven runtime.
> + *
> + * @return The key-value pairs, never {@code null}.
> + */
> Map<String, Object> getData();
>
> }
>
> + /**
> + * Initializes the spy.
> + *
> + * @param context The event spy context, never {@code null}.
> + */
> void init( Context context )
> throws Exception;
>
> + /**
> + * Notifies the spy of some build event/operation.
> + *
> + * @param event The event, never {@@code null}.
> + * @see org.apache.maven.settings.building.SettingsBuildingRequest
> + * @see org.apache.maven.settings.building.SettingsBuildingResult
> + * @see org.apache.maven.execution.MavenExecutionRequest
> + * @see org.apache.maven.execution.MavenExecutionResult
> + * @see org.apache.maven.project.DependencyResolutionRequest
> + * @see org.apache.maven.project.DependencyResolutionResultt
> + * @see org.apache.maven.execution.ExecutionEvent
> + * @see org.sonatype.aether.RepositoryEvent
> + */
> void onEvent( Object event )
> throws Exception;
>
> + /**
> + * Notifies the spy of Maven's termination, allowing it to free any
resources allocated by it.
> + */
> void close()
> throws Exception;
>
>
>