This is an automated email from the ASF dual-hosted git repository. hboutemy pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/maven-doxia-book-renderer.git
commit 11e7afd64352f8c17bb4f32c13d02c8e4457902b Author: Herve Boutemy <[email protected]> AuthorDate: Sat Jun 2 22:10:15 2012 +0000 [DOXIATOOLS-37] use plexus java 5 annotations instead of old-style javadoc annotations git-svn-id: https://svn.apache.org/repos/asf/maven/doxia/doxia-tools/trunk@1345596 13f79535-47bb-0310-9956-ffa450edef68 --- pom.xml | 4 ++++ .../apache/maven/doxia/book/DefaultBookDoxia.java | 20 +++++++------------- .../book/services/indexer/DefaultBookIndexer.java | 9 ++++----- .../maven/doxia/book/services/io/DefaultBookIo.java | 8 ++++---- .../services/renderer/AbstractITextBookRenderer.java | 5 ++--- .../book/services/renderer/DocbookBookRenderer.java | 8 ++++---- .../book/services/renderer/LatexBookRenderer.java | 8 ++++---- .../book/services/renderer/PdfBookRenderer.java | 4 ++-- .../book/services/renderer/RtfBookRenderer.java | 4 ++-- .../book/services/renderer/XHtmlBookRenderer.java | 8 ++++---- .../book/services/renderer/XdocBookRenderer.java | 12 +++++------- .../services/validation/DefaultBookValidator.java | 4 ++-- 12 files changed, 44 insertions(+), 50 deletions(-) diff --git a/pom.xml b/pom.xml index eb274bc..891e0ff 100644 --- a/pom.xml +++ b/pom.xml @@ -96,6 +96,10 @@ under the License. <groupId>org.codehaus.plexus</groupId> <artifactId>plexus-utils</artifactId> </dependency> + <dependency> + <groupId>org.codehaus.plexus</groupId> + <artifactId>plexus-component-annotations</artifactId> + </dependency> <!-- test --> <dependency> diff --git a/src/main/java/org/apache/maven/doxia/book/DefaultBookDoxia.java b/src/main/java/org/apache/maven/doxia/book/DefaultBookDoxia.java index 02fb421..82730d1 100644 --- a/src/main/java/org/apache/maven/doxia/book/DefaultBookDoxia.java +++ b/src/main/java/org/apache/maven/doxia/book/DefaultBookDoxia.java @@ -26,6 +26,8 @@ import org.apache.maven.doxia.book.services.io.BookIo; import org.apache.maven.doxia.book.services.renderer.BookRenderer; import org.apache.maven.doxia.book.services.validation.BookValidator; import org.apache.maven.doxia.book.services.validation.ValidationResult; +import org.codehaus.plexus.component.annotations.Component; +import org.codehaus.plexus.component.annotations.Requirement; import org.codehaus.plexus.logging.AbstractLogEnabled; import java.io.File; @@ -40,30 +42,22 @@ import java.util.Set; * * @author <a href="mailto:[email protected]";>Trygve Laugstøl</a> * @version $Id$ - * @plexus.component */ +@Component( role = BookDoxia.class ) public class DefaultBookDoxia extends AbstractLogEnabled implements BookDoxia { - /** - * @plexus.requirement - */ + @Requirement private BookIo bookIo; - /** - * @plexus.requirement - */ + @Requirement private BookValidator bookValidator; - /** - * @plexus.requirement - */ + @Requirement private BookIndexer bookIndexer; - /** - * @plexus.requirement role="org.apache.maven.doxia.book.services.renderer.BookRenderer" - */ + @Requirement( role = BookRenderer.class ) private Map<String, BookRenderer> bookRenderers; // ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/maven/doxia/book/services/indexer/DefaultBookIndexer.java b/src/main/java/org/apache/maven/doxia/book/services/indexer/DefaultBookIndexer.java index 420859b..f29d02f 100644 --- a/src/main/java/org/apache/maven/doxia/book/services/indexer/DefaultBookIndexer.java +++ b/src/main/java/org/apache/maven/doxia/book/services/indexer/DefaultBookIndexer.java @@ -33,23 +33,22 @@ import org.apache.maven.doxia.index.IndexEntry; import org.apache.maven.doxia.index.IndexingSink; import org.apache.maven.doxia.parser.ParseException; import org.apache.maven.doxia.parser.manager.ParserNotFoundException; +import org.codehaus.plexus.component.annotations.Component; +import org.codehaus.plexus.component.annotations.Requirement; import org.codehaus.plexus.logging.AbstractLogEnabled; /** * Default implementation of BookIndexer. * - * @plexus.component - * * @author <a href="mailto:[email protected]";>Trygve Laugstøl</a> * @version $Id$ */ +@Component( role = BookIndexer.class ) public class DefaultBookIndexer extends AbstractLogEnabled implements BookIndexer { - /** - * @plexus.requirement - */ + @Requirement private Doxia doxia; // ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/maven/doxia/book/services/io/DefaultBookIo.java b/src/main/java/org/apache/maven/doxia/book/services/io/DefaultBookIo.java index 9509d1d..2b07935 100644 --- a/src/main/java/org/apache/maven/doxia/book/services/io/DefaultBookIo.java +++ b/src/main/java/org/apache/maven/doxia/book/services/io/DefaultBookIo.java @@ -28,6 +28,8 @@ import org.apache.maven.doxia.module.site.manager.SiteModuleManager; import org.codehaus.plexus.util.IOUtil; import org.codehaus.plexus.util.ReaderFactory; import org.codehaus.plexus.util.xml.pull.XmlPullParserException; +import org.codehaus.plexus.component.annotations.Component; +import org.codehaus.plexus.component.annotations.Requirement; import org.codehaus.plexus.logging.AbstractLogEnabled; import java.io.IOException; @@ -41,17 +43,15 @@ import java.util.List; /** * <p>DefaultBookIo class.</p> * - * @plexus.component * @author <a href="mailto:[email protected]";>Trygve Laugstøl</a> * @version $Id$ */ +@Component( role = BookIo.class ) public class DefaultBookIo extends AbstractLogEnabled implements BookIo { - /** - * @plexus.requirement - */ + @Requirement private SiteModuleManager siteModuleManager; // ----------------------------------------------------------------------- diff --git a/src/main/java/org/apache/maven/doxia/book/services/renderer/AbstractITextBookRenderer.java b/src/main/java/org/apache/maven/doxia/book/services/renderer/AbstractITextBookRenderer.java index 78e18ff..92a0304 100644 --- a/src/main/java/org/apache/maven/doxia/book/services/renderer/AbstractITextBookRenderer.java +++ b/src/main/java/org/apache/maven/doxia/book/services/renderer/AbstractITextBookRenderer.java @@ -37,6 +37,7 @@ import org.apache.maven.doxia.module.itext.ITextSinkFactory; import org.apache.maven.doxia.parser.ParseException; import org.apache.maven.doxia.parser.manager.ParserNotFoundException; import org.apache.maven.doxia.sink.Sink; +import org.codehaus.plexus.component.annotations.Requirement; import org.codehaus.plexus.logging.AbstractLogEnabled; import org.codehaus.plexus.util.IOUtil; import org.codehaus.plexus.util.ReaderFactory; @@ -55,9 +56,7 @@ public abstract class AbstractITextBookRenderer extends AbstractLogEnabled implements BookRenderer { - /** - * @plexus.requirement - */ + @Requirement private Doxia doxia; // ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/maven/doxia/book/services/renderer/DocbookBookRenderer.java b/src/main/java/org/apache/maven/doxia/book/services/renderer/DocbookBookRenderer.java index 0d86ebd..a4097d1 100644 --- a/src/main/java/org/apache/maven/doxia/book/services/renderer/DocbookBookRenderer.java +++ b/src/main/java/org/apache/maven/doxia/book/services/renderer/DocbookBookRenderer.java @@ -35,6 +35,8 @@ import org.apache.maven.doxia.book.services.renderer.docbook.DocBookBookSink; import org.apache.maven.doxia.parser.ParseException; import org.apache.maven.doxia.parser.manager.ParserNotFoundException; import org.apache.maven.doxia.sink.Sink; +import org.codehaus.plexus.component.annotations.Component; +import org.codehaus.plexus.component.annotations.Requirement; import org.codehaus.plexus.logging.AbstractLogEnabled; import org.codehaus.plexus.util.IOUtil; import org.codehaus.plexus.util.ReaderFactory; @@ -44,17 +46,15 @@ import org.codehaus.plexus.util.WriterFactory; /** * An implementation of <code>BookRenderer</code> for docbook * - * @plexus.component role-hint="doc-book" * @author Eric Redmond * @version $Id$ */ +@Component( role = BookRenderer.class, hint = "doc-book" ) public class DocbookBookRenderer extends AbstractLogEnabled implements BookRenderer { - /** - * @plexus.requirement - */ + @Requirement private Doxia doxia; // ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/maven/doxia/book/services/renderer/LatexBookRenderer.java b/src/main/java/org/apache/maven/doxia/book/services/renderer/LatexBookRenderer.java index 0c5b383..7b3b333 100644 --- a/src/main/java/org/apache/maven/doxia/book/services/renderer/LatexBookRenderer.java +++ b/src/main/java/org/apache/maven/doxia/book/services/renderer/LatexBookRenderer.java @@ -28,6 +28,8 @@ import org.apache.maven.doxia.book.model.Section; import org.apache.maven.doxia.parser.manager.ParserNotFoundException; import org.apache.maven.doxia.parser.ParseException; import org.apache.maven.doxia.Doxia; +import org.codehaus.plexus.component.annotations.Component; +import org.codehaus.plexus.component.annotations.Requirement; import org.codehaus.plexus.util.ReaderFactory; import org.codehaus.plexus.util.StringUtils; import org.codehaus.plexus.util.IOUtil; @@ -46,16 +48,14 @@ import java.util.HashMap; /** * <p>LatexBookRenderer class.</p> * - * @plexus.component role-hint="latex" * @author <a href="mailto:[email protected]";>Trygve Laugstøl</a> * @version $Id$ */ +@Component( role = BookRenderer.class, hint = "latex" ) public class LatexBookRenderer implements BookRenderer { - /** - * @plexus.requirement - */ + @Requirement private Doxia doxia; // ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/maven/doxia/book/services/renderer/PdfBookRenderer.java b/src/main/java/org/apache/maven/doxia/book/services/renderer/PdfBookRenderer.java index b6a1ae5..2d0e9b9 100644 --- a/src/main/java/org/apache/maven/doxia/book/services/renderer/PdfBookRenderer.java +++ b/src/main/java/org/apache/maven/doxia/book/services/renderer/PdfBookRenderer.java @@ -25,15 +25,15 @@ import java.io.FileOutputStream; import java.io.IOException; import org.apache.maven.doxia.module.itext.ITextUtil; +import org.codehaus.plexus.component.annotations.Component; /** * PDF book renderer with the <code>iText</code> framework. * - * @plexus.component role-hint="pdf" - * * @author <a href="mailto:[email protected]";>Vincent Siveton</a> * @version $Id$ */ +@Component( role = BookRenderer.class, hint = "pdf" ) public class PdfBookRenderer extends AbstractITextBookRenderer { diff --git a/src/main/java/org/apache/maven/doxia/book/services/renderer/RtfBookRenderer.java b/src/main/java/org/apache/maven/doxia/book/services/renderer/RtfBookRenderer.java index 0e60e13..2e6954d 100644 --- a/src/main/java/org/apache/maven/doxia/book/services/renderer/RtfBookRenderer.java +++ b/src/main/java/org/apache/maven/doxia/book/services/renderer/RtfBookRenderer.java @@ -25,15 +25,15 @@ import java.io.FileOutputStream; import java.io.IOException; import org.apache.maven.doxia.module.itext.ITextUtil; +import org.codehaus.plexus.component.annotations.Component; /** * RTF book renderer with the <code>iText</code> framework. * - * @plexus.component role-hint="rtf" - * * @author <a href="mailto:[email protected]";>Vincent Siveton</a> * @version $Id$ */ +@Component( role = BookRenderer.class, hint = "rtf" ) public class RtfBookRenderer extends AbstractITextBookRenderer { diff --git a/src/main/java/org/apache/maven/doxia/book/services/renderer/XHtmlBookRenderer.java b/src/main/java/org/apache/maven/doxia/book/services/renderer/XHtmlBookRenderer.java index ad6f585..f0b2f82 100644 --- a/src/main/java/org/apache/maven/doxia/book/services/renderer/XHtmlBookRenderer.java +++ b/src/main/java/org/apache/maven/doxia/book/services/renderer/XHtmlBookRenderer.java @@ -29,6 +29,8 @@ import org.apache.maven.doxia.book.services.renderer.xhtml.XhtmlBookSink; import org.apache.maven.doxia.sink.render.RenderingContext; import org.apache.maven.doxia.parser.manager.ParserNotFoundException; import org.apache.maven.doxia.parser.ParseException; +import org.codehaus.plexus.component.annotations.Component; +import org.codehaus.plexus.component.annotations.Requirement; import org.codehaus.plexus.logging.AbstractLogEnabled; import org.codehaus.plexus.util.IOUtil; import org.codehaus.plexus.util.ReaderFactory; @@ -43,17 +45,15 @@ import java.io.Writer; /** * <p>XHtmlBookRenderer class.</p> * - * @plexus.component role-hint="xhtml" * @author <a href="mailto:[email protected]";>Trygve Laugstøl</a> * @version $Id$ */ +@Component( role = BookRenderer.class, hint = "xhtml" ) public class XHtmlBookRenderer extends AbstractLogEnabled implements BookRenderer { - /** - * @plexus.requirement - */ + @Requirement private Doxia doxia; // ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/maven/doxia/book/services/renderer/XdocBookRenderer.java b/src/main/java/org/apache/maven/doxia/book/services/renderer/XdocBookRenderer.java index f5c6541..1be58f4 100644 --- a/src/main/java/org/apache/maven/doxia/book/services/renderer/XdocBookRenderer.java +++ b/src/main/java/org/apache/maven/doxia/book/services/renderer/XdocBookRenderer.java @@ -41,6 +41,8 @@ import org.apache.maven.doxia.module.xdoc.XdocSink; import org.apache.maven.doxia.parser.ParseException; import org.apache.maven.doxia.parser.manager.ParserNotFoundException; import org.apache.maven.doxia.util.HtmlTools; +import org.codehaus.plexus.component.annotations.Component; +import org.codehaus.plexus.component.annotations.Requirement; import org.codehaus.plexus.i18n.I18N; import org.codehaus.plexus.logging.AbstractLogEnabled; import org.codehaus.plexus.util.IOUtil; @@ -54,20 +56,16 @@ import org.codehaus.plexus.util.WriterFactory; * @author <a href="mailto:[email protected]";>Trygve Laugstøl</a> * @author <a href="mailto:[email protected]";>Vincent Siveton</a> * @version $Id$ - * @plexus.component role-hint="xdoc" */ +@Component( role = BookRenderer.class, hint = "xdoc" ) public class XdocBookRenderer extends AbstractLogEnabled implements BookRenderer { - /** - * @plexus.requirement - */ + @Requirement private Doxia doxia; - /** - * @plexus.requirement - */ + @Requirement private I18N i18n; // ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/maven/doxia/book/services/validation/DefaultBookValidator.java b/src/main/java/org/apache/maven/doxia/book/services/validation/DefaultBookValidator.java index 19a06ec..3ba4596 100644 --- a/src/main/java/org/apache/maven/doxia/book/services/validation/DefaultBookValidator.java +++ b/src/main/java/org/apache/maven/doxia/book/services/validation/DefaultBookValidator.java @@ -19,6 +19,7 @@ package org.apache.maven.doxia.book.services.validation; * under the License. */ +import org.codehaus.plexus.component.annotations.Component; import org.codehaus.plexus.logging.AbstractLogEnabled; import org.codehaus.plexus.util.StringUtils; import org.apache.maven.doxia.book.model.BookModel; @@ -27,11 +28,10 @@ import org.apache.maven.doxia.book.model.Chapter; /** * Default implementation of BookValidator. * - * @plexus.component - * * @author <a href="mailto:[email protected]";>Trygve Laugstøl</a> * @version $Id$ */ +@Component( role = BookValidator.class ) public class DefaultBookValidator extends AbstractLogEnabled implements BookValidator
