imporve javadoc for pre processor api

This commit is contained in:
Sebastian Sdorra
2012-06-27 15:26:39 +02:00
parent a030f93b3a
commit 0781b9a953
6 changed files with 28 additions and 17 deletions

View File

@@ -50,10 +50,10 @@ public interface ChangesetPreProcessor
{ {
/** /**
* Method description * Process the given changeset.
* *
* *
* @param changeset * @param changeset changeset to process
*/ */
public void process(Changeset changeset); public void process(Changeset changeset);
} }

View File

@@ -51,12 +51,12 @@ public interface ChangesetPreProcessorFactory
{ {
/** /**
* Method description * Create a new {@link ChangesetPreProcessor} for the given repository.
* *
* *
* @param repository * @param repository repository
* *
* @return * @return {@link ChangesetPreProcessor} for the given repository
*/ */
public ChangesetPreProcessor createPreProcessor(Repository repository); public ChangesetPreProcessor createPreProcessor(Repository repository);
} }

View File

@@ -38,6 +38,9 @@ package sonia.scm.repository;
import sonia.scm.plugin.ExtensionPoint; import sonia.scm.plugin.ExtensionPoint;
/** /**
* A pre processor for {@link FileObject} objects. A pre processor is able to
* modify the object before it is delivered to the user interface.
*
* TODO for 2.0 extends {@link PreProcessor} interface. * TODO for 2.0 extends {@link PreProcessor} interface.
* *
* @author Sebastian Sdorra * @author Sebastian Sdorra
@@ -48,10 +51,10 @@ public interface FileObjectPreProcessor
{ {
/** /**
* Method description * Process the given file object.
* *
* *
* @param fileObject * @param fileObject file object to process
*/ */
public void process(FileObject fileObject); public void process(FileObject fileObject);
} }

View File

@@ -38,6 +38,9 @@ package sonia.scm.repository;
import sonia.scm.plugin.ExtensionPoint; import sonia.scm.plugin.ExtensionPoint;
/** /**
* The FileObjectPreProcessorFactory create {@link FileObjectPreProcessor}
* objects for a specific repository.
*
* TODO for 2.0 extends {@link PreProcessorFactory} interface. * TODO for 2.0 extends {@link PreProcessorFactory} interface.
* *
* @author Sebastian Sdorra * @author Sebastian Sdorra
@@ -48,12 +51,12 @@ public interface FileObjectPreProcessorFactory
{ {
/** /**
* Method description * Create a new {@link FileObjectPreProcessor} for the given repository.
* *
* *
* @param repository * @param repository repository
* *
* @return * @return {@link FileObjectPreProcessor} for the given repository
*/ */
public FileObjectPreProcessor createPreProcessor(Repository repository); public FileObjectPreProcessor createPreProcessor(Repository repository);
} }

View File

@@ -33,20 +33,22 @@
package sonia.scm.repository; package sonia.scm.repository;
/** /**
* A pre processor is able to modify a object before it is delivered
* to the user interface.
* *
* @author Sebastian Sdorra * @author Sebastian Sdorra
* @since 1.17 * @since 1.17
* *
* @param <T> * @param <T> object type
*/ */
public interface PreProcessor<T> public interface PreProcessor<T>
{ {
/** /**
* Method description * Process the given object.
* *
* *
* @param item * @param item object to process
*/ */
public void process(T item); public void process(T item);
} }

View File

@@ -30,25 +30,28 @@
*/ */
package sonia.scm.repository; package sonia.scm.repository;
/** /**
* A pre processor factory creates a specific {@link PreProcessor} for
* the given repository.
* *
* @author Sebastian Sdorra * @author Sebastian Sdorra
* *
* @param <T> * @param <T> object type for the {@link PreProcessor}
* @since 1.17 * @since 1.17
*/ */
public interface PreProcessorFactory<T> public interface PreProcessorFactory<T>
{ {
/** /**
* Method description * Create a new {@link PreProcessor} for the given repository.
* *
* *
* @param repository * @param repository repository
* *
* @return * @return {@link PreProcessor} for the given repository
*/ */
public PreProcessor<T> createPreProcessor(Repository repository); public PreProcessor<T> createPreProcessor(Repository repository);
} }