Author: khmarbaise
Date: Sun Oct 4 19:37:01 2015
New Revision: 1706718
URL: http://svn.apache.org/viewvc?rev=1706718&view=rev
Log:
Cleaned up checkstyle issues.
Modified:
maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/Expand.java
maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/cli/javatool/AbstractJavaTool.java
maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/cli/shell/CmdShell.java
maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/cli/shell/CommandShell.java
maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/cli/shell/Shell.java
maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/introspection/ClassMap.java
maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/introspection/ReflectionValueExtractor.java
maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/io/DirectoryScanResult.java
maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/io/DirectoryWalkListener.java
maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/io/IOUtil.java
maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/io/Java7Support.java
maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/io/MatchPattern.java
maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/io/MatchPatterns.java
maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/io/ScanConductor.java
maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/io/SelectorUtils.java
maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/io/WalkCollector.java
maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/xml/PrettyPrintXMLWriter.java
maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/xml/XMLWriter.java
maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/xml/XmlStreamReader.java
maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/xml/XmlStreamWriter.java
maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/xml/Xpp3Dom.java
maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/xml/Xpp3DomBuilder.java
Modified:
maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/Expand.java
URL:
http://svn.apache.org/viewvc/maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/Expand.java?rev=1706718&r1=1706717&r2=1706718&view=diff
==============================================================================
---
maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/Expand.java
(original)
+++
maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/Expand.java
Sun Oct 4 19:37:01 2015
@@ -105,11 +105,11 @@ class Expand
* <p/>
* <p><b>Note:</b> we kept this protected method for the sake of backward
compatibility!</p>
*
- * @param srcFile
- * @param dest
- * @throws Exception
+ * @param srcFile The source file.
+ * @param destination The destination.
+ * @throws Exception In case of failure.
*/
- void expandFile( File srcFile, File dest )
+ void expandFile( File srcFile, File destination )
throws Exception
{
if ( source == null )
@@ -117,7 +117,7 @@ class Expand
throw new NullPointerException( "Source Archive must not be null!"
);
}
- File destDir = dest;
+ File destDir = destination;
if ( destDir == null )
{
destDir = new File( System.getProperty( "user.dir" ) );
Modified:
maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/cli/javatool/AbstractJavaTool.java
URL:
http://svn.apache.org/viewvc/maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/cli/javatool/AbstractJavaTool.java?rev=1706718&r1=1706717&r2=1706718&view=diff
==============================================================================
---
maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/cli/javatool/AbstractJavaTool.java
(original)
+++
maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/cli/javatool/AbstractJavaTool.java
Sun Oct 4 19:37:01 2015
@@ -126,6 +126,9 @@ public abstract class AbstractJavaTool<R
return result;
}
+ /**
+ * @return {@link InputStream}
+ */
protected InputStream createSystemInputStream()
{
InputStream systemIn = new InputStream()
@@ -143,6 +146,11 @@ public abstract class AbstractJavaTool<R
return systemIn;
}
+ /**
+ * @param cli {@link Commandline}
+ * @param request {@link Request}
+ * @return {@link JavaToolRequest}
+ */
protected JavaToolResult executeCommandLine( Commandline cli, Request
request )
{
if ( getLogger().isDebugEnabled() )
@@ -174,6 +182,10 @@ public abstract class AbstractJavaTool<R
return result;
}
+ /**
+ * @param request {@link Request}
+ * @return {@link StreamConsumer}
+ */
protected StreamConsumer createSystemErrorStreamConsumer( Request request )
{
StreamConsumer systemErr = request.getSystemErrorStreamConsumer();
@@ -196,6 +208,10 @@ public abstract class AbstractJavaTool<R
return systemErr;
}
+ /**
+ * @param request {@link Request}
+ * @return {@link StreamConsumer}
+ */
protected StreamConsumer createSystemOutStreamConsumer( Request request )
{
StreamConsumer systemOut = request.getSystemOutStreamConsumer();
Modified:
maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/cli/shell/CmdShell.java
URL:
http://svn.apache.org/viewvc/maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/cli/shell/CmdShell.java?rev=1706718&r1=1706717&r2=1706718&view=diff
==============================================================================
---
maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/cli/shell/CmdShell.java
(original)
+++
maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/cli/shell/CmdShell.java
Sun Oct 4 19:37:01 2015
@@ -33,6 +33,9 @@ import java.util.List;
public class CmdShell
extends Shell
{
+ /**
+ * Create an instance of CmdShell.
+ */
public CmdShell()
{
setShellCommand( "cmd.exe" );
Modified:
maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/cli/shell/CommandShell.java
URL:
http://svn.apache.org/viewvc/maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/cli/shell/CommandShell.java?rev=1706718&r1=1706717&r2=1706718&view=diff
==============================================================================
---
maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/cli/shell/CommandShell.java
(original)
+++
maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/cli/shell/CommandShell.java
Sun Oct 4 19:37:01 2015
@@ -31,6 +31,9 @@ package org.apache.maven.shared.utils.cl
public class CommandShell
extends Shell
{
+ /**
+ * Create an instance.
+ */
public CommandShell()
{
setShellCommand( "command.com" );
Modified:
maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/cli/shell/Shell.java
URL:
http://svn.apache.org/viewvc/maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/cli/shell/Shell.java?rev=1706718&r1=1706717&r2=1706718&view=diff
==============================================================================
---
maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/cli/shell/Shell.java
(original)
+++
maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/cli/shell/Shell.java
Sun Oct 4 19:37:01 2015
@@ -116,26 +116,26 @@ public class Shell
/**
* Get the command line for the provided executable and arguments in this
shell
*
- * @param executable executable that the shell has to call
- * @param arguments arguments for the executable, not the shell
+ * @param executableParameter executable that the shell has to call
+ * @param argumentsParameter arguments for the executable, not the shell
* @return List with one String object with executable and arguments
quoted as needed
*/
- List<String> getCommandLine( String executable, String... arguments )
+ List<String> getCommandLine( String executableParameter, String...
argumentsParameter )
{
- return getRawCommandLine( executable, arguments );
+ return getRawCommandLine( executableParameter, argumentsParameter );
}
/**
- * @param executable Executable.
- * @param arguments The arguments for the executable.
+ * @param executableParameter Executable.
+ * @param argumentsParameter The arguments for the executable.
* @return The list on command line.
*/
- List<String> getRawCommandLine( String executable, String... arguments )
+ List<String> getRawCommandLine( String executableParameter, String...
argumentsParameter )
{
List<String> commandLine = new ArrayList<String>();
StringBuilder sb = new StringBuilder();
- if ( executable != null )
+ if ( executableParameter != null )
{
String preamble = getExecutionPreamble();
if ( preamble != null )
@@ -156,7 +156,7 @@ public class Shell
sb.append( getExecutable() );
}
}
- for ( String argument : arguments )
+ for ( String argument : argumentsParameter )
{
if ( sb.length() > 0 )
{
@@ -237,11 +237,11 @@ public class Shell
}
/**
- * @param argQuoteDelimiter {@link #argQuoteDelimiter}
+ * @param argQuoteDelimiterParameter {@link #argQuoteDelimiter}
*/
- void setArgumentQuoteDelimiter( char argQuoteDelimiter )
+ void setArgumentQuoteDelimiter( char argQuoteDelimiterParameter )
{
- this.argQuoteDelimiter = argQuoteDelimiter;
+ this.argQuoteDelimiter = argQuoteDelimiterParameter;
}
char getArgumentQuoteDelimiter()
@@ -250,11 +250,11 @@ public class Shell
}
/**
- * @param exeQuoteDelimiter {@link #exeQuoteDelimiter}
+ * @param exeQuoteDelimiterParameter {@link #exeQuoteDelimiter}
*/
- void setExecutableQuoteDelimiter( char exeQuoteDelimiter )
+ void setExecutableQuoteDelimiter( char exeQuoteDelimiterParameter )
{
- this.exeQuoteDelimiter = exeQuoteDelimiter;
+ this.exeQuoteDelimiter = exeQuoteDelimiterParameter;
}
char getExecutableQuoteDelimiter()
Modified:
maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/introspection/ClassMap.java
URL:
http://svn.apache.org/viewvc/maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/introspection/ClassMap.java?rev=1706718&r1=1706717&r2=1706718&view=diff
==============================================================================
---
maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/introspection/ClassMap.java
(original)
+++
maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/introspection/ClassMap.java
Sun Oct 4 19:37:01 2015
@@ -62,6 +62,7 @@ public class ClassMap
/**
* Standard constructor
+ * @param clazz The class.
*/
public ClassMap( Class<?> clazz )
{
@@ -88,6 +89,10 @@ public class ClassMap
* <p/>
* If nothing is found, then we must actually go
* and introspect the method from the MethodMap.
+ * @param name Method name.
+ * @param params Method parameters.
+ * @return The found method.
+ * @throws MethodMap.AmbiguousException in case of duplicate methods.
*/
public Method findMethod( String name, Object... params )
throws MethodMap.AmbiguousException
Modified:
maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/introspection/ReflectionValueExtractor.java
URL:
http://svn.apache.org/viewvc/maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/introspection/ReflectionValueExtractor.java?rev=1706718&r1=1706717&r2=1706718&view=diff
==============================================================================
---
maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/introspection/ReflectionValueExtractor.java
(original)
+++
maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/introspection/ReflectionValueExtractor.java
Sun Oct 4 19:37:01 2015
@@ -181,6 +181,7 @@ public class ReflectionValueExtractor
*
* @param expression not null expression
* @param root not null object
+ * @param trimRootToken trim root token yes/no.
* @return the object defined by the expression
* @throws IntrospectionException if any
*/
Modified:
maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/io/DirectoryScanResult.java
URL:
http://svn.apache.org/viewvc/maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/io/DirectoryScanResult.java?rev=1706718&r1=1706717&r2=1706718&view=diff
==============================================================================
---
maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/io/DirectoryScanResult.java
(original)
+++
maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/io/DirectoryScanResult.java
Sun Oct 4 19:37:01 2015
@@ -30,6 +30,10 @@ public class DirectoryScanResult
private final String[] filesRemoved;
+ /**
+ * @param filesAdded Added files.
+ * @param filesRemoved Removed files.
+ */
public DirectoryScanResult( String[] filesAdded, String[] filesRemoved )
{
this.filesAdded = filesAdded;
Modified:
maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/io/DirectoryWalkListener.java
URL:
http://svn.apache.org/viewvc/maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/io/DirectoryWalkListener.java?rev=1706718&r1=1706717&r2=1706718&view=diff
==============================================================================
---
maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/io/DirectoryWalkListener.java
(original)
+++
maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/io/DirectoryWalkListener.java
Sun Oct 4 19:37:01 2015
@@ -48,5 +48,8 @@ public interface DirectoryWalkListener
*/
void directoryWalkFinished();
+ /**
+ * @param message The message for the debugging output.
+ */
void debug( String message );
}
Modified:
maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/io/IOUtil.java
URL:
http://svn.apache.org/viewvc/maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/io/IOUtil.java?rev=1706718&r1=1706717&r2=1706718&view=diff
==============================================================================
---
maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/io/IOUtil.java
(original)
+++
maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/io/IOUtil.java
Sun Oct 4 19:37:01 2015
@@ -133,7 +133,9 @@ public final class IOUtil
/**
* Copy bytes from an <code>InputStream</code> to an
<code>OutputStream</code>.
- * @throws IOException
+ * @param input The input size.
+ * @param output The resulting output.
+ * @throws IOException in case of an error.
*/
public static void copy( @Nonnull final InputStream input, @Nonnull final
OutputStream output )
throws IOException
@@ -144,8 +146,10 @@ public final class IOUtil
/**
* Copy bytes from an <code>InputStream</code> to an
<code>OutputStream</code>.
*
+ * @param input The input size.
+ * @param output The resulting output.
* @param bufferSize Size of internal buffer to use.
- * @throws IOException
+ * @throws IOException in case of an error.
*/
public static void copy( @Nonnull final InputStream input, @Nonnull final
OutputStream output,
final int bufferSize )
@@ -161,6 +165,8 @@ public final class IOUtil
/**
* Copy chars from a <code>Reader</code> to a <code>Writer</code>.
+ * @param input The input size.
+ * @param output The resulting output.
* @throws IOException in case of failure.
*/
public static void copy( @Nonnull final Reader input, @Nonnull final
Writer output )
@@ -172,6 +178,8 @@ public final class IOUtil
/**
* Copy chars from a <code>Reader</code> to a <code>Writer</code>.
*
+ * @param input The input size.
+ * @param output The resulting output.
* @param bufferSize Size of internal buffer to use.
* @throws IOException in case of failure.
*/
@@ -199,6 +207,8 @@ public final class IOUtil
* Copy and convert bytes from an <code>InputStream</code> to chars on a
* <code>Writer</code>.
* The platform's default encoding is used for the byte-to-char conversion.
+ * @param input The input size.
+ * @param output The resulting output.
* @throws IOException in case of failure.
*/
public static void copy( @Nonnull final InputStream input, @Nonnull final
Writer output )
@@ -212,6 +222,8 @@ public final class IOUtil
* <code>Writer</code>.
* The platform's default encoding is used for the byte-to-char conversion.
*
+ * @param input The input size.
+ * @param output The resulting output.
* @param bufferSize Size of internal buffer to use.
* @throws IOException in case of failure.
*/
@@ -226,6 +238,8 @@ public final class IOUtil
* Copy and convert bytes from an <code>InputStream</code> to chars on a
* <code>Writer</code>, using the specified encoding.
*
+ * @param input The input size.
+ * @param output The resulting output.
* @param encoding The name of a supported character encoding. See the
* <a
href="http://www.iana.org/assignments/character-sets";>IANA
* Charset Registry</a> for a list of valid encoding types.
@@ -246,6 +260,8 @@ public final class IOUtil
* @param encoding The name of a supported character encoding. See the
* <a
href="http://www.iana.org/assignments/character-sets";>IANA
* Charset Registry</a> for a list of valid encoding
types.
+ * @param input The input size.
+ * @param output The resulting output.
* @param bufferSize Size of internal buffer to use.
* @throws IOException in case of failure.
*/
@@ -263,6 +279,8 @@ public final class IOUtil
/**
* Get the contents of an <code>InputStream</code> as a String.
* The platform's default encoding is used for the byte-to-char conversion.
+ * @param input The input size.
+ * @return The resulting string.
* @throws IOException in case of failure.
*/
@Nonnull public static String toString( @Nonnull final InputStream input )
@@ -275,7 +293,9 @@ public final class IOUtil
* Get the contents of an <code>InputStream</code> as a String.
* The platform's default encoding is used for the byte-to-char conversion.
*
+ * @param input The input size.
* @param bufferSize Size of internal buffer to use.
+ * @return the resulting string.
* @throws IOException in case of failure.
*/
@Nonnull public static String toString( @Nonnull final InputStream input,
final int bufferSize )
@@ -289,9 +309,11 @@ public final class IOUtil
/**
* Get the contents of an <code>InputStream</code> as a String.
*
+ * @param input The input size.
* @param encoding The name of a supported character encoding. See the
* <a
href="http://www.iana.org/assignments/character-sets";>IANA
* Charset Registry</a> for a list of valid encoding types.
+ * @return the converted string.
* @throws IOException in case of failure.
*/
@Nonnull public static String toString( @Nonnull final InputStream input,
@Nonnull final String encoding )
@@ -303,10 +325,12 @@ public final class IOUtil
/**
* Get the contents of an <code>InputStream</code> as a String.
*
+ * @param input The input size.
* @param encoding The name of a supported character encoding. See the
* <a
href="http://www.iana.org/assignments/character-sets";>IANA
* Charset Registry</a> for a list of valid encoding
types.
* @param bufferSize Size of internal buffer to use.
+ * @return The converted string.
* @throws IOException in case of failure.
*/
@Nonnull public static String toString( @Nonnull final InputStream input,
@Nonnull final String encoding,
@@ -323,6 +347,8 @@ public final class IOUtil
/**
* Get the contents of an <code>InputStream</code> as a
<code>byte[]</code>.
+ * @param input The input size.
+ * @return the resulting byte array.
* @throws IOException in case of failure.
*/
@Nonnull public static byte[] toByteArray( @Nonnull final InputStream
input )
@@ -334,7 +360,9 @@ public final class IOUtil
/**
* Get the contents of an <code>InputStream</code> as a
<code>byte[]</code>.
*
+ * @param input The input size.
* @param bufferSize Size of internal buffer to use.
+ * @return the resulting byte array.
* @throws IOException in case of failure.
*/
@Nonnull public static byte[] toByteArray( @Nonnull final InputStream
input, final int bufferSize )
@@ -356,6 +384,8 @@ public final class IOUtil
/**
* Serialize chars from a <code>Reader</code> to bytes on an
<code>OutputStream</code>, and
* flush the <code>OutputStream</code>.
+ * @param input The input size.
+ * @param output The resulting output.
* @throws IOException in case of failure.
*/
public static void copy( @Nonnull final Reader input, @Nonnull final
OutputStream output )
@@ -368,6 +398,8 @@ public final class IOUtil
* Serialize chars from a <code>Reader</code> to bytes on an
<code>OutputStream</code>, and
* flush the <code>OutputStream</code>.
*
+ * @param input The input size.
+ * @param output The resulting output.
* @param bufferSize Size of internal buffer to use.
* @throws IOException in case of failure.
*/
@@ -386,6 +418,8 @@ public final class IOUtil
/**
* Get the contents of a <code>Reader</code> as a String.
+ * @param input The input size.
+ * @return The converted string.
* @throws IOException in case of failure.
*/
@Nonnull public static String toString( @Nonnull final Reader input )
@@ -397,7 +431,9 @@ public final class IOUtil
/**
* Get the contents of a <code>Reader</code> as a String.
*
+ * @param input The input size.
* @param bufferSize Size of internal buffer to use.
+ * @return the resulting byte array.
* @throws IOException in case of failure.
*/
@Nonnull public static String toString( @Nonnull final Reader input, final
int bufferSize )
@@ -413,6 +449,8 @@ public final class IOUtil
/**
* Get the contents of a <code>Reader</code> as a <code>byte[]</code>.
+ * @param input The input size.
+ * @return the resulting byte array.
* @throws IOException in case of failure.
*/
@Nonnull public static byte[] toByteArray( @Nonnull final Reader input )
@@ -424,7 +462,9 @@ public final class IOUtil
/**
* Get the contents of a <code>Reader</code> as a <code>byte[]</code>.
*
+ * @param input The input size.
* @param bufferSize Size of internal buffer to use.
+ * @return the resulting byte array.
* @throws IOException in case of failure.
*/
@Nonnull public static byte[] toByteArray( @Nonnull final Reader input,
final int bufferSize )
@@ -446,6 +486,8 @@ public final class IOUtil
/**
* Serialize chars from a <code>String</code> to bytes on an
<code>OutputStream</code>, and
* flush the <code>OutputStream</code>.
+ * @param input The input size.
+ * @param output The resulting output.
* @throws IOException in case of failure.
*/
public static void copy( @Nonnull final String input, @Nonnull final
OutputStream output )
@@ -458,6 +500,8 @@ public final class IOUtil
* Serialize chars from a <code>String</code> to bytes on an
<code>OutputStream</code>, and
* flush the <code>OutputStream</code>.
*
+ * @param input The input size.
+ * @param output The resulting output.
* @param bufferSize Size of internal buffer to use.
* @throws IOException in case of failure.
*/
@@ -492,6 +536,8 @@ public final class IOUtil
/**
* Get the contents of a <code>String</code> as a <code>byte[]</code>.
+ * @param input The input size.
+ * @return The resulting byte array.
* @throws IOException in case of failure.
*/
@Nonnull public static byte[] toByteArray( @Nonnull final String input )
@@ -503,7 +549,9 @@ public final class IOUtil
/**
* Get the contents of a <code>String</code> as a <code>byte[]</code>.
*
+ * @param input The input size.
* @param bufferSize Size of internal buffer to use.
+ * @return The resulting byte array.
* @throws IOException in case of failure.
*/
@Nonnull public static byte[] toByteArray( @Nonnull final String input,
final int bufferSize )
@@ -526,6 +574,8 @@ public final class IOUtil
* Copy and convert bytes from a <code>byte[]</code> to chars on a
* <code>Writer</code>.
* The platform's default encoding is used for the byte-to-char conversion.
+ * @param input The input size.
+ * @param output The resulting output.
* @throws IOException in case of failure.
*/
public static void copy( @Nonnull final byte[] input, @Nonnull final
Writer output )
@@ -539,6 +589,8 @@ public final class IOUtil
* <code>Writer</code>.
* The platform's default encoding is used for the byte-to-char conversion.
*
+ * @param input The input size.
+ * @param output The resulting output.
* @param bufferSize Size of internal buffer to use.
* @throws IOException in case of failure.
*/
@@ -556,6 +608,8 @@ public final class IOUtil
* @param encoding The name of a supported character encoding. See the
* <a
href="http://www.iana.org/assignments/character-sets";>IANA
* Charset Registry</a> for a list of valid encoding types.
+ * @param input The input size.
+ * @param output The resulting output.
* @throws IOException in case of failure.
*/
public static void copy( @Nonnull final byte[] input, @Nonnull final
Writer output, final String encoding )
@@ -572,6 +626,8 @@ public final class IOUtil
* @param encoding The name of a supported character encoding. See the
* <a
href="http://www.iana.org/assignments/character-sets";>IANA
* Charset Registry</a> for a list of valid encoding
types.
+ * @param input The input bytes.
+ * @param output The output buffer {@link Writer}
* @param bufferSize Size of internal buffer to use.
* @throws IOException in case of failure.
*/
@@ -589,6 +645,8 @@ public final class IOUtil
/**
* Get the contents of a <code>byte[]</code> as a String.
* The platform's default encoding is used for the byte-to-char conversion.
+ * @param input The input bytes.
+ * @return The resulting string.
* @throws IOException in case of failure.
*/
@Nonnull public static String toString( @Nonnull final byte[] input )
@@ -602,6 +660,8 @@ public final class IOUtil
* The platform's default encoding is used for the byte-to-char conversion.
*
* @param bufferSize Size of internal buffer to use.
+ * @param input The input bytes.
+ * @return The created string.
* @throws IOException in case of failure.
*/
@Nonnull public static String toString( @Nonnull final byte[] input, final
int bufferSize )
@@ -618,6 +678,8 @@ public final class IOUtil
* @param encoding The name of a supported character encoding. See the
* <a
href="http://www.iana.org/assignments/character-sets";>IANA
* Charset Registry</a> for a list of valid encoding types.
+ * @param input The input bytes.
+ * @return The resulting string.
* @throws IOException in case of failure.
*/
@Nonnull public static String toString( @Nonnull final byte[] input,
@Nonnull final String encoding )
@@ -633,6 +695,8 @@ public final class IOUtil
* <a
href="http://www.iana.org/assignments/character-sets";>IANA
* Charset Registry</a> for a list of valid encoding
types.
* @param bufferSize Size of internal buffer to use.
+ * @param input Input bytes.
+ * @return The resulting string.
* @throws IOException in case of failure.
*/
@Nonnull public static String toString( @Nonnull final byte[] input,
@Nonnull final String encoding,
@@ -649,6 +713,8 @@ public final class IOUtil
/**
* Copy bytes from a <code>byte[]</code> to an <code>OutputStream</code>.
+ * @param input Input byte array.
+ * @param output output stream {@link OutputStream}
* @throws IOException in case of failure.
*/
public static void copy( @Nonnull final byte[] input, @Nonnull final
OutputStream output )
Modified:
maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/io/Java7Support.java
URL:
http://svn.apache.org/viewvc/maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/io/Java7Support.java?rev=1706718&r1=1706717&r2=1706718&view=diff
==============================================================================
---
maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/io/Java7Support.java
(original)
+++
maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/io/Java7Support.java
Sun Oct 4 19:37:01 2015
@@ -87,6 +87,10 @@ public class Java7Support
IS_JAVA7 = isJava7x;
}
+ /**
+ * @param file The file to check for being a symbolic link.
+ * @return true if the file is a symlink false otherwise.
+ */
public static boolean isSymLink( @Nonnull File file )
{
try
@@ -105,6 +109,11 @@ public class Java7Support
}
+ /**
+ * @param symlink The sym link.
+ * @return The file.
+ * @throws IOException in case of error.
+ */
@Nonnull public static File readSymbolicLink( @Nonnull File symlink )
throws IOException
{
@@ -125,6 +134,11 @@ public class Java7Support
}
+ /**
+ * @param file The file to check.
+ * @return true if exist false otherwise.
+ * @throws IOException in case of failure.
+ */
public static boolean exists( @Nonnull File file )
throws IOException
{
@@ -145,6 +159,12 @@ public class Java7Support
}
+ /**
+ * @param symlink The link name.
+ * @param target The target.
+ * @return The linked file.
+ * @throws IOException in case of an error.
+ */
@Nonnull public static File createSymbolicLink( @Nonnull File symlink,
@Nonnull File target )
throws IOException
{
@@ -185,7 +205,7 @@ public class Java7Support
/**
* Performs a nio delete
* @param file the file to delete
- * @throws IOException
+ * @throws IOException in case of error.
*/
public static void delete( @Nonnull File file )
throws IOException
@@ -205,11 +225,17 @@ public class Java7Support
}
}
+ /**
+ * @return true in case of Java 7.
+ */
public static boolean isJava7()
{
return IS_JAVA7;
}
+ /**
+ * @return true in case of Java7 or greater.
+ */
public static boolean isAtLeastJava7()
{
return IS_JAVA7;
Modified:
maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/io/MatchPattern.java
URL:
http://svn.apache.org/viewvc/maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/io/MatchPattern.java?rev=1706718&r1=1706717&r2=1706718&view=diff
==============================================================================
---
maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/io/MatchPattern.java
(original)
+++
maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/io/MatchPattern.java
Sun Oct 4 19:37:01 2015
@@ -60,6 +60,11 @@ public class MatchPattern
}
+ /**
+ * @param str The string to match for.
+ * @param isCaseSensitive case sensitive true false otherwise.
+ * @return true if matches false otherwise.
+ */
public boolean matchPath( String str, boolean isCaseSensitive )
{
if ( regexPattern != null )
@@ -84,6 +89,11 @@ public class MatchPattern
}
}
+ /**
+ * @param str The string to check.
+ * @param isCaseSensitive Check case sensitive or not.
+ * @return true in case of matching pattern.
+ */
public boolean matchPatternStart( @Nonnull String str, boolean
isCaseSensitive )
{
if ( regexPattern != null )
@@ -101,12 +111,19 @@ public class MatchPattern
}
}
+ /**
+ * @return Tokenized string.
+ */
public String[] getTokenizedPathString()
{
return tokenized;
}
+ /**
+ * @param string The part which will be checked to start with.
+ * @return true in case of starting with the string false otherwise.
+ */
public boolean startsWith( String string )
{
return source.startsWith( string );
@@ -124,6 +141,10 @@ public class MatchPattern
return ret.toArray( new String[ret.size()] );
}
+ /**
+ * @param source The source.
+ * @return The match pattern.
+ */
public static MatchPattern fromString( String source )
{
return new MatchPattern( source, File.separator );
Modified:
maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/io/MatchPatterns.java
URL:
http://svn.apache.org/viewvc/maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/io/MatchPatterns.java?rev=1706718&r1=1706717&r2=1706718&view=diff
==============================================================================
---
maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/io/MatchPatterns.java
(original)
+++
maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/io/MatchPatterns.java
Sun Oct 4 19:37:01 2015
@@ -59,6 +59,11 @@ public class MatchPatterns
return false;
}
+ /**
+ * @param name The name.
+ * @param isCaseSensitive being case sensetive.
+ * @return true if any of the supplied patterns match start.
+ */
public boolean matchesPatternStart( @Nonnull String name, boolean
isCaseSensitive )
{
for ( MatchPattern includesPattern : patterns )
@@ -71,6 +76,10 @@ public class MatchPatterns
return false;
}
+ /**
+ * @param sources The sources
+ * @return Converted match patterns.
+ */
public static MatchPatterns from( @Nonnull String... sources )
{
final int length = sources.length;
Modified:
maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/io/ScanConductor.java
URL:
http://svn.apache.org/viewvc/maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/io/ScanConductor.java?rev=1706718&r1=1706717&r2=1706718&view=diff
==============================================================================
---
maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/io/ScanConductor.java
(original)
+++
maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/io/ScanConductor.java
Sun Oct 4 19:37:01 2015
@@ -71,7 +71,7 @@ public interface ScanConductor
* This method will get invoked for every detected directory.
*
* @param name the directory name (contains parent folders up to the
pwd)
- * @param directory
+ * @param directory The directory.
* @return the ScanAction to control how to proceed with the scanning
*/
ScanAction visitDirectory( String name, File directory );
@@ -80,7 +80,7 @@ public interface ScanConductor
* This method will get invoked for every detected file.
*
* @param name the file name (contains parent folders up to the pwd)
- * @param file
+ * @param file The file.
* @return the ScanAction to control how to proceed with the scanning
*/
ScanAction visitFile( String name, File file );
Modified:
maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/io/SelectorUtils.java
URL:
http://svn.apache.org/viewvc/maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/io/SelectorUtils.java?rev=1706718&r1=1706717&r2=1706718&view=diff
==============================================================================
---
maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/io/SelectorUtils.java
(original)
+++
maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/io/SelectorUtils.java
Sun Oct 4 19:37:01 2015
@@ -43,12 +43,24 @@ import javax.annotation.Nonnull;
public final class SelectorUtils
{
+ /**
+ * Pattern handler prefix.
+ */
private static final String PATTERN_HANDLER_PREFIX = "[";
+ /**
+ * Pattern handler suffix.
+ */
public static final String PATTERN_HANDLER_SUFFIX = "]";
+ /**
+ * Regex start pattern.
+ */
public static final String REGEX_HANDLER_PREFIX = "%regex" +
PATTERN_HANDLER_PREFIX;
+ /**
+ * ANT pattern prefix.
+ */
public static final String ANT_HANDLER_PREFIX = "%ant" +
PATTERN_HANDLER_PREFIX;
/**
Modified:
maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/io/WalkCollector.java
URL:
http://svn.apache.org/viewvc/maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/io/WalkCollector.java?rev=1706718&r1=1706717&r2=1706718&view=diff
==============================================================================
---
maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/io/WalkCollector.java
(original)
+++
maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/io/WalkCollector.java
Sun Oct 4 19:37:01 2015
@@ -41,6 +41,9 @@ public class WalkCollector
int percentageHigh;
+ /**
+ * Create an instance.
+ */
public WalkCollector()
{
steps = new ArrayList<File>();
@@ -50,17 +53,20 @@ public class WalkCollector
percentageHigh = 0;
}
+ /** {@inheritDoc} */
public void debug( String message )
{
// can be used to set some message
}
+ /** {@inheritDoc} */
public void directoryWalkStarting( File basedir )
{
startingDir = basedir;
startCount++;
}
+ /** {@inheritDoc} */
public void directoryWalkStep( int percentage, File file )
{
steps.add( file );
@@ -68,6 +74,7 @@ public class WalkCollector
percentageHigh = Math.max( percentageHigh, percentage );
}
+ /** {@inheritDoc} */
public void directoryWalkFinished()
{
finishCount++;
Modified:
maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/xml/PrettyPrintXMLWriter.java
URL:
http://svn.apache.org/viewvc/maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/xml/PrettyPrintXMLWriter.java?rev=1706718&r1=1706717&r2=1706718&view=diff
==============================================================================
---
maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/xml/PrettyPrintXMLWriter.java
(original)
+++
maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/xml/PrettyPrintXMLWriter.java
Sun Oct 4 19:37:01 2015
@@ -28,6 +28,10 @@ import java.util.ArrayList;
/**
* XMLWriter with nice indentation
*/
+/**
+ * @author kama
+ *
+ */
public class PrettyPrintXMLWriter
implements XMLWriter
{
@@ -165,6 +169,7 @@ public class PrettyPrintXMLWriter
depth = 0;
}
+ /** {@inheritDoc} */
public void addAttribute( String key, String value )
{
if ( !processingElement )
@@ -178,6 +183,7 @@ public class PrettyPrintXMLWriter
XMLEncode.xmlEncodeTextAsPCDATA( value, true, '"', writer );
}
+ /** {@inheritDoc} */
public void setEncoding( String encoding )
{
if ( documentStarted )
@@ -188,6 +194,7 @@ public class PrettyPrintXMLWriter
this.encoding = encoding;
}
+ /** {@inheritDoc} */
public void setDocType( String docType )
{
if ( documentStarted )
@@ -198,6 +205,7 @@ public class PrettyPrintXMLWriter
this.docType = docType;
}
+ /** {@inheritDoc} */
public void setLineSeparator( String lineSeparator )
{
if ( documentStarted )
@@ -208,16 +216,18 @@ public class PrettyPrintXMLWriter
this.lineSeparator = lineSeparator.toCharArray();
}
- public void setLineIndenter( String lineIndent )
+ /** {@inheritDoc} */
+ public void setLineIndenter( String lineIndentParameter )
{
if ( documentStarted )
{
throw new IllegalStateException( "Document headers already
written!" );
}
- this.lineIndent = lineIndent.toCharArray();
+ this.lineIndent = lineIndentParameter.toCharArray();
}
+ /** {@inheritDoc} */
public void startElement( String elementName )
{
boolean firstLine = ensureDocumentStarted();
@@ -237,6 +247,7 @@ public class PrettyPrintXMLWriter
elementStack.add( depth++, elementName );
}
+ /** {@inheritDoc} */
public void writeText( String text )
{
ensureDocumentStarted();
@@ -248,6 +259,7 @@ public class PrettyPrintXMLWriter
endOnSameLine = true;
}
+ /** {@inheritDoc} */
public void writeMarkup( String markup )
{
ensureDocumentStarted();
@@ -257,6 +269,7 @@ public class PrettyPrintXMLWriter
writer.write( markup );
}
+ /** {@inheritDoc} */
public void endElement()
{
String chars = elementStack.get( --depth );
Modified:
maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/xml/XMLWriter.java
URL:
http://svn.apache.org/viewvc/maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/xml/XMLWriter.java?rev=1706718&r1=1706717&r2=1706718&view=diff
==============================================================================
---
maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/xml/XMLWriter.java
(original)
+++
maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/xml/XMLWriter.java
Sun Oct 4 19:37:01 2015
@@ -47,7 +47,7 @@ public interface XMLWriter
/**
* Start an XML Element tag.
- * @param name
+ * @param name The name of the tag.
*/
void startElement( String name );
@@ -55,8 +55,8 @@ public interface XMLWriter
/**
* Add a XML attribute to the current XML Element.
* This method must get called immediately after {@link
#startElement(String)}
- * @param key
- * @param value
+ * @param key The key of the attribute.
+ * @param value The value of the attribute.
* @throws IllegalStateException if no element tag is currently in process
*/
void addAttribute( String key, String value );
@@ -64,14 +64,14 @@ public interface XMLWriter
/**
* Add a value text to the current element tag
* This will perform XML escaping to guarantee valid content
- * @param text
+ * @param text The text which should be written.
* @throws IllegalStateException if no element tag got started yet
*/
void writeText( String text );
/**
* Add a preformatted markup to the current element tag
- * @param text
+ * @param text The text which should be written.
* @throws IllegalStateException if no element tag got started yet
*/
void writeMarkup( String text );
Modified:
maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/xml/XmlStreamReader.java
URL:
http://svn.apache.org/viewvc/maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/xml/XmlStreamReader.java?rev=1706718&r1=1706717&r2=1706718&view=diff
==============================================================================
---
maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/xml/XmlStreamReader.java
(original)
+++
maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/xml/XmlStreamReader.java
Sun Oct 4 19:37:01 2015
@@ -38,52 +38,93 @@ public class XmlStreamReader
private static String staticDefaultEncoding = null;
+ /**
+ * @param encoding define the default encoding.
+ */
public static void setDefaultEncoding( String encoding )
{
staticDefaultEncoding = encoding;
}
+ /**
+ * @return the default encoding.
+ */
public static String getDefaultEncoding()
{
return staticDefaultEncoding;
}
+ /**
+ * @param file The file to create it from.
+ * @throws IOException in case of an error.
+ */
public XmlStreamReader( File file )
throws IOException
{
this( new FileInputStream( file ) );
}
+ /**
+ * @param is {@link InputStream}
+ * @throws IOException in case of an error.
+ */
public XmlStreamReader( InputStream is )
throws IOException
{
this( is, true );
}
+ /**
+ * @param is {@link InputStream}
+ * @param lenient yes/no
+ * @throws IOException in case of an error.
+ * @throws XmlStreamReaderException in case of an error.
+ */
public XmlStreamReader( InputStream is, boolean lenient )
throws IOException, XmlStreamReaderException
{
reader = new org.apache.commons.io.input.XmlStreamReader( is, lenient,
staticDefaultEncoding );
}
+ /**
+ * @param url {@link URL}
+ * @throws IOException in case of error.
+ */
public XmlStreamReader( URL url )
throws IOException
{
this( url.openConnection() );
}
+ /**
+ * @param conn The URL connection {@link URLConnection}.
+ * @throws IOException in case of error.
+ */
public XmlStreamReader( URLConnection conn )
throws IOException
{
reader = new org.apache.commons.io.input.XmlStreamReader( conn,
staticDefaultEncoding );
}
+ /**
+ * @param is {@link InputStream}
+ * @param httpContentType content type.
+ * @throws IOException in case of error.
+ */
public XmlStreamReader( InputStream is, String httpContentType )
throws IOException
{
this( is, httpContentType, true );
}
+ /**
+ * @param is {@link InputStream}
+ * @param httpContentType content type.
+ * @param lenient yes/no.
+ * @param defaultEncoding The default encoding.
+ * @throws IOException in case of error.
+ * @throws XmlStreamReaderException in case of error.
+ */
public XmlStreamReader( InputStream is, String httpContentType, boolean
lenient, String defaultEncoding )
throws IOException, XmlStreamReaderException
{
@@ -93,23 +134,33 @@ public class XmlStreamReader
: defaultEncoding );
}
+ /**
+ * @param is {@link InputStream}
+ * @param httpContentType content type.
+ * @param lenient yes/no.
+ * @throws IOException in case of error.
+ * @throws XmlStreamReaderException in case of error.
+ */
public XmlStreamReader( InputStream is, String httpContentType, boolean
lenient )
throws IOException, XmlStreamReaderException
{
this( is, httpContentType, lenient, null );
}
+ /** {@inheritDoc} */
public String getEncoding()
{
return reader.getEncoding();
}
+ /** {@inheritDoc} */
public int read( char[] buf, int offset, int len )
throws IOException
{
return reader.read( buf, offset, len );
}
+ /** {@inheritDoc} */
public void close()
throws IOException
{
Modified:
maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/xml/XmlStreamWriter.java
URL:
http://svn.apache.org/viewvc/maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/xml/XmlStreamWriter.java?rev=1706718&r1=1706717&r2=1706718&view=diff
==============================================================================
---
maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/xml/XmlStreamWriter.java
(original)
+++
maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/xml/XmlStreamWriter.java
Sun Oct 4 19:37:01 2015
@@ -30,11 +30,18 @@ import java.io.OutputStream;
public class XmlStreamWriter
extends org.apache.commons.io.output.XmlStreamWriter
{
+ /**
+ * @param out {@link OutputStream}
+ */
public XmlStreamWriter( OutputStream out )
{
super( out );
}
+ /**
+ * @param file The file to use.
+ * @throws FileNotFoundException in case of not found file.
+ */
public XmlStreamWriter( File file )
throws FileNotFoundException
{
Modified:
maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/xml/Xpp3Dom.java
URL:
http://svn.apache.org/viewvc/maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/xml/Xpp3Dom.java?rev=1706718&r1=1706717&r2=1706718&view=diff
==============================================================================
---
maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/xml/Xpp3Dom.java
(original)
+++
maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/xml/Xpp3Dom.java
Sun Oct 4 19:37:01 2015
@@ -51,19 +51,34 @@ public class Xpp3Dom
private Xpp3Dom parent; // plexus: protected
+ /**
+ * The attribute which identifies merge/append.
+ */
public static final String CHILDREN_COMBINATION_MODE_ATTRIBUTE =
"combine.children";
private static final String CHILDREN_COMBINATION_MERGE = "merge";
+ /**
+ * The attribute append.
+ */
public static final String CHILDREN_COMBINATION_APPEND = "append";
@SuppressWarnings( "UnusedDeclaration" )
private static final String DEFAULT_CHILDREN_COMBINATION_MODE =
CHILDREN_COMBINATION_MERGE; // plexus: public
+ /**
+ * The name of the attribute.
+ */
public static final String SELF_COMBINATION_MODE_ATTRIBUTE =
"combine.self";
+ /**
+ * The attributes which identifies <code>override</code>.
+ */
public static final String SELF_COMBINATION_OVERRIDE = "override"; //
plexus: public
+ /**
+ * The attribute which identifies <code>merge</code>
+ */
public static final String SELF_COMBINATION_MERGE = "merge";
@SuppressWarnings( "UnusedDeclaration" )
@@ -72,6 +87,9 @@ public class Xpp3Dom
private static final String[] EMPTY_STRING_ARRAY = new String[0];
private static final Xpp3Dom[] EMPTY_DOM_ARRAY = new Xpp3Dom[0];
+ /**
+ * @param name The name of the instance.
+ */
public Xpp3Dom( String name )
{
this.name = name;
@@ -79,11 +97,20 @@ public class Xpp3Dom
childMap = new HashMap<String, Xpp3Dom>();
}
+ /**
+ * Create instance.
+ * @param source The source.
+ */
public Xpp3Dom( Xpp3Dom source )
{
this( source, source.getName() );
}
+ /**
+ * Create instance.
+ * @param src The source Dom.
+ * @param name The name of the Dom.
+ */
public Xpp3Dom( @Nonnull Xpp3Dom src, String name )
{
this.name = name;
@@ -105,22 +132,34 @@ public class Xpp3Dom
}
}
+ /**
+ * @return The current name.
+ */
public String getName()
{
return name;
}
+ /**
+ * @return The current value.
+ */
@Nonnull public String getValue()
{
return value;
}
+ /**
+ * @param value The value to be set.
+ */
public void setValue( @Nonnull String value )
{
this.value = value;
}
+ /**
+ * @return The array of attribute names.
+ */
public String[] getAttributeNames()
{
boolean isNothing = attributes == null || attributes.isEmpty();
@@ -128,19 +167,26 @@ public class Xpp3Dom
}
- public String getAttribute( String name )
+ /**
+ * @param nameParameter The name of the attribute.
+ * @return The attribute value.
+ */
+ public String getAttribute( String nameParameter )
+ {
+ return this.attributes != null ? this.attributes.get( nameParameter )
: null;
+ }
+
+ /**
+ * @param nameParameter The name of the attribute.
+ * @param valueParameter The value of the attribute.
+ */
+ public void setAttribute( @Nonnull String nameParameter, @Nonnull String
valueParameter )
{
- return attributes != null ? attributes.get( name ) : null;
- }
-
- @SuppressWarnings( "ConstantConditions" )
- public void setAttribute( @Nonnull String name, @Nonnull String value )
- {
- if ( value == null )
+ if ( valueParameter == null )
{
throw new NullPointerException( "value can not be null" );
}
- if ( name == null )
+ if ( nameParameter == null )
{
throw new NullPointerException( "name can not be null" );
}
@@ -149,19 +195,30 @@ public class Xpp3Dom
attributes = new HashMap<String, String>();
}
- attributes.put( name, value );
+ attributes.put( nameParameter, valueParameter );
}
+ /**
+ * @param i The index to be selected.
+ * @return The child selected by index.
+ */
public Xpp3Dom getChild( int i )
{
return childList.get( i );
}
- public Xpp3Dom getChild( String name )
- {
- return childMap.get( name );
+ /**
+ * @param nameParameter The name of the child.
+ * @return The child selected by name.
+ */
+ public Xpp3Dom getChild( String nameParameter )
+ {
+ return childMap.get( nameParameter );
}
+ /**
+ * @param child The child to be added.
+ */
public void addChild( Xpp3Dom child )
{
child.setParent( this );
@@ -169,6 +226,9 @@ public class Xpp3Dom
childMap.put( child.getName(), child );
}
+ /**
+ * @return The array of childs.
+ */
public Xpp3Dom[] getChildren()
{
boolean isNothing = childList == null || childList.isEmpty();
@@ -181,13 +241,17 @@ public class Xpp3Dom
return isNothing ? Collections.<Xpp3Dom>emptyList() : childList;
}
- public Xpp3Dom[] getChildren( String name )
+ /**
+ * @param nameParameter The name of the child.
+ * @return The array of the Dom.
+ */
+ public Xpp3Dom[] getChildren( String nameParameter )
{
- List<Xpp3Dom> children = getChildrenList( name );
+ List<Xpp3Dom> children = getChildrenList( nameParameter );
return children.toArray( new Xpp3Dom[children.size()] );
}
- List<Xpp3Dom> getChildrenList( String name )
+ List<Xpp3Dom> getChildrenList( String nameParameter )
{
if ( childList == null )
{
@@ -198,7 +262,7 @@ public class Xpp3Dom
ArrayList<Xpp3Dom> children = new ArrayList<Xpp3Dom>();
for ( Xpp3Dom aChildList : childList )
{
- if ( name.equals( aChildList.getName() ) )
+ if ( nameParameter.equals( aChildList.getName() ) )
{
children.add( aChildList );
}
@@ -207,6 +271,9 @@ public class Xpp3Dom
}
}
+ /**
+ * @return The number of childs.
+ */
public int getChildCount()
{
if ( childList == null )
@@ -217,6 +284,9 @@ public class Xpp3Dom
return childList.size();
}
+ /**
+ * @param i The child to be removed.
+ */
public void removeChild( int i )
{
Xpp3Dom child = childList.remove( i );
@@ -224,11 +294,17 @@ public class Xpp3Dom
child.setParent( null );
}
+ /**
+ * @return The current parent.
+ */
public Xpp3Dom getParent()
{
return parent;
}
+ /**
+ * @param parent Set the parent.
+ */
public void setParent( Xpp3Dom parent )
{
this.parent = parent;
@@ -243,16 +319,28 @@ public class Xpp3Dom
return Xpp3DomUtils.merge( dominant, recessive, childMergeOverride );
}
+ /**
+ * @param dominant The dominant part.
+ * @param recessive The recessive part.
+ * @param childMergeOverride true if child merge will take precedence
false otherwise.
+ * @return The merged Xpp3Dom.
+ */
public static Xpp3Dom mergeXpp3Dom( Xpp3Dom dominant, Xpp3Dom recessive,
Boolean childMergeOverride )
{
return Xpp3DomUtils.mergeXpp3Dom( dominant, recessive,
childMergeOverride );
}
+ /**
+ * @param dominant The dominant part.
+ * @param recessive The recessive part.
+ * @return The merged Xpp3Dom.
+ */
public static Xpp3Dom mergeXpp3Dom( Xpp3Dom dominant, Xpp3Dom recessive )
{
return Xpp3DomUtils.mergeXpp3Dom( dominant, recessive );
}
+ /** {@inheritDoc} */
public boolean equals( Object obj )
{
if ( obj == this )
@@ -273,6 +361,7 @@ public class Xpp3Dom
&& !( childList == null ? dom.childList != null :
!childList.equals( dom.childList ) );
}
+ /** {@inheritDoc} */
public int hashCode()
{
int result = 17;
@@ -283,6 +372,7 @@ public class Xpp3Dom
return result;
}
+ /** {@inheritDoc} */
public String toString()
{
StringWriter writer = new StringWriter();
@@ -291,6 +381,9 @@ public class Xpp3Dom
}
+ /**
+ * @return Unescaped string.
+ */
public String toUnescapedString()
{
StringWriter writer = new StringWriter();
@@ -303,16 +396,25 @@ public class Xpp3Dom
return new PrettyPrintXMLWriter( writer, "UTF-8", null );
}
+ /**
+ * @param str The string to be checked.
+ * @return true if the string is not empty (length > 0) and not
<code>null</code>.
+ */
public static boolean isNotEmpty( String str )
{
return str != null && str.length() > 0;
}
+ /**
+ * @param str The string to be checked.
+ * @return true if the string is empty or <code>null</code>.
+ */
public static boolean isEmpty( String str )
{
return str == null || str.trim().length() == 0;
}
+ /** {@inheritDoc} */
public Iterator<Xpp3Dom> iterator()
{
return getChildrenList().iterator();
Modified:
maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/xml/Xpp3DomBuilder.java
URL:
http://svn.apache.org/viewvc/maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/xml/Xpp3DomBuilder.java?rev=1706718&r1=1706717&r2=1706718&view=diff
==============================================================================
---
maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/xml/Xpp3DomBuilder.java
(original)
+++
maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/xml/Xpp3DomBuilder.java
Sun Oct 4 19:37:01 2015
@@ -49,7 +49,7 @@ public class Xpp3DomBuilder
/**
* @param reader {@link Reader}
* @return the built dom.
- * @throws XmlPullParserException
+ * @throws XmlPullParserException in case of an error.
*/
public static Xpp3Dom build( @WillClose @Nonnull Reader reader )
throws XmlPullParserException
@@ -59,9 +59,9 @@ public class Xpp3DomBuilder
/**
* @param is {@link InputStream}
- * @param encoding
+ * @param encoding The encoding.
* @return the built dom.
- * @throws XmlPullParserException
+ * @throws XmlPullParserException in case of an error.
*/
public static Xpp3Dom build( @WillClose InputStream is, @Nonnull String
encoding )
throws XmlPullParserException
@@ -74,7 +74,7 @@ public class Xpp3DomBuilder
* @param encoding The encoding.
* @param trim true/false.
* @return the built dom.
- * @throws XmlPullParserException
+ * @throws XmlPullParserException in case of an error.
*/
public static Xpp3Dom build( @WillClose InputStream is, @Nonnull String
encoding, boolean trim )
throws XmlPullParserException
@@ -94,7 +94,7 @@ public class Xpp3DomBuilder
* @param reader {@link Reader}
* @param trim true/false.
* @return the built dom.
- * @throws XmlPullParserException
+ * @throws XmlPullParserException in case of an error.
*/
public static Xpp3Dom build( @WillClose Reader reader, boolean trim )
throws XmlPullParserException
