This is an automated email from the ASF dual-hosted git repository. slachiewicz pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/maven-doxia.git
commit 81f841b37c5722079ed633fec18a6b1db5e602a6 Author: Sylwester Lachiewicz <[email protected]> AuthorDate: Tue Nov 17 02:09:42 2026 +0000 Use System.lineSeparator(), @Override and try-with-resources --- .../java/org/apache/maven/doxia/DefaultDoxia.java | 2 ++ .../org/apache/maven/doxia/index/IndexEntry.java | 1 + .../org/apache/maven/doxia/macro/EchoMacro.java | 1 + .../doxia/macro/manager/DefaultMacroManager.java | 1 + .../maven/doxia/macro/snippet/SnippetMacro.java | 1 + .../org/apache/maven/doxia/macro/toc/TocMacro.java | 1 + .../apache/maven/doxia/parser/AbstractParser.java | 3 ++ .../maven/doxia/parser/AbstractXmlParser.java | 2 ++ .../maven/doxia/parser/Xhtml5BaseParser.java | 2 ++ .../doxia/parser/manager/DefaultParserManager.java | 1 + .../doxia/parser/module/AbstractParserModule.java | 3 ++ .../parser/module/DefaultParserModuleManager.java | 2 ++ .../doxia/sink/impl/AbstractTextSinkFactory.java | 4 +++ .../apache/maven/doxia/sink/impl/PipelineSink.java | 1 + .../maven/doxia/sink/impl/RandomAccessSink.java | 2 ++ .../maven/doxia/sink/impl/Xhtml5BaseSink.java | 1 + .../maven/doxia/util/ByLineReaderSource.java | 6 ++++ .../maven/doxia/sink/impl/AbstractXmlSinkTest.java | 1 + .../doxia/sink/impl/RandomAccessSinkTest.java | 2 ++ .../maven/doxia/xsd/AbstractXmlValidatorTest.java | 2 ++ .../apache/maven/doxia/module/apt/AptParser.java | 24 ++++++++++++++ .../maven/doxia/module/apt/AptReaderSource.java | 3 ++ .../org/apache/maven/doxia/module/apt/AptSink.java | 37 ++++++++++++++++++++++ .../apache/maven/doxia/module/apt/AptSinkTest.java | 1 + .../apache/maven/doxia/module/fml/FmlMarkup.java | 7 ++++ .../apache/maven/doxia/module/fml/FmlParser.java | 1 + .../maven/doxia/module/fml/FmlValidatorTest.java | 1 + .../maven/doxia/module/markdown/MarkdownSink.java | 2 ++ .../apache/maven/doxia/module/xdoc/XdocMarkup.java | 8 +++++ .../apache/maven/doxia/module/xdoc/XdocParser.java | 1 + .../apache/maven/doxia/module/xdoc/XdocSink.java | 11 +++++++ .../maven/doxia/module/xdoc/XdocSinkTest.java | 3 ++ .../module/xdoc/XdocSinkWithLanguageIdTest.java | 2 ++ .../maven/doxia/module/xhtml5/Xhtml5Parser.java | 1 + .../maven/doxia/module/xhtml5/Xhtml5Sink.java | 6 ++++ .../maven/doxia/module/xhtml5/Xhtml5SinkTest.java | 1 + .../xhtml5/Xhtml5SinkWithLanguageIdTest.java | 2 ++ .../java/org/apache/maven/doxia/sink/Sink.java | 1 + .../maven/doxia/sink/SinkEventAttributeSet.java | 15 +++++++++ 39 files changed, 166 insertions(+) diff --git a/doxia-core/src/main/java/org/apache/maven/doxia/DefaultDoxia.java b/doxia-core/src/main/java/org/apache/maven/doxia/DefaultDoxia.java index 0c06d01d..69b6b453 100644 --- a/doxia-core/src/main/java/org/apache/maven/doxia/DefaultDoxia.java +++ b/doxia-core/src/main/java/org/apache/maven/doxia/DefaultDoxia.java @@ -49,6 +49,7 @@ public class DefaultDoxia implements Doxia { // which can probably be done away with. // ---------------------------------------------------------------------- + @Override public void parse(Reader source, String parserId, Sink sink) throws ParserNotFoundException, ParseException { this.parse(source, parserId, sink, null); } @@ -61,6 +62,7 @@ public class DefaultDoxia implements Doxia { parser.parse(source, sink, reference); } + @Override public Parser getParser(String parserId) throws ParserNotFoundException { return parserManager.getParser(parserId); } diff --git a/doxia-core/src/main/java/org/apache/maven/doxia/index/IndexEntry.java b/doxia-core/src/main/java/org/apache/maven/doxia/index/IndexEntry.java index faa0fe07..09b2263b 100644 --- a/doxia-core/src/main/java/org/apache/maven/doxia/index/IndexEntry.java +++ b/doxia-core/src/main/java/org/apache/maven/doxia/index/IndexEntry.java @@ -348,6 +348,7 @@ public class IndexEntry { * * @return Returns a string representation of all objects */ + @Override public String toString() { return toString(0); } diff --git a/doxia-core/src/main/java/org/apache/maven/doxia/macro/EchoMacro.java b/doxia-core/src/main/java/org/apache/maven/doxia/macro/EchoMacro.java index 09d77585..05368b86 100644 --- a/doxia-core/src/main/java/org/apache/maven/doxia/macro/EchoMacro.java +++ b/doxia-core/src/main/java/org/apache/maven/doxia/macro/EchoMacro.java @@ -29,6 +29,7 @@ import org.apache.maven.doxia.sink.Sink; @Singleton @Named("echo") public class EchoMacro extends AbstractMacro { + @Override public void execute(Sink sink, MacroRequest request) { sink.verbatim(); diff --git a/doxia-core/src/main/java/org/apache/maven/doxia/macro/manager/DefaultMacroManager.java b/doxia-core/src/main/java/org/apache/maven/doxia/macro/manager/DefaultMacroManager.java index da8d7c26..8e0b5634 100644 --- a/doxia-core/src/main/java/org/apache/maven/doxia/macro/manager/DefaultMacroManager.java +++ b/doxia-core/src/main/java/org/apache/maven/doxia/macro/manager/DefaultMacroManager.java @@ -39,6 +39,7 @@ public class DefaultMacroManager implements MacroManager { @Inject private Map<String, Macro> macros; + @Override public Macro getMacro(String id) throws MacroNotFoundException { Macro macro = macros.get(id); diff --git a/doxia-core/src/main/java/org/apache/maven/doxia/macro/snippet/SnippetMacro.java b/doxia-core/src/main/java/org/apache/maven/doxia/macro/snippet/SnippetMacro.java index ff66a76c..62786d74 100644 --- a/doxia-core/src/main/java/org/apache/maven/doxia/macro/snippet/SnippetMacro.java +++ b/doxia-core/src/main/java/org/apache/maven/doxia/macro/snippet/SnippetMacro.java @@ -72,6 +72,7 @@ public class SnippetMacro extends AbstractMacro { */ private boolean ignoreDownloadError = true; + @Override public void execute(Sink sink, MacroRequest request) throws MacroExecutionException { String id = (String) request.getParameter("id"); diff --git a/doxia-core/src/main/java/org/apache/maven/doxia/macro/toc/TocMacro.java b/doxia-core/src/main/java/org/apache/maven/doxia/macro/toc/TocMacro.java index e5ea7620..6183b224 100644 --- a/doxia-core/src/main/java/org/apache/maven/doxia/macro/toc/TocMacro.java +++ b/doxia-core/src/main/java/org/apache/maven/doxia/macro/toc/TocMacro.java @@ -91,6 +91,7 @@ public class TocMacro extends AbstractMacro { /** The default end depth. */ private static final int DEFAULT_DEPTH = 5; + @Override public void execute(Sink sink, MacroRequest request) throws MacroExecutionException { String source = request.getSourceContent(); Parser parser = request.getParser(); diff --git a/doxia-core/src/main/java/org/apache/maven/doxia/parser/AbstractParser.java b/doxia-core/src/main/java/org/apache/maven/doxia/parser/AbstractParser.java index 054aff0f..e8c6b524 100644 --- a/doxia-core/src/main/java/org/apache/maven/doxia/parser/AbstractParser.java +++ b/doxia-core/src/main/java/org/apache/maven/doxia/parser/AbstractParser.java @@ -102,10 +102,12 @@ public abstract class AbstractParser implements Parser, MacroExecutor { * * @return a int */ + @Override public int getType() { return UNKNOWN_TYPE; } + @Override public void setEmitComments(boolean emitComments) { this.emitComments = emitComments; } @@ -115,6 +117,7 @@ public abstract class AbstractParser implements Parser, MacroExecutor { * * @return a boolean */ + @Override public boolean isEmitComments() { return emitComments; } diff --git a/doxia-core/src/main/java/org/apache/maven/doxia/parser/AbstractXmlParser.java b/doxia-core/src/main/java/org/apache/maven/doxia/parser/AbstractXmlParser.java index 6d54d40c..ea8f1c2b 100644 --- a/doxia-core/src/main/java/org/apache/maven/doxia/parser/AbstractXmlParser.java +++ b/doxia-core/src/main/java/org/apache/maven/doxia/parser/AbstractXmlParser.java @@ -101,6 +101,7 @@ public abstract class AbstractXmlParser extends AbstractParser implements XmlMar */ private boolean addDefaultEntities = true; + @Override public void parse(Reader source, Sink sink, String reference) throws ParseException { init(); @@ -699,6 +700,7 @@ public abstract class AbstractXmlParser extends AbstractParser implements XmlMar WELL_KNOWN_SYSTEM_IDS.put("https://www.w3.org/TR/xhtml1/DTD/xhtml-lat1.ent", "xhtml-lat1.ent"); } + @Override public InputSource resolveEntity(String publicId, String systemId) throws SAXException, IOException { byte[] res = ENTITY_CACHE.get(systemId); // already cached? diff --git a/doxia-core/src/main/java/org/apache/maven/doxia/parser/Xhtml5BaseParser.java b/doxia-core/src/main/java/org/apache/maven/doxia/parser/Xhtml5BaseParser.java index 3828e701..6b80aa6d 100644 --- a/doxia-core/src/main/java/org/apache/maven/doxia/parser/Xhtml5BaseParser.java +++ b/doxia-core/src/main/java/org/apache/maven/doxia/parser/Xhtml5BaseParser.java @@ -691,6 +691,7 @@ public class Xhtml5BaseParser extends AbstractXmlParser implements HtmlMarkup { * Just calls {@link #baseStartTag(XmlPullParser,Sink)}, this should be * overridden by implementing parsers to include additional tags. */ + @Override protected void handleStartTag(XmlPullParser parser, Sink sink) throws XmlPullParserException, MacroExecutionException { if (!baseStartTag(parser, sink)) { @@ -708,6 +709,7 @@ public class Xhtml5BaseParser extends AbstractXmlParser implements HtmlMarkup { * Just calls {@link #baseEndTag(XmlPullParser,Sink)}, this should be * overridden by implementing parsers to include additional tags. */ + @Override protected void handleEndTag(XmlPullParser parser, Sink sink) throws XmlPullParserException, MacroExecutionException { if (!baseEndTag(parser, sink)) { diff --git a/doxia-core/src/main/java/org/apache/maven/doxia/parser/manager/DefaultParserManager.java b/doxia-core/src/main/java/org/apache/maven/doxia/parser/manager/DefaultParserManager.java index 0a23e16b..6821da72 100644 --- a/doxia-core/src/main/java/org/apache/maven/doxia/parser/manager/DefaultParserManager.java +++ b/doxia-core/src/main/java/org/apache/maven/doxia/parser/manager/DefaultParserManager.java @@ -39,6 +39,7 @@ public class DefaultParserManager implements ParserManager { @Inject private Map<String, Parser> parsers; + @Override public Parser getParser(String id) throws ParserNotFoundException { Parser parser = parsers.get(id); diff --git a/doxia-core/src/main/java/org/apache/maven/doxia/parser/module/AbstractParserModule.java b/doxia-core/src/main/java/org/apache/maven/doxia/parser/module/AbstractParserModule.java index 57a25fea..5f44433d 100644 --- a/doxia-core/src/main/java/org/apache/maven/doxia/parser/module/AbstractParserModule.java +++ b/doxia-core/src/main/java/org/apache/maven/doxia/parser/module/AbstractParserModule.java @@ -79,6 +79,7 @@ public abstract class AbstractParserModule implements ParserModule { * * @return a {@link java.lang.String} object. */ + @Override public String getSourceDirectory() { return sourceDirectory; } @@ -88,6 +89,7 @@ public abstract class AbstractParserModule implements ParserModule { * * @return an array of {@link java.lang.String} objects. */ + @Override public String[] getExtensions() { return extensions; } @@ -97,6 +99,7 @@ public abstract class AbstractParserModule implements ParserModule { * * @return a {@link java.lang.String} object. */ + @Override public String getParserId() { return parserId; } diff --git a/doxia-core/src/main/java/org/apache/maven/doxia/parser/module/DefaultParserModuleManager.java b/doxia-core/src/main/java/org/apache/maven/doxia/parser/module/DefaultParserModuleManager.java index b78cdf12..ed033511 100644 --- a/doxia-core/src/main/java/org/apache/maven/doxia/parser/module/DefaultParserModuleManager.java +++ b/doxia-core/src/main/java/org/apache/maven/doxia/parser/module/DefaultParserModuleManager.java @@ -45,6 +45,7 @@ public class DefaultParserModuleManager implements ParserModuleManager { * * @return a {@link java.util.Collection} object. */ + @Override public Collection<ParserModule> getParserModules() { if (parserModulesValues == null) { Map<Class<?>, ParserModule> parserModulesTmp = new LinkedHashMap<>(); @@ -57,6 +58,7 @@ public class DefaultParserModuleManager implements ParserModuleManager { return parserModulesValues; } + @Override public ParserModule getParserModule(String id) throws ParserModuleNotFoundException { ParserModule parserModule = parserModules.get(id); diff --git a/doxia-core/src/main/java/org/apache/maven/doxia/sink/impl/AbstractTextSinkFactory.java b/doxia-core/src/main/java/org/apache/maven/doxia/sink/impl/AbstractTextSinkFactory.java index 048bc5d9..7e0f9a6e 100644 --- a/doxia-core/src/main/java/org/apache/maven/doxia/sink/impl/AbstractTextSinkFactory.java +++ b/doxia-core/src/main/java/org/apache/maven/doxia/sink/impl/AbstractTextSinkFactory.java @@ -48,10 +48,12 @@ public abstract class AbstractTextSinkFactory implements SinkFactory { */ protected abstract Sink createSink(Writer writer, String encoding); + @Override public Sink createSink(File outputDir, String outputName) throws IOException { return createSink(outputDir, outputName, "UTF-8"); } + @Override public Sink createSink(File outputDir, String outputName, String encoding) throws IOException { Objects.requireNonNull(outputDir, "outputDir cannot be null"); @@ -67,10 +69,12 @@ public abstract class AbstractTextSinkFactory implements SinkFactory { return createSink(writer, encoding); } + @Override public Sink createSink(OutputStream out) throws IOException { return createSink(out, "UTF-8"); } + @Override public Sink createSink(OutputStream out, String encoding) throws IOException { return createSink(new OutputStreamWriter(out, encoding), encoding); } diff --git a/doxia-core/src/main/java/org/apache/maven/doxia/sink/impl/PipelineSink.java b/doxia-core/src/main/java/org/apache/maven/doxia/sink/impl/PipelineSink.java index b9a1bf7e..83846224 100644 --- a/doxia-core/src/main/java/org/apache/maven/doxia/sink/impl/PipelineSink.java +++ b/doxia-core/src/main/java/org/apache/maven/doxia/sink/impl/PipelineSink.java @@ -67,6 +67,7 @@ public class PipelineSink implements InvocationHandler { * @param args an array of {@link java.lang.Object} objects. * @return a {@link java.lang.Object} object. */ + @Override public Object invoke(Object proxy, Method method, Object[] args) throws IllegalAccessException, InvocationTargetException { for (Sink sink : pipeline) { diff --git a/doxia-core/src/main/java/org/apache/maven/doxia/sink/impl/RandomAccessSink.java b/doxia-core/src/main/java/org/apache/maven/doxia/sink/impl/RandomAccessSink.java index 33993714..b7d1cc1d 100644 --- a/doxia-core/src/main/java/org/apache/maven/doxia/sink/impl/RandomAccessSink.java +++ b/doxia-core/src/main/java/org/apache/maven/doxia/sink/impl/RandomAccessSink.java @@ -159,6 +159,7 @@ public class RandomAccessSink extends SinkWrapper { /** * Close all sinks */ + @Override public void close() { for (Sink sink : sinks) { // sink is responsible for closing it's stream @@ -170,6 +171,7 @@ public class RandomAccessSink extends SinkWrapper { /** * Flush all sinks */ + @Override public void flush() { for (int i = 0; i < sinks.size(); i++) { // first flush to get complete buffer diff --git a/doxia-core/src/main/java/org/apache/maven/doxia/sink/impl/Xhtml5BaseSink.java b/doxia-core/src/main/java/org/apache/maven/doxia/sink/impl/Xhtml5BaseSink.java index 3726725a..c8597bcc 100644 --- a/doxia-core/src/main/java/org/apache/maven/doxia/sink/impl/Xhtml5BaseSink.java +++ b/doxia-core/src/main/java/org/apache/maven/doxia/sink/impl/Xhtml5BaseSink.java @@ -1792,6 +1792,7 @@ public class Xhtml5BaseSink extends AbstractXmlSink implements HtmlMarkup { return compliantAttributes; } + @Override protected void write(String text) { if (!this.tableCaptionXMLWriterStack.isEmpty() && this.tableCaptionXMLWriterStack.getLast() != null) { this.tableCaptionXMLWriterStack.getLast().writeMarkup(unifyEOLs(text)); diff --git a/doxia-core/src/main/java/org/apache/maven/doxia/util/ByLineReaderSource.java b/doxia-core/src/main/java/org/apache/maven/doxia/util/ByLineReaderSource.java index c6449f59..21944caf 100644 --- a/doxia-core/src/main/java/org/apache/maven/doxia/util/ByLineReaderSource.java +++ b/doxia-core/src/main/java/org/apache/maven/doxia/util/ByLineReaderSource.java @@ -86,6 +86,7 @@ public class ByLineReaderSource implements ByLineSource { * @return a {@link java.lang.String} object. * @throws org.apache.maven.doxia.parser.ParseException if any. */ + @Override public final String getNextLine() throws ParseException { if (reader == null) { return null; @@ -120,6 +121,7 @@ public class ByLineReaderSource implements ByLineSource { * * @return a {@link java.lang.String} object. */ + @Override public final String getName() { return name; } @@ -129,6 +131,7 @@ public class ByLineReaderSource implements ByLineSource { * * @return a int. */ + @Override public final int getLineNumber() { return lineNumber; } @@ -136,6 +139,7 @@ public class ByLineReaderSource implements ByLineSource { /** * {@inheritDoc} */ + @Override public final void close() { if (reader == null) { return; @@ -152,6 +156,7 @@ public class ByLineReaderSource implements ByLineSource { /** * {@inheritDoc} */ + @Override public final void ungetLine() { if (ungetted) { throw new IllegalStateException("we support only one level of ungetLine()"); @@ -159,6 +164,7 @@ public class ByLineReaderSource implements ByLineSource { ungetted = true; } + @Override public final void unget(final String s) { Objects.requireNonNull(s, "s cannot be null"); diff --git a/doxia-core/src/test/java/org/apache/maven/doxia/sink/impl/AbstractXmlSinkTest.java b/doxia-core/src/test/java/org/apache/maven/doxia/sink/impl/AbstractXmlSinkTest.java index 8f196c30..f4911bd2 100644 --- a/doxia-core/src/test/java/org/apache/maven/doxia/sink/impl/AbstractXmlSinkTest.java +++ b/doxia-core/src/test/java/org/apache/maven/doxia/sink/impl/AbstractXmlSinkTest.java @@ -180,6 +180,7 @@ class AbstractXmlSinkTest { return text; } + @Override protected void write(String text) { buffer.append(text); } diff --git a/doxia-core/src/test/java/org/apache/maven/doxia/sink/impl/RandomAccessSinkTest.java b/doxia-core/src/test/java/org/apache/maven/doxia/sink/impl/RandomAccessSinkTest.java index 7046cfc9..145b5b14 100644 --- a/doxia-core/src/test/java/org/apache/maven/doxia/sink/impl/RandomAccessSinkTest.java +++ b/doxia-core/src/test/java/org/apache/maven/doxia/sink/impl/RandomAccessSinkTest.java @@ -32,10 +32,12 @@ import static org.junit.jupiter.api.Assertions.assertEquals; class RandomAccessSinkTest { private SinkFactory factory = new AbstractXmlSinkFactory() { + @Override protected Sink createSink(Writer writer, String encoding, String languageId) { return new TextSink(writer); } + @Override protected Sink createSink(Writer writer, String encoding) { return new TextSink(writer); } diff --git a/doxia-core/src/test/java/org/apache/maven/doxia/xsd/AbstractXmlValidatorTest.java b/doxia-core/src/test/java/org/apache/maven/doxia/xsd/AbstractXmlValidatorTest.java index 58c770a0..913007e7 100644 --- a/doxia-core/src/test/java/org/apache/maven/doxia/xsd/AbstractXmlValidatorTest.java +++ b/doxia-core/src/test/java/org/apache/maven/doxia/xsd/AbstractXmlValidatorTest.java @@ -74,6 +74,7 @@ public abstract class AbstractXmlValidatorTest extends AbstractXmlValidator { * @see #getIncludes() * @see #getAllTestDocuments() */ + @Override protected Map<String, String> getTestDocuments() throws IOException { if (getIncludes() == null) { return Collections.emptyMap(); @@ -101,6 +102,7 @@ public abstract class AbstractXmlValidatorTest extends AbstractXmlValidator { * * @since 1.2 */ + @Override protected EntityResolver getEntityResolver() { return new AbstractXmlParser.CachedFileEntityResolver(); } diff --git a/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptParser.java b/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptParser.java index 076026d3..1c6e76c8 100644 --- a/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptParser.java +++ b/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptParser.java @@ -1565,6 +1565,7 @@ public class AptParser extends AbstractTextParser implements AptMarkup { super(AptParser.LIST_BREAK, indent, firstLine); } + @Override public void traverse() throws AptParseException { throw new AptParseException("internal error: traversing list break"); } @@ -1583,6 +1584,7 @@ public class AptParser extends AbstractTextParser implements AptMarkup { super(TITLE, indent, firstLine); } + @Override public void traverse() throws AptParseException { StringTokenizer lines = new StringTokenizer(text, EOL); int separator = -1; @@ -1687,6 +1689,7 @@ public class AptParser extends AbstractTextParser implements AptMarkup { super(type, indent, firstLine); } + @Override public void traverse() throws AptParseException { Title(); traverseText(skipLeadingBullets()); @@ -1713,10 +1716,12 @@ public class AptParser extends AbstractTextParser implements AptMarkup { super(SECTION1, indent, firstLine); } + @Override public void Title() { AptParser.this.sink.sectionTitle1(); } + @Override public void Title_() { AptParser.this.sink.sectionTitle1_(); } @@ -1735,10 +1740,12 @@ public class AptParser extends AbstractTextParser implements AptMarkup { super(SECTION2, indent, firstLine); } + @Override public void Title() { AptParser.this.sink.sectionTitle2(); } + @Override public void Title_() { AptParser.this.sink.sectionTitle2_(); } @@ -1757,10 +1764,12 @@ public class AptParser extends AbstractTextParser implements AptMarkup { super(SECTION3, indent, firstLine); } + @Override public void Title() { AptParser.this.sink.sectionTitle3(); } + @Override public void Title_() { AptParser.this.sink.sectionTitle3_(); } @@ -1779,10 +1788,12 @@ public class AptParser extends AbstractTextParser implements AptMarkup { super(SECTION4, indent, firstLine); } + @Override public void Title() { AptParser.this.sink.sectionTitle4(); } + @Override public void Title_() { AptParser.this.sink.sectionTitle4_(); } @@ -1801,10 +1812,12 @@ public class AptParser extends AbstractTextParser implements AptMarkup { super(SECTION5, indent, firstLine); } + @Override public void Title() { AptParser.this.sink.sectionTitle5(); } + @Override public void Title_() { AptParser.this.sink.sectionTitle5_(); } @@ -1823,6 +1836,7 @@ public class AptParser extends AbstractTextParser implements AptMarkup { super(PARAGRAPH, indent, firstLine); } + @Override public void traverse() throws AptParseException { AptParser.this.sink.paragraph(); traverseText(skipSpaceFrom(0)); @@ -1842,6 +1856,7 @@ public class AptParser extends AbstractTextParser implements AptMarkup { super(COMMENT_BLOCK, 0, line); } + @Override public void traverse() throws AptParseException { if (isEmitComments()) { AptParser.this.sink.comment(text); @@ -1923,6 +1938,7 @@ public class AptParser extends AbstractTextParser implements AptMarkup { text = buffer.toString(); } + @Override public void traverse() throws AptParseException { AptParser.this.sink.verbatim(source ? SinkEventAttributeSet.SOURCE : null); AptParser.this.sink.text(text); @@ -1943,6 +1959,7 @@ public class AptParser extends AbstractTextParser implements AptMarkup { super(FIGURE, indent, firstLine); } + @Override public void traverse() throws AptParseException { AptParser.this.sink.figure(); @@ -1973,6 +1990,7 @@ public class AptParser extends AbstractTextParser implements AptMarkup { super(TABLE, indent, firstLine); } + @Override public void traverse() throws AptParseException { int captionIndex = -1; int nextLineIndex = 0; @@ -2227,6 +2245,7 @@ public class AptParser extends AbstractTextParser implements AptMarkup { super(LIST_ITEM, indent, firstLine); } + @Override public void traverse() throws AptParseException { traverseText(skipLeadingBullets()); } @@ -2259,6 +2278,7 @@ public class AptParser extends AbstractTextParser implements AptMarkup { return numbering; } + @Override public void traverse() throws AptParseException { traverseText(skipItemNumber()); } @@ -2302,6 +2322,7 @@ public class AptParser extends AbstractTextParser implements AptMarkup { super(DEFINITION_LIST_ITEM, indent, firstLine); } + @Override public void traverse() throws AptParseException { int i = skipSpaceFrom(0); int j = skipFromLeftToRightBracket(i); @@ -2334,6 +2355,7 @@ public class AptParser extends AbstractTextParser implements AptMarkup { super(HORIZONTAL_RULE, indent, firstLine); } + @Override public void traverse() throws AptParseException { AptParser.this.sink.horizontalRule(); } @@ -2352,6 +2374,7 @@ public class AptParser extends AbstractTextParser implements AptMarkup { super(PG_BREAK, indent, firstLine); } + @Override public void traverse() throws AptParseException { AptParser.this.sink.pageBreak(); } @@ -2372,6 +2395,7 @@ public class AptParser extends AbstractTextParser implements AptMarkup { text = firstLine; } + @Override public void traverse() throws AptParseException { if (isSecondParsing()) { return; diff --git a/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptReaderSource.java b/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptReaderSource.java index 3ddaa3fd..6e499e54 100644 --- a/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptReaderSource.java +++ b/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptReaderSource.java @@ -64,6 +64,7 @@ public class AptReaderSource implements AptSource { * @return a {@link java.lang.String} object. * @throws org.apache.maven.doxia.module.apt.AptParseException if any. */ + @Override public String getNextLine() throws AptParseException { if (reader == null) { return null; @@ -92,6 +93,7 @@ public class AptReaderSource implements AptSource { * * @return a {@link java.lang.String} object. */ + @Override public String getName() { // never return null return name != null ? name : ""; @@ -102,6 +104,7 @@ public class AptReaderSource implements AptSource { * * @return a int. */ + @Override public int getLineNumber() { return lineNumber; } diff --git a/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptSink.java b/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptSink.java index 194e7da1..5e0c26c1 100644 --- a/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptSink.java +++ b/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptSink.java @@ -206,6 +206,7 @@ public class AptSink extends AbstractTextSink implements AptMarkup { /** * {@inheritDoc} */ + @Override public void head_() { headerFlag = false; @@ -227,6 +228,7 @@ public class AptSink extends AbstractTextSink implements AptMarkup { /** * {@inheritDoc} */ + @Override public void title_() { if (buffer.length() > 0) { title = buffer.toString(); @@ -237,6 +239,7 @@ public class AptSink extends AbstractTextSink implements AptMarkup { /** * {@inheritDoc} */ + @Override public void author_() { if (buffer.length() > 0) { authors.add(buffer.toString()); @@ -247,6 +250,7 @@ public class AptSink extends AbstractTextSink implements AptMarkup { /** * {@inheritDoc} */ + @Override public void date_() { if (buffer.length() > 0) { date = buffer.toString(); @@ -292,6 +296,7 @@ public class AptSink extends AbstractTextSink implements AptMarkup { /** * {@inheritDoc} */ + @Override public void list_() { if (listNestingIndent.length() <= 1) { write(EOL + listNestingIndent + LIST_END_MARKUP + EOL); @@ -315,6 +320,7 @@ public class AptSink extends AbstractTextSink implements AptMarkup { /** * {@inheritDoc} */ + @Override public void listItem_() { write(EOL); itemFlag = false; @@ -350,6 +356,7 @@ public class AptSink extends AbstractTextSink implements AptMarkup { /** * {@inheritDoc} */ + @Override public void numberedList_() { if (listNestingIndent.length() <= 1) { write(EOL + listNestingIndent + LIST_END_MARKUP + EOL); @@ -382,6 +389,7 @@ public class AptSink extends AbstractTextSink implements AptMarkup { /** * {@inheritDoc} */ + @Override public void numberedListItem_() { write(EOL); itemFlag = false; @@ -397,6 +405,7 @@ public class AptSink extends AbstractTextSink implements AptMarkup { /** * {@inheritDoc} */ + @Override public void definitionList_() { if (listNestingIndent.length() <= 1) { write(EOL + listNestingIndent + LIST_END_MARKUP + EOL); @@ -416,6 +425,7 @@ public class AptSink extends AbstractTextSink implements AptMarkup { /** * {@inheritDoc} */ + @Override public void definedTerm_() { write("] "); } @@ -428,6 +438,7 @@ public class AptSink extends AbstractTextSink implements AptMarkup { /** * {@inheritDoc} */ + @Override public void definition_() { write(EOL); itemFlag = false; @@ -436,6 +447,7 @@ public class AptSink extends AbstractTextSink implements AptMarkup { /** * {@inheritDoc} */ + @Override public void pageBreak() { write(EOL + PAGE_BREAK + EOL); } @@ -454,6 +466,7 @@ public class AptSink extends AbstractTextSink implements AptMarkup { /** * {@inheritDoc} */ + @Override public void paragraph_() { if (tableCellFlag) { // ignore paragraphs in table cells @@ -486,6 +499,7 @@ public class AptSink extends AbstractTextSink implements AptMarkup { /** * {@inheritDoc} */ + @Override public void verbatim_() { if (isSource) { write(EOL + VERBATIM_SOURCE_END_MARKUP + EOL); @@ -509,6 +523,7 @@ public class AptSink extends AbstractTextSink implements AptMarkup { /** * {@inheritDoc} */ + @Override public void table_() { if (rowLine != null) { write(rowLine); @@ -531,6 +546,7 @@ public class AptSink extends AbstractTextSink implements AptMarkup { /** * {@inheritDoc} */ + @Override public void tableRows_() { cellJustif = null; gridFlag = false; @@ -545,6 +561,7 @@ public class AptSink extends AbstractTextSink implements AptMarkup { /** * {@inheritDoc} */ + @Override public void tableRow_() { bufferFlag = false; @@ -620,6 +637,7 @@ public class AptSink extends AbstractTextSink implements AptMarkup { /** * {@inheritDoc} */ + @Override public void tableCell_() { endTableCell(); } @@ -627,6 +645,7 @@ public class AptSink extends AbstractTextSink implements AptMarkup { /** * {@inheritDoc} */ + @Override public void tableHeaderCell_() { endTableCell(); } @@ -648,6 +667,7 @@ public class AptSink extends AbstractTextSink implements AptMarkup { /** * {@inheritDoc} */ + @Override public void tableCaption_() { tableCaptionFlag = false; } @@ -655,6 +675,7 @@ public class AptSink extends AbstractTextSink implements AptMarkup { /** * {@inheritDoc} */ + @Override public void figureCaption_() { write(EOL); } @@ -672,6 +693,7 @@ public class AptSink extends AbstractTextSink implements AptMarkup { /** * {@inheritDoc} */ + @Override public void anchor_() { write(ANCHOR_END_MARKUP); } @@ -688,6 +710,7 @@ public class AptSink extends AbstractTextSink implements AptMarkup { /** * {@inheritDoc} */ + @Override public void link_() { if (!headerFlag) { write(LINK_END_MARKUP); @@ -709,6 +732,7 @@ public class AptSink extends AbstractTextSink implements AptMarkup { } } + @Override public void inline(SinkEventAttributes attributes) { if (!headerFlag) { List<String> tags = new ArrayList<>(); @@ -738,6 +762,7 @@ public class AptSink extends AbstractTextSink implements AptMarkup { /** * {@inheritDoc} */ + @Override public void inline_() { if (!headerFlag) { for (String tag : inlineStack.pop()) { @@ -749,6 +774,7 @@ public class AptSink extends AbstractTextSink implements AptMarkup { /** * {@inheritDoc} */ + @Override public void italic() { inline(SinkEventAttributeSet.Semantics.ITALIC); } @@ -756,6 +782,7 @@ public class AptSink extends AbstractTextSink implements AptMarkup { /** * {@inheritDoc} */ + @Override public void italic_() { inline_(); } @@ -763,6 +790,7 @@ public class AptSink extends AbstractTextSink implements AptMarkup { /** * {@inheritDoc} */ + @Override public void bold() { inline(SinkEventAttributeSet.Semantics.BOLD); } @@ -770,6 +798,7 @@ public class AptSink extends AbstractTextSink implements AptMarkup { /** * {@inheritDoc} */ + @Override public void bold_() { inline_(); } @@ -777,6 +806,7 @@ public class AptSink extends AbstractTextSink implements AptMarkup { /** * {@inheritDoc} */ + @Override public void monospaced() { inline(SinkEventAttributeSet.Semantics.CODE); } @@ -784,6 +814,7 @@ public class AptSink extends AbstractTextSink implements AptMarkup { /** * {@inheritDoc} */ + @Override public void monospaced_() { inline_(); } @@ -802,6 +833,7 @@ public class AptSink extends AbstractTextSink implements AptMarkup { /** * {@inheritDoc} */ + @Override public void nonBreakingSpace() { if (headerFlag || bufferFlag) { buffer.append(NON_BREAKING_SPACE_MARKUP); @@ -829,10 +861,12 @@ public class AptSink extends AbstractTextSink implements AptMarkup { } } + @Override public void rawText(String text) { write(text); } + @Override public void comment(String comment) { rawText("" + COMMENT + COMMENT + comment + EOL); // comments always end with a line break in APT } @@ -843,6 +877,7 @@ public class AptSink extends AbstractTextSink implements AptMarkup { * Unkown events just log a warning message but are ignored otherwise. * @see org.apache.maven.doxia.sink.Sink#unknown(String,Object[],SinkEventAttributes) */ + @Override public void unknown(String name, Object[] requiredParams, SinkEventAttributes attributes) { LOGGER.warn("{}Unknown Sink event '{}', ignoring!", getLocationLogPrefix(), name); } @@ -882,6 +917,7 @@ public class AptSink extends AbstractTextSink implements AptMarkup { /** * {@inheritDoc} */ + @Override public void flush() { writer.flush(); } @@ -889,6 +925,7 @@ public class AptSink extends AbstractTextSink implements AptMarkup { /** * {@inheritDoc} */ + @Override public void close() { writer.close(); diff --git a/doxia-modules/doxia-module-apt/src/test/java/org/apache/maven/doxia/module/apt/AptSinkTest.java b/doxia-modules/doxia-module-apt/src/test/java/org/apache/maven/doxia/module/apt/AptSinkTest.java index 13d32fbe..fa822299 100644 --- a/doxia-modules/doxia-module-apt/src/test/java/org/apache/maven/doxia/module/apt/AptSinkTest.java +++ b/doxia-modules/doxia-module-apt/src/test/java/org/apache/maven/doxia/module/apt/AptSinkTest.java @@ -292,6 +292,7 @@ class AptSinkTest extends AbstractSinkTest { } /* Overwrite the test from AbstractSinkTest as EOLs are part of getCommentBlock(...) */ + @Override @Test public void twoConsecutiveBlockComments() { final Sink sink = getSink(); diff --git a/doxia-modules/doxia-module-fml/src/main/java/org/apache/maven/doxia/module/fml/FmlMarkup.java b/doxia-modules/doxia-module-fml/src/main/java/org/apache/maven/doxia/module/fml/FmlMarkup.java index e9280721..0ac47d71 100644 --- a/doxia-modules/doxia-module-fml/src/main/java/org/apache/maven/doxia/module/fml/FmlMarkup.java +++ b/doxia-modules/doxia-module-fml/src/main/java/org/apache/maven/doxia/module/fml/FmlMarkup.java @@ -50,6 +50,7 @@ public interface FmlMarkup extends HtmlMarkup { /** Fml tag for <code>faqs</code> */ Tag FAQS_TAG = new Tag() { + @Override public String toString() { return "faqs"; } @@ -58,6 +59,7 @@ public interface FmlMarkup extends HtmlMarkup { /** Fml tag for <code>part</code> */ Tag PART_TAG = new Tag() { + @Override public String toString() { return "part"; } @@ -66,6 +68,7 @@ public interface FmlMarkup extends HtmlMarkup { /** Fml tag for <code>faq</code> */ Tag FAQ_TAG = new Tag() { + @Override public String toString() { return "faq"; } @@ -74,6 +77,7 @@ public interface FmlMarkup extends HtmlMarkup { /** Fml tag for <code>question</code> */ Tag QUESTION_TAG = new Tag() { + @Override public String toString() { return "question"; } @@ -82,6 +86,7 @@ public interface FmlMarkup extends HtmlMarkup { /** Fml tag for <code>answer</code> */ Tag ANSWER_TAG = new Tag() { + @Override public String toString() { return "answer"; } @@ -90,6 +95,7 @@ public interface FmlMarkup extends HtmlMarkup { /** Fml tag for <code>source</code> */ Tag SOURCE_TAG = new Tag() { + @Override public String toString() { return "source"; } @@ -101,6 +107,7 @@ public interface FmlMarkup extends HtmlMarkup { */ Tag MACRO_TAG = new Tag() { + @Override public String toString() { return "macro"; } diff --git a/doxia-modules/doxia-module-fml/src/main/java/org/apache/maven/doxia/module/fml/FmlParser.java b/doxia-modules/doxia-module-fml/src/main/java/org/apache/maven/doxia/module/fml/FmlParser.java index e198cdcd..7654713a 100644 --- a/doxia-modules/doxia-module-fml/src/main/java/org/apache/maven/doxia/module/fml/FmlParser.java +++ b/doxia-modules/doxia-module-fml/src/main/java/org/apache/maven/doxia/module/fml/FmlParser.java @@ -87,6 +87,7 @@ public class FmlParser extends AbstractXmlParser implements FmlMarkup { /** The macro parameters. */ private Map<String, Object> macroParameters = new LinkedHashMap<>(); + @Override public void parse(Reader source, Sink sink, String reference) throws ParseException { LOGGER.warn( "FML is deprecated and will be removed in the next major Doxia version; convert {} to Markdown or XDoc", diff --git a/doxia-modules/doxia-module-fml/src/test/java/org/apache/maven/doxia/module/fml/FmlValidatorTest.java b/doxia-modules/doxia-module-fml/src/test/java/org/apache/maven/doxia/module/fml/FmlValidatorTest.java index 227b5ca0..0210ab94 100644 --- a/doxia-modules/doxia-module-fml/src/test/java/org/apache/maven/doxia/module/fml/FmlValidatorTest.java +++ b/doxia-modules/doxia-module-fml/src/test/java/org/apache/maven/doxia/module/fml/FmlValidatorTest.java @@ -62,6 +62,7 @@ class FmlValidatorTest extends AbstractXmlValidatorTest { return content; } + @Override @Test public void validateFiles() { // TODO: super.validateFiles() only validates files from doxia-test-docs, what's the point? diff --git a/doxia-modules/doxia-module-markdown/src/main/java/org/apache/maven/doxia/module/markdown/MarkdownSink.java b/doxia-modules/doxia-module-markdown/src/main/java/org/apache/maven/doxia/module/markdown/MarkdownSink.java index 4a9ba747..7f056acd 100644 --- a/doxia-modules/doxia-module-markdown/src/main/java/org/apache/maven/doxia/module/markdown/MarkdownSink.java +++ b/doxia-modules/doxia-module-markdown/src/main/java/org/apache/maven/doxia/module/markdown/MarkdownSink.java @@ -1118,6 +1118,7 @@ public final class MarkdownSink extends Xhtml5BaseSink implements MarkdownMarkup write("](" + src + ")"); } + @Override public void anchor(String name, SinkEventAttributes attributes) { super.anchor(name, attributes); if (!elementContextStack.element().isHtml()) { @@ -1135,6 +1136,7 @@ public final class MarkdownSink extends Xhtml5BaseSink implements MarkdownMarkup } } + @Override public void link(String name, SinkEventAttributes attributes) { if (elementContextStack.element().isHtml()) { super.link(name, attributes); diff --git a/doxia-modules/doxia-module-xdoc/src/main/java/org/apache/maven/doxia/module/xdoc/XdocMarkup.java b/doxia-modules/doxia-module-xdoc/src/main/java/org/apache/maven/doxia/module/xdoc/XdocMarkup.java index e11cdf35..012d739a 100644 --- a/doxia-modules/doxia-module-xdoc/src/main/java/org/apache/maven/doxia/module/xdoc/XdocMarkup.java +++ b/doxia-modules/doxia-module-xdoc/src/main/java/org/apache/maven/doxia/module/xdoc/XdocMarkup.java @@ -46,6 +46,7 @@ public interface XdocMarkup extends HtmlMarkup { /** Xdoc tag for <code>author</code> */ Tag AUTHOR_TAG = new Tag() { + @Override public String toString() { return "author"; } @@ -54,6 +55,7 @@ public interface XdocMarkup extends HtmlMarkup { /** Xdoc tag for <code>date</code> */ Tag DATE_TAG = new Tag() { + @Override public String toString() { return "date"; } @@ -62,6 +64,7 @@ public interface XdocMarkup extends HtmlMarkup { /** Xdoc tag for <code>document</code> */ Tag DOCUMENT_TAG = new Tag() { + @Override public String toString() { return "document"; } @@ -70,6 +73,7 @@ public interface XdocMarkup extends HtmlMarkup { /** Xdoc tag for <code>macro</code> */ Tag MACRO_TAG = new Tag() { + @Override public String toString() { return "macro"; } @@ -78,6 +82,7 @@ public interface XdocMarkup extends HtmlMarkup { /** Xdoc tag for <code>properties</code> */ Tag PROPERTIES_TAG = new Tag() { + @Override public String toString() { return "properties"; } @@ -86,6 +91,7 @@ public interface XdocMarkup extends HtmlMarkup { /** Xdoc tag for <code>section</code> */ Tag SECTION_TAG = new Tag() { + @Override public String toString() { return "section"; } @@ -94,6 +100,7 @@ public interface XdocMarkup extends HtmlMarkup { /** Xdoc tag for <code>source</code> */ Tag SOURCE_TAG = new Tag() { + @Override public String toString() { return "source"; } @@ -102,6 +109,7 @@ public interface XdocMarkup extends HtmlMarkup { /** Xdoc tag for <code>subsection</code> */ Tag SUBSECTION_TAG = new Tag() { + @Override public String toString() { return "subsection"; } diff --git a/doxia-modules/doxia-module-xdoc/src/main/java/org/apache/maven/doxia/module/xdoc/XdocParser.java b/doxia-modules/doxia-module-xdoc/src/main/java/org/apache/maven/doxia/module/xdoc/XdocParser.java index 0c8efaa0..43d35422 100644 --- a/doxia-modules/doxia-module-xdoc/src/main/java/org/apache/maven/doxia/module/xdoc/XdocParser.java +++ b/doxia-modules/doxia-module-xdoc/src/main/java/org/apache/maven/doxia/module/xdoc/XdocParser.java @@ -87,6 +87,7 @@ public class XdocParser extends Xhtml1BaseParser implements XdocMarkup { /** Number of currently open {@code source} elements; verbatim blocks must not be nested. */ private int sourceDepth; + @Override public void parse(Reader source, Sink sink, String reference) throws ParseException { this.sourceContent = null; diff --git a/doxia-modules/doxia-module-xdoc/src/main/java/org/apache/maven/doxia/module/xdoc/XdocSink.java b/doxia-modules/doxia-module-xdoc/src/main/java/org/apache/maven/doxia/module/xdoc/XdocSink.java index 521f7e10..ad2a9ba2 100644 --- a/doxia-modules/doxia-module-xdoc/src/main/java/org/apache/maven/doxia/module/xdoc/XdocSink.java +++ b/doxia-modules/doxia-module-xdoc/src/main/java/org/apache/maven/doxia/module/xdoc/XdocSink.java @@ -106,6 +106,7 @@ public class XdocSink extends Xhtml5BaseSink implements XdocMarkup { * @see XdocMarkup#DOCUMENT_TAG * @see XdocMarkup#PROPERTIES_TAG */ + @Override public void head(SinkEventAttributes attributes) { init(); @@ -142,6 +143,7 @@ public class XdocSink extends Xhtml5BaseSink implements XdocMarkup { * @see XdocMarkup#DOCUMENT_TAG * @see XdocMarkup#PROPERTIES_TAG */ + @Override public void head_() { setHeadFlag(false); @@ -163,6 +165,7 @@ public class XdocSink extends Xhtml5BaseSink implements XdocMarkup { * * @see javax.swing.text.html.HTML.Tag#TITLE */ + @Override public void title_() { content(getTextBuffer().toString()); @@ -176,6 +179,7 @@ public class XdocSink extends Xhtml5BaseSink implements XdocMarkup { * * @see XdocMarkup#AUTHOR_TAG */ + @Override public void author_() { if (getTextBuffer().length() > 0) { writeStartTag(AUTHOR_TAG); @@ -194,6 +198,7 @@ public class XdocSink extends Xhtml5BaseSink implements XdocMarkup { * * @see XdocMarkup#DATE_TAG */ + @Override public void date_() { if (getTextBuffer().length() > 0) { writeStartTag(DATE_TAG); @@ -207,6 +212,7 @@ public class XdocSink extends Xhtml5BaseSink implements XdocMarkup { * {@inheritDoc} * @see javax.swing.text.html.HTML.Tag#BODY */ + @Override public void body(SinkEventAttributes attributes) { writeStartTag(BODY, attributes); } @@ -217,6 +223,7 @@ public class XdocSink extends Xhtml5BaseSink implements XdocMarkup { * @see javax.swing.text.html.HTML.Tag#BODY * @see XdocMarkup#DOCUMENT_TAG */ + @Override public void body_() { writeEndTag(BODY); @@ -332,6 +339,7 @@ public class XdocSink extends Xhtml5BaseSink implements XdocMarkup { * @see javax.swing.text.html.HTML.Tag#PRE * @param attributes a {@link org.apache.maven.doxia.sink.SinkEventAttributes} object. */ + @Override public void verbatim(SinkEventAttributes attributes) { MutableAttributeSet atts = SinkUtils.filterAttributes(attributes, SinkUtils.SINK_VERBATIM_ATTRIBUTES); @@ -362,6 +370,7 @@ public class XdocSink extends Xhtml5BaseSink implements XdocMarkup { * @see XdocMarkup#SOURCE_TAG * @see javax.swing.text.html.HTML.Tag#PRE */ + @Override public void verbatim_() { if (getVerbatimMode() == VerbatimMode.ON_WITH_CODE) { writeEndTag(SOURCE_TAG); @@ -377,6 +386,7 @@ public class XdocSink extends Xhtml5BaseSink implements XdocMarkup { * * @see javax.swing.text.html.HTML.Tag#TABLE */ + @Override public void tableRows(int[] justification, boolean grid) { // similar to super.tableRows(justification, grid) but without class. @@ -411,6 +421,7 @@ public class XdocSink extends Xhtml5BaseSink implements XdocMarkup { /** * <p>close.</p> */ + @Override public void close() { super.close(); diff --git a/doxia-modules/doxia-module-xdoc/src/test/java/org/apache/maven/doxia/module/xdoc/XdocSinkTest.java b/doxia-modules/doxia-module-xdoc/src/test/java/org/apache/maven/doxia/module/xdoc/XdocSinkTest.java index 0e68444f..09fa76ee 100644 --- a/doxia-modules/doxia-module-xdoc/src/test/java/org/apache/maven/doxia/module/xdoc/XdocSinkTest.java +++ b/doxia-modules/doxia-module-xdoc/src/test/java/org/apache/maven/doxia/module/xdoc/XdocSinkTest.java @@ -36,6 +36,7 @@ import static org.junit.jupiter.api.Assertions.assertEquals; */ public class XdocSinkTest extends AbstractSinkTest { + @Override @Test public void section1() { String title = "Title1"; @@ -53,6 +54,7 @@ public class XdocSinkTest extends AbstractSinkTest { assertEquals(expected, actual, "Wrong section1 block!"); } + @Override @Test public void section2() { String title = "Title2"; @@ -287,6 +289,7 @@ public class XdocSinkTest extends AbstractSinkTest { /** * Test verbatim. */ + @Override @Test public void verbatimSource() { Writer writer = new StringWriter(); diff --git a/doxia-modules/doxia-module-xdoc/src/test/java/org/apache/maven/doxia/module/xdoc/XdocSinkWithLanguageIdTest.java b/doxia-modules/doxia-module-xdoc/src/test/java/org/apache/maven/doxia/module/xdoc/XdocSinkWithLanguageIdTest.java index 7d55e96d..0dfbd5be 100644 --- a/doxia-modules/doxia-module-xdoc/src/test/java/org/apache/maven/doxia/module/xdoc/XdocSinkWithLanguageIdTest.java +++ b/doxia-modules/doxia-module-xdoc/src/test/java/org/apache/maven/doxia/module/xdoc/XdocSinkWithLanguageIdTest.java @@ -28,10 +28,12 @@ import org.apache.maven.doxia.sink.Sink; */ public class XdocSinkWithLanguageIdTest extends XdocSinkTest { + @Override protected Sink createSink(Writer writer) { return new XdocSink(writer, "UTF-8", Locale.US.getLanguage()); } + @Override protected String getHeadBlock() { return "<?xml version=\"1.0\" encoding=\"UTF-8\"?>" + "<document xmlns=\"http://maven.apache.org/XDOC/2.0\" " diff --git a/doxia-modules/doxia-module-xhtml5/src/main/java/org/apache/maven/doxia/module/xhtml5/Xhtml5Parser.java b/doxia-modules/doxia-module-xhtml5/src/main/java/org/apache/maven/doxia/module/xhtml5/Xhtml5Parser.java index bef4ef01..83bab9e8 100644 --- a/doxia-modules/doxia-module-xhtml5/src/main/java/org/apache/maven/doxia/module/xhtml5/Xhtml5Parser.java +++ b/doxia-modules/doxia-module-xhtml5/src/main/java/org/apache/maven/doxia/module/xhtml5/Xhtml5Parser.java @@ -264,6 +264,7 @@ public class Xhtml5Parser extends Xhtml5BaseParser implements Xhtml5Markup { this.isEmptyElement = false; } + @Override public void parse(Reader source, Sink sink, String reference) throws ParseException { this.sourceContent = null; diff --git a/doxia-modules/doxia-module-xhtml5/src/main/java/org/apache/maven/doxia/module/xhtml5/Xhtml5Sink.java b/doxia-modules/doxia-module-xhtml5/src/main/java/org/apache/maven/doxia/module/xhtml5/Xhtml5Sink.java index 5f558323..855490b5 100644 --- a/doxia-modules/doxia-module-xhtml5/src/main/java/org/apache/maven/doxia/module/xhtml5/Xhtml5Sink.java +++ b/doxia-modules/doxia-module-xhtml5/src/main/java/org/apache/maven/doxia/module/xhtml5/Xhtml5Sink.java @@ -112,6 +112,7 @@ public class Xhtml5Sink extends Xhtml5BaseSink implements Xhtml5Markup { /** * {@inheritDoc} */ + @Override public void head_() { if (!isHeadTitleFlag()) { // The content of element type "head" must match @@ -138,6 +139,7 @@ public class Xhtml5Sink extends Xhtml5BaseSink implements Xhtml5Markup { * * @see javax.swing.text.html.HTML.Tag#TITLE */ + @Override public void title(SinkEventAttributes attributes) { setHeadTitleFlag(true); @@ -149,6 +151,7 @@ public class Xhtml5Sink extends Xhtml5BaseSink implements Xhtml5Markup { * * @see javax.swing.text.html.HTML.Tag#TITLE */ + @Override public void title_() { content(getTextBuffer().toString()); @@ -162,6 +165,7 @@ public class Xhtml5Sink extends Xhtml5BaseSink implements Xhtml5Markup { * * @see javax.swing.text.html.HTML.Tag#META */ + @Override public void author_() { if (getTextBuffer().length() > 0) { MutableAttributeSet att = new SinkEventAttributeSet(); @@ -183,6 +187,7 @@ public class Xhtml5Sink extends Xhtml5BaseSink implements Xhtml5Markup { * * @see javax.swing.text.html.HTML.Tag#META */ + @Override public void date_() { if (getTextBuffer().length() > 0) { MutableAttributeSet att = new SinkEventAttributeSet(); @@ -211,6 +216,7 @@ public class Xhtml5Sink extends Xhtml5BaseSink implements Xhtml5Markup { * @see javax.swing.text.html.HTML.Tag#BODY * @see javax.swing.text.html.HTML.Tag#HTML */ + @Override public void body_() { writeEndTag(BODY); diff --git a/doxia-modules/doxia-module-xhtml5/src/test/java/org/apache/maven/doxia/module/xhtml5/Xhtml5SinkTest.java b/doxia-modules/doxia-module-xhtml5/src/test/java/org/apache/maven/doxia/module/xhtml5/Xhtml5SinkTest.java index edf4101b..af7b4cdd 100644 --- a/doxia-modules/doxia-module-xhtml5/src/test/java/org/apache/maven/doxia/module/xhtml5/Xhtml5SinkTest.java +++ b/doxia-modules/doxia-module-xhtml5/src/test/java/org/apache/maven/doxia/module/xhtml5/Xhtml5SinkTest.java @@ -313,6 +313,7 @@ public class Xhtml5SinkTest extends AbstractSinkTest { /** * Test head events. */ + @Override @Test public void head() { Xhtml5Sink sink = null; diff --git a/doxia-modules/doxia-module-xhtml5/src/test/java/org/apache/maven/doxia/module/xhtml5/Xhtml5SinkWithLanguageIdTest.java b/doxia-modules/doxia-module-xhtml5/src/test/java/org/apache/maven/doxia/module/xhtml5/Xhtml5SinkWithLanguageIdTest.java index ce31ee97..d4f56219 100644 --- a/doxia-modules/doxia-module-xhtml5/src/test/java/org/apache/maven/doxia/module/xhtml5/Xhtml5SinkWithLanguageIdTest.java +++ b/doxia-modules/doxia-module-xhtml5/src/test/java/org/apache/maven/doxia/module/xhtml5/Xhtml5SinkWithLanguageIdTest.java @@ -25,10 +25,12 @@ import org.apache.maven.doxia.sink.Sink; public class Xhtml5SinkWithLanguageIdTest extends Xhtml5SinkTest { + @Override protected Sink createSink(Writer writer) { return new Xhtml5Sink(writer, "UTF-8", Locale.ENGLISH.getLanguage()); } + @Override protected String getHeadBlock() { return "<!DOCTYPE html>" + "<html xmlns=\"http://www.w3.org/1999/xhtml\" lang=\"en\" xml:lang=\"en\">" diff --git a/doxia-sink-api/src/main/java/org/apache/maven/doxia/sink/Sink.java b/doxia-sink-api/src/main/java/org/apache/maven/doxia/sink/Sink.java index c8dac9f4..057189b1 100644 --- a/doxia-sink-api/src/main/java/org/apache/maven/doxia/sink/Sink.java +++ b/doxia-sink-api/src/main/java/org/apache/maven/doxia/sink/Sink.java @@ -1795,6 +1795,7 @@ public interface Sink extends AutoCloseable { * Closes the writer or the stream, if needed. * Closing a previously-closed Sink has no effect. */ + @Override void close(); /** diff --git a/doxia-sink-api/src/main/java/org/apache/maven/doxia/sink/SinkEventAttributeSet.java b/doxia-sink-api/src/main/java/org/apache/maven/doxia/sink/SinkEventAttributeSet.java index 52b06742..7546866f 100644 --- a/doxia-sink-api/src/main/java/org/apache/maven/doxia/sink/SinkEventAttributeSet.java +++ b/doxia-sink-api/src/main/java/org/apache/maven/doxia/sink/SinkEventAttributeSet.java @@ -199,14 +199,17 @@ public class SinkEventAttributeSet implements SinkEventAttributes, Cloneable { * * @return a int. */ + @Override public int getAttributeCount() { return attribs.size(); } + @Override public boolean isDefined(Object attrName) { return attribs.containsKey(attrName); } + @Override public boolean isEqual(AttributeSet attr) { return (getAttributeCount() == attr.getAttributeCount()) && containsAttributes(attr); } @@ -216,6 +219,7 @@ public class SinkEventAttributeSet implements SinkEventAttributes, Cloneable { * * @return a {@link javax.swing.text.AttributeSet} object. */ + @Override public AttributeSet copyAttributes() { return (AttributeSet) clone(); } @@ -225,10 +229,12 @@ public class SinkEventAttributeSet implements SinkEventAttributes, Cloneable { * * @return a {@link java.util.Enumeration} object. */ + @Override public Enumeration<String> getAttributeNames() { return Collections.enumeration(attribs.keySet()); } + @Override public Object getAttribute(Object key) { Object value = attribs.get(key); @@ -243,10 +249,12 @@ public class SinkEventAttributeSet implements SinkEventAttributes, Cloneable { return value; } + @Override public boolean containsAttribute(Object name, Object value) { return value.equals(getAttribute(name)); } + @Override public boolean containsAttributes(AttributeSet attributes) { boolean result = true; @@ -265,10 +273,12 @@ public class SinkEventAttributeSet implements SinkEventAttributes, Cloneable { * * Adds an attribute with the given name and value. */ + @Override public void addAttribute(Object name, Object value) { attribs.put(name.toString(), value); } + @Override public void addAttributes(AttributeSet attributes) { if (attributes == null || attributes.getAttributeCount() == 0) { return; @@ -283,10 +293,12 @@ public class SinkEventAttributeSet implements SinkEventAttributes, Cloneable { } } + @Override public void removeAttribute(Object name) { attribs.remove(name); } + @Override public void removeAttributes(Enumeration<?> names) { while (names.hasMoreElements()) { removeAttribute(names.nextElement()); @@ -298,6 +310,7 @@ public class SinkEventAttributeSet implements SinkEventAttributes, Cloneable { * * @param attributes a {@link javax.swing.text.AttributeSet} object. */ + @Override public void removeAttributes(AttributeSet attributes) { if (attributes == null) { return; @@ -322,10 +335,12 @@ public class SinkEventAttributeSet implements SinkEventAttributes, Cloneable { * * @return a {@link javax.swing.text.AttributeSet} object. */ + @Override public AttributeSet getResolveParent() { return this.resolveParent; } + @Override public void setResolveParent(AttributeSet parent) { this.resolveParent = parent; }
