You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by rf...@apache.org on 2019/06/07 12:47:13 UTC
[maven-doxia-converter] branch DOXIATOOLS-61 created (now 6830316)
This is an automated email from the ASF dual-hosted git repository.
rfscholte pushed a change to branch DOXIATOOLS-61
in repository https://gitbox.apache.org/repos/asf/maven-doxia-converter.git.
at 6830316 [DOXIATOOLS-61] Require Java 7
This branch includes the following new commits:
new 6830316 [DOXIATOOLS-61] Require Java 7
The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
[maven-doxia-converter] 01/01: [DOXIATOOLS-61] Require Java 7
Posted by rf...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
rfscholte pushed a commit to branch DOXIATOOLS-61
in repository https://gitbox.apache.org/repos/asf/maven-doxia-converter.git
commit 6830316c12c9c7d9046c7f3cb61d692a65ebcef5
Author: rfscholte <rf...@apache.org>
AuthorDate: Fri Jun 7 14:47:04 2019 +0200
[DOXIATOOLS-61] Require Java 7
---
pom.xml | 5 +-
.../java/org/apache/maven/doxia/Converter.java | 3 +-
.../org/apache/maven/doxia/ConverterException.java | 1 -
.../org/apache/maven/doxia/DefaultConverter.java | 30 +++------
.../maven/doxia/UnsupportedFormatException.java | 1 -
.../org/apache/maven/doxia/cli/CLIManager.java | 72 ++++++++++++++--------
.../org/apache/maven/doxia/cli/ConverterCli.java | 9 +--
.../org/apache/maven/doxia/util/ConverterUtil.java | 1 -
.../maven/doxia/wrapper/AbstractFileWrapper.java | 4 +-
.../maven/doxia/wrapper/AbstractWrapper.java | 4 +-
.../maven/doxia/wrapper/InputFileWrapper.java | 1 -
.../maven/doxia/wrapper/InputReaderWrapper.java | 1 -
.../maven/doxia/wrapper/OutputFileWrapper.java | 1 -
.../maven/doxia/wrapper/OutputStreamWrapper.java | 1 -
.../java/org/apache/maven/doxia/ConverterTest.java | 2 +
15 files changed, 71 insertions(+), 65 deletions(-)
diff --git a/pom.xml b/pom.xml
index 2d1b02f..f88c18b 100644
--- a/pom.xml
+++ b/pom.xml
@@ -25,8 +25,8 @@ under the License.
<parent>
<groupId>org.apache.maven.doxia</groupId>
<artifactId>doxia-tools</artifactId>
- <version>30</version>
- <relativePath>../../pom/maven/doxia-tools/pom.xml</relativePath>
+ <version>33</version>
+ <relativePath></relativePath>
</parent>
<artifactId>doxia-converter</artifactId>
@@ -58,6 +58,7 @@ under the License.
<properties>
<doxiaVersion>1.1.4</doxiaVersion>
+ <javaVersion>7</javaVersion>
</properties>
<dependencies>
diff --git a/src/main/java/org/apache/maven/doxia/Converter.java b/src/main/java/org/apache/maven/doxia/Converter.java
index 0353549..3c625e4 100644
--- a/src/main/java/org/apache/maven/doxia/Converter.java
+++ b/src/main/java/org/apache/maven/doxia/Converter.java
@@ -29,7 +29,6 @@ import org.apache.maven.doxia.wrapper.OutputStreamWrapper;
* Interface to convert a Doxia input wrapper to a Doxia output wrapper.
*
* @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
- * @version $Id$
*/
public interface Converter
extends LogEnabled
@@ -64,7 +63,7 @@ public interface Converter
/**
* Make the generated files human readable.
- * <br/>
+ * <br>
* <b>Note</b>: actually, only XML based outputs could be formatted.
*
* @param formatOutput <code>true</code> to format the generated files, <code>false</code> otherwise.
diff --git a/src/main/java/org/apache/maven/doxia/ConverterException.java b/src/main/java/org/apache/maven/doxia/ConverterException.java
index cc7d274..09891a2 100644
--- a/src/main/java/org/apache/maven/doxia/ConverterException.java
+++ b/src/main/java/org/apache/maven/doxia/ConverterException.java
@@ -23,7 +23,6 @@ package org.apache.maven.doxia;
* Wrap an exception that occurs during the conversion.
*
* @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
- * @version $Id$
*/
public class ConverterException
extends Exception
diff --git a/src/main/java/org/apache/maven/doxia/DefaultConverter.java b/src/main/java/org/apache/maven/doxia/DefaultConverter.java
index bfb149a..7e6fbfc 100644
--- a/src/main/java/org/apache/maven/doxia/DefaultConverter.java
+++ b/src/main/java/org/apache/maven/doxia/DefaultConverter.java
@@ -23,7 +23,6 @@ import java.io.BufferedInputStream;
import java.io.CharArrayWriter;
import java.io.File;
import java.io.FileInputStream;
-import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
@@ -73,7 +72,6 @@ import com.ibm.icu.text.CharsetMatch;
* Default implementation of <code>Converter</code>
*
* @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
- * @version $Id$
*/
public class DefaultConverter
implements Converter
@@ -131,6 +129,7 @@ public class DefaultConverter
private Log log;
/** {@inheritDoc} */
+ @Override
public void enableLogging( Log log )
{
this.log = log;
@@ -153,19 +152,21 @@ public class DefaultConverter
}
/** {@inheritDoc} */
+ @Override
public String[] getInputFormats()
{
return SUPPORTED_FROM_FORMAT;
}
/** {@inheritDoc} */
+ @Override
public String[] getOutputFormats()
{
return SUPPORTED_TO_FORMAT;
}
/** {@inheritDoc} */
- @SuppressWarnings( "unchecked" )
+ @Override
public void convert( InputFileWrapper input, OutputFileWrapper output )
throws UnsupportedFormatException, ConverterException
{
@@ -224,6 +225,7 @@ public class DefaultConverter
}
/** {@inheritDoc} */
+ @Override
public void convert( InputReaderWrapper input, OutputStreamWrapper output )
throws UnsupportedFormatException, ConverterException
{
@@ -298,6 +300,7 @@ public class DefaultConverter
}
/** {@inheritDoc} */
+ @Override
public void setFormatOutput( boolean formatOutput )
{
this.formatOutput = formatOutput;
@@ -510,7 +513,7 @@ public class DefaultConverter
return;
}
- Map<String, String> context = new HashMap<String, String>();
+ Map<String, String> context = new HashMap<>();
context.put( "basedir", new File( "" ).getAbsolutePath() );
ContainerConfiguration containerConfiguration = new DefaultContainerConfiguration();
@@ -694,10 +697,9 @@ public class DefaultConverter
throw new IllegalArgumentException( "The file '" + xmlFile.getAbsolutePath() + "' is not a file." );
}
- Reader reader = null;
- try
+
+ try ( Reader reader = ReaderFactory.newXmlReader( xmlFile ) )
{
- reader = ReaderFactory.newXmlReader( xmlFile );
XmlPullParser parser = new MXParser();
parser.setInput( reader );
int eventType = parser.getEventType();
@@ -710,22 +712,10 @@ public class DefaultConverter
eventType = parser.nextToken();
}
}
- catch ( FileNotFoundException e )
+ catch ( IOException | XmlPullParserException e )
{
return null;
}
- catch ( XmlPullParserException e )
- {
- return null;
- }
- catch ( IOException e )
- {
- return null;
- }
- finally
- {
- IOUtil.close( reader );
- }
return null;
}
diff --git a/src/main/java/org/apache/maven/doxia/UnsupportedFormatException.java b/src/main/java/org/apache/maven/doxia/UnsupportedFormatException.java
index acc1129..78b3681 100644
--- a/src/main/java/org/apache/maven/doxia/UnsupportedFormatException.java
+++ b/src/main/java/org/apache/maven/doxia/UnsupportedFormatException.java
@@ -25,7 +25,6 @@ import org.codehaus.plexus.util.StringUtils;
* Wrap an exception that occurs if a format is not supported.
*
* @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
- * @version $Id$
*/
public class UnsupportedFormatException
extends Exception
diff --git a/src/main/java/org/apache/maven/doxia/cli/CLIManager.java b/src/main/java/org/apache/maven/doxia/cli/CLIManager.java
index 0443838..ddaf786 100644
--- a/src/main/java/org/apache/maven/doxia/cli/CLIManager.java
+++ b/src/main/java/org/apache/maven/doxia/cli/CLIManager.java
@@ -38,9 +38,7 @@ import com.ibm.icu.text.CharsetDetector;
* Manager for Doxia converter CLI options.
*
* @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
- * @version $Id$
*/
-@SuppressWarnings( "static-access" )
class CLIManager
{
/** h character */
@@ -82,35 +80,61 @@ class CLIManager
{
OPTIONS = new Options();
- OPTIONS.addOption( OptionBuilder.withLongOpt( "help" ).withDescription( "Display help information." )
+ OptionBuilder.withLongOpt( "help" );
+ OptionBuilder.withDescription( "Display help information." );
+ OPTIONS.addOption( OptionBuilder
.create( HELP ) );
- OPTIONS.addOption( OptionBuilder.withLongOpt( "version" ).withDescription( "Display version information." )
+ OptionBuilder.withLongOpt( "version" );
+ OptionBuilder.withDescription( "Display version information." );
+ OPTIONS.addOption( OptionBuilder
.create( VERSION ) );
- OPTIONS.addOption( OptionBuilder.withLongOpt( "input" ).withDescription( "Input file or directory." )
- .hasArg().create( IN ) );
- OPTIONS.addOption( OptionBuilder.withLongOpt( "output" ).withDescription( "Output file or directory." )
- .hasArg().create( OUT ) );
- OPTIONS.addOption( OptionBuilder.withDescription( "From format. If not specified, try to autodetect it." )
- .hasArg().create( FROM ) );
- OPTIONS.addOption( OptionBuilder.withDescription( "To format." ).hasArg().create( TO ) );
- OPTIONS.addOption( OptionBuilder.withLongOpt( "inputEncoding" )
+ OptionBuilder.withLongOpt( "input" );
+ OptionBuilder.withDescription( "Input file or directory." );
+ OptionBuilder
+ .hasArg();
+ OPTIONS.addOption( OptionBuilder.create( IN ) );
+ OptionBuilder.withLongOpt( "output" );
+ OptionBuilder.withDescription( "Output file or directory." );
+ OptionBuilder
+ .hasArg();
+ OPTIONS.addOption( OptionBuilder.create( OUT ) );
+ OptionBuilder.withDescription( "From format. If not specified, try to autodetect it." );
+ OptionBuilder
+ .hasArg();
+ OPTIONS.addOption( OptionBuilder.create( FROM ) );
+ OptionBuilder.withDescription( "To format." );
+ OptionBuilder.hasArg();
+ OPTIONS.addOption( OptionBuilder.create( TO ) );
+ OptionBuilder.withLongOpt( "inputEncoding" );
+ OptionBuilder
.withDescription( "Input file encoding. "
- + "If not specified, try to autodetect it." )
- .hasArg().create( INENCODING ) );
- OPTIONS.addOption( OptionBuilder.withLongOpt( "format" )
+ + "If not specified, try to autodetect it." );
+ OptionBuilder
+ .hasArg();
+ OPTIONS.addOption( OptionBuilder.create( INENCODING ) );
+ OptionBuilder.withLongOpt( "format" );
+ OptionBuilder
.withDescription( "Format the output (actually only xml based outputs) "
- + " to be human readable." )
+ + " to be human readable." );
+ OPTIONS.addOption( OptionBuilder
.create( FORMAT ) );
- OPTIONS.addOption( OptionBuilder.withLongOpt( "outputEncoding" )
+ OptionBuilder.withLongOpt( "outputEncoding" );
+ OptionBuilder
.withDescription( "Output file encoding. If not specified, use the "
- + "input encoding (or autodetected)." ).hasArg()
+ + "input encoding (or autodetected)." );
+ OptionBuilder.hasArg();
+ OPTIONS.addOption( OptionBuilder
.create( OUTENCODING ) );
- OPTIONS.addOption( OptionBuilder.withLongOpt( "debug" )
- .withDescription( "Produce execution debug output." ).create( DEBUG ) );
- OPTIONS.addOption( OptionBuilder.withLongOpt( "errors" )
- .withDescription( "Produce execution error messages." ).create( ERRORS ) );
+ OptionBuilder.withLongOpt( "debug" );
+ OptionBuilder
+ .withDescription( "Produce execution debug output." );
+ OPTIONS.addOption( OptionBuilder.create( DEBUG ) );
+ OptionBuilder.withLongOpt( "errors" );
+ OptionBuilder
+ .withDescription( "Produce execution error messages." );
+ OPTIONS.addOption( OptionBuilder.create( ERRORS ) );
}
/**
@@ -162,7 +186,7 @@ class CLIManager
private String[] cleanArgs( String[] args )
{
- List<String> cleaned = new ArrayList<String>();
+ List<String> cleaned = new ArrayList<>();
StringBuilder currentArg = null;
@@ -255,7 +279,7 @@ class CLIManager
}
else
{
- cleanArgs = (String[]) cleaned.toArray( new String[cleanedSz] );
+ cleanArgs = cleaned.toArray( new String[cleanedSz] );
}
return cleanArgs;
diff --git a/src/main/java/org/apache/maven/doxia/cli/ConverterCli.java b/src/main/java/org/apache/maven/doxia/cli/ConverterCli.java
index 1901ffc..239ba7c 100644
--- a/src/main/java/org/apache/maven/doxia/cli/ConverterCli.java
+++ b/src/main/java/org/apache/maven/doxia/cli/ConverterCli.java
@@ -41,7 +41,6 @@ import org.codehaus.plexus.util.Os;
* Doxia converter CLI.
*
* @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
- * @version $Id$
*/
public class ConverterCli
{
@@ -154,13 +153,7 @@ public class ConverterCli
return 1;
}
- catch ( UnsupportedEncodingException e )
- {
- showFatalError( e.getMessage(), e, showErrors );
-
- return 1;
- }
- catch ( FileNotFoundException e )
+ catch ( UnsupportedEncodingException | FileNotFoundException e )
{
showFatalError( e.getMessage(), e, showErrors );
diff --git a/src/main/java/org/apache/maven/doxia/util/ConverterUtil.java b/src/main/java/org/apache/maven/doxia/util/ConverterUtil.java
index 5701282..2e3c1dd 100644
--- a/src/main/java/org/apache/maven/doxia/util/ConverterUtil.java
+++ b/src/main/java/org/apache/maven/doxia/util/ConverterUtil.java
@@ -29,7 +29,6 @@ import org.codehaus.plexus.component.repository.exception.ComponentLookupExcepti
* Utility class to play with Doxia objects.
*
* @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
- * @version $Id$
*/
public class ConverterUtil
{
diff --git a/src/main/java/org/apache/maven/doxia/wrapper/AbstractFileWrapper.java b/src/main/java/org/apache/maven/doxia/wrapper/AbstractFileWrapper.java
index 513ad33..b84ce1f 100644
--- a/src/main/java/org/apache/maven/doxia/wrapper/AbstractFileWrapper.java
+++ b/src/main/java/org/apache/maven/doxia/wrapper/AbstractFileWrapper.java
@@ -34,7 +34,6 @@ import com.ibm.icu.text.CharsetDetector;
* Abstract File wrapper for Doxia converter.
*
* @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
- * @version $Id$
*/
abstract class AbstractFileWrapper
extends AbstractWrapper
@@ -145,6 +144,7 @@ abstract class AbstractFileWrapper
}
/** {@inheritDoc} */
+ @Override
public boolean equals( Object other )
{
if ( this == other )
@@ -165,6 +165,7 @@ abstract class AbstractFileWrapper
}
/** {@inheritDoc} */
+ @Override
public int hashCode()
{
final int result = super.hashCode();
@@ -174,6 +175,7 @@ abstract class AbstractFileWrapper
}
/** {@inheritDoc} */
+ @Override
public java.lang.String toString()
{
StringBuilder buf = new StringBuilder( super.toString() + "\n" );
diff --git a/src/main/java/org/apache/maven/doxia/wrapper/AbstractWrapper.java b/src/main/java/org/apache/maven/doxia/wrapper/AbstractWrapper.java
index d5fd39d..807325a 100644
--- a/src/main/java/org/apache/maven/doxia/wrapper/AbstractWrapper.java
+++ b/src/main/java/org/apache/maven/doxia/wrapper/AbstractWrapper.java
@@ -27,7 +27,6 @@ import org.codehaus.plexus.util.StringUtils;
* Abstract wrapper for Doxia converter.
*
* @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
- * @version $Id$
*/
abstract class AbstractWrapper
implements Serializable
@@ -86,6 +85,7 @@ abstract class AbstractWrapper
}
/** {@inheritDoc} */
+ @Override
public boolean equals( Object other )
{
if ( this == other )
@@ -106,6 +106,7 @@ abstract class AbstractWrapper
}
/** {@inheritDoc} */
+ @Override
public int hashCode()
{
final int result = 17;
@@ -115,6 +116,7 @@ abstract class AbstractWrapper
}
/** {@inheritDoc} */
+ @Override
public java.lang.String toString()
{
StringBuilder buf = new StringBuilder();
diff --git a/src/main/java/org/apache/maven/doxia/wrapper/InputFileWrapper.java b/src/main/java/org/apache/maven/doxia/wrapper/InputFileWrapper.java
index 578b254..586cc9d 100644
--- a/src/main/java/org/apache/maven/doxia/wrapper/InputFileWrapper.java
+++ b/src/main/java/org/apache/maven/doxia/wrapper/InputFileWrapper.java
@@ -26,7 +26,6 @@ import java.io.UnsupportedEncodingException;
* Wrapper for an input file.
*
* @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
- * @version $Id$
*/
public class InputFileWrapper
extends AbstractFileWrapper
diff --git a/src/main/java/org/apache/maven/doxia/wrapper/InputReaderWrapper.java b/src/main/java/org/apache/maven/doxia/wrapper/InputReaderWrapper.java
index ba58362..6aedafe 100644
--- a/src/main/java/org/apache/maven/doxia/wrapper/InputReaderWrapper.java
+++ b/src/main/java/org/apache/maven/doxia/wrapper/InputReaderWrapper.java
@@ -25,7 +25,6 @@ import java.io.Reader;
* Wrapper for an input reader.
*
* @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
- * @version $Id$
*/
public class InputReaderWrapper
extends AbstractWrapper
diff --git a/src/main/java/org/apache/maven/doxia/wrapper/OutputFileWrapper.java b/src/main/java/org/apache/maven/doxia/wrapper/OutputFileWrapper.java
index 3e35fb2..929ea8b 100644
--- a/src/main/java/org/apache/maven/doxia/wrapper/OutputFileWrapper.java
+++ b/src/main/java/org/apache/maven/doxia/wrapper/OutputFileWrapper.java
@@ -28,7 +28,6 @@ import org.codehaus.plexus.util.WriterFactory;
* Wrapper for an output file.
*
* @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
- * @version $Id$
*/
public class OutputFileWrapper
extends AbstractFileWrapper
diff --git a/src/main/java/org/apache/maven/doxia/wrapper/OutputStreamWrapper.java b/src/main/java/org/apache/maven/doxia/wrapper/OutputStreamWrapper.java
index 471c7b7..77cfbea 100644
--- a/src/main/java/org/apache/maven/doxia/wrapper/OutputStreamWrapper.java
+++ b/src/main/java/org/apache/maven/doxia/wrapper/OutputStreamWrapper.java
@@ -27,7 +27,6 @@ import org.codehaus.plexus.util.StringUtils;
* Wrapper for an output stream.
*
* @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
- * @version $Id$
*/
public class OutputStreamWrapper
extends AbstractWrapper
diff --git a/src/test/java/org/apache/maven/doxia/ConverterTest.java b/src/test/java/org/apache/maven/doxia/ConverterTest.java
index 667cb31..71e7b0f 100644
--- a/src/test/java/org/apache/maven/doxia/ConverterTest.java
+++ b/src/test/java/org/apache/maven/doxia/ConverterTest.java
@@ -53,6 +53,7 @@ public class ConverterTest
private boolean formatOutput;
/** {@inheritDoc} */
+ @Override
protected void setUp()
throws Exception
{
@@ -64,6 +65,7 @@ public class ConverterTest
}
/** {@inheritDoc} */
+ @Override
protected void tearDown()
throws Exception
{