You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by kh...@apache.org on 2014/10/17 22:55:33 UTC
svn commit: r1632663 -
/maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/
Author: khmarbaise
Date: Fri Oct 17 20:55:33 2014
New Revision: 1632663
URL: http://svn.apache.org/r1632663
Log:
[MSHARED-367]
- Reduced checkstyle reported issues.
Modified:
maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/DefaultFilterInfo.java
maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/DefaultMavenReaderFilter.java
maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/DefaultMavenResourcesFiltering.java
maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/MavenFileFilter.java
maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/MavenFileFilterRequest.java
maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/MavenReaderFilterRequest.java
maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/MultiDelimiterInterpolatorFilterReaderLineEnding.java
Modified: maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/DefaultFilterInfo.java
URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/DefaultFilterInfo.java?rev=1632663&r1=1632662&r2=1632663&view=diff
==============================================================================
--- maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/DefaultFilterInfo.java (original)
+++ maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/DefaultFilterInfo.java Fri Oct 17 20:55:33 2014
@@ -53,7 +53,7 @@ public interface DefaultFilterInfo
* @deprecated use
* {@link #getDefaultFilterWrappers(org.apache.maven.project.MavenProject, java.util.List, boolean, org.apache.maven.execution.MavenSession, org.apache.maven.shared.filtering.MavenResourcesExecution)}
*/
- // CHECKSTYLE_ON:
+ // CHECKSTYLE_ON: LineLength
@Nonnull
List<FileUtils.FilterWrapper> getDefaultFilterWrappers( MavenProject mavenProject, List<String> filters,
boolean escapedBackslashesInFilePath,
Modified: maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/DefaultMavenReaderFilter.java
URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/DefaultMavenReaderFilter.java?rev=1632663&r1=1632662&r2=1632663&view=diff
==============================================================================
--- maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/DefaultMavenReaderFilter.java (original)
+++ maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/DefaultMavenReaderFilter.java Fri Oct 17 20:55:33 2014
@@ -65,10 +65,10 @@ public class DefaultMavenReaderFilter
}
/** {@inheritDoc} */
- @Nonnull
+ @Nonnull
public Reader filter( @Nonnull Reader from, boolean filtering, @Nonnull List<FilterWrapper> filterWrappers )
{
- return filterWrap( from, filtering ? filterWrappers : Collections.<FilterWrapper> emptyList() );
+ return filterWrap( from, filtering ? filterWrappers : Collections.<FilterWrapper>emptyList() );
}
@Nonnull
Modified: maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/DefaultMavenResourcesFiltering.java
URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/DefaultMavenResourcesFiltering.java?rev=1632663&r1=1632662&r2=1632663&view=diff
==============================================================================
--- maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/DefaultMavenResourcesFiltering.java (original)
+++ maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/DefaultMavenResourcesFiltering.java Fri Oct 17 20:55:33 2014
@@ -191,10 +191,19 @@ public class DefaultMavenResourcesFilter
StringBuilder debugMessage =
new StringBuilder( "resource with targetPath " ).append( resource.getTargetPath() ).append( ls );
debugMessage.append( "directory " ).append( resource.getDirectory() ).append( ls );
- debugMessage.append( "excludes " ).append( resource.getExcludes() == null ? " empty "
- : resource.getExcludes().toString() ).append( ls );
- debugMessage.append( "includes " ).append( resource.getIncludes() == null ? " empty "
- : resource.getIncludes().toString() );
+
+ //@formatter:off
+ debugMessage.append( "excludes " )
+ .append(
+ resource.getExcludes() == null ? " empty " : resource.getExcludes().toString()
+ )
+ .append( ls );
+ debugMessage.append( "includes " )
+ .append(
+ resource.getIncludes() == null ? " empty " : resource.getIncludes().toString()
+ );
+
+ //@formatter:on
getLogger().debug( debugMessage.toString() );
}
Modified: maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/MavenFileFilter.java
URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/MavenFileFilter.java?rev=1632663&r1=1632662&r2=1632663&view=diff
==============================================================================
--- maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/MavenFileFilter.java (original)
+++ maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/MavenFileFilter.java Fri Oct 17 20:55:33 2014
@@ -38,9 +38,11 @@ public interface MavenFileFilter
*
* @param from file to copy/filter
* @param to destination file
- * @param filtering enable or not filering
+ * @param filtering enable or not filtering
* @param mavenProject the mavenproject
+ * @param mavenSession The maven session.
* @param filters {@link List} of String which are path to a Property file
+ * @param encoding The encoding which is used during the filtering process.
* @throws MavenFilteringException
* @see #getDefaultFilterWrappers(MavenProject, List, boolean, MavenSession)
*/
@@ -61,7 +63,8 @@ public interface MavenFileFilter
* @param to The target file
* @param filtering true to apply filtering
* @param filterWrappers {@link List} of FileUtils.FilterWrapper
- * @throws MavenFilteringException
+ * @param encoding The encoding used during the filtering.
+ * @throws MavenFilteringException In case of an error.
*/
void copyFile( File from, final File to, boolean filtering, List<FileUtils.FilterWrapper> filterWrappers,
String encoding )
@@ -71,10 +74,10 @@ public interface MavenFileFilter
* @param from The source file
* @param to The destination file
* @param filtering true to apply filtering
- * @param filterWrappers The filters to applt
+ * @param filterWrappers The filters to be applied.
* @param encoding The encoding to use
* @param overwrite Overwrite to file ?
- * @throws MavenFilteringException
+ * @throws MavenFilteringException In case of an error.
* @since 1.0-beta-2
*/
void copyFile( File from, final File to, boolean filtering, List<FileUtils.FilterWrapper> filterWrappers,
Modified: maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/MavenFileFilterRequest.java
URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/MavenFileFilterRequest.java?rev=1632663&r1=1632662&r2=1632663&view=diff
==============================================================================
--- maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/MavenFileFilterRequest.java (original)
+++ maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/MavenFileFilterRequest.java Fri Oct 17 20:55:33 2014
@@ -40,11 +40,25 @@ public class MavenFileFilterRequest
private boolean filtering;
+ /**
+ * The constructor.
+ */
public MavenFileFilterRequest()
{
// nothing
}
+ /**
+ * @param from The request from where.
+ * @param to The request to where
+ * @param filtering Filtering yes {@code true} or no {@code false}
+ * @param mavenProject The Maven Project.
+ * @param filters The list of given filters.
+ * @param escapedBackslashesInFilePath Escape back slashes in file path.
+ * @param encoding The used encoding during the filtering.
+ * @param mavenSession The Maven Session.
+ * @param additionalProperties Supplemental properties.
+ */
public MavenFileFilterRequest(
File from,
File to,
@@ -64,31 +78,49 @@ public class MavenFileFilterRequest
setEscapeWindowsPaths( escapedBackslashesInFilePath );
}
+ /**
+ * @return to filter from.
+ */
public File getFrom()
{
return from;
}
+ /**
+ * @param from set filter from.
+ */
public void setFrom( File from )
{
this.from = from;
}
+ /**
+ * @return The filter to
+ */
public File getTo()
{
return to;
}
+ /**
+ * @param to Set the target.
+ */
public void setTo( File to )
{
this.to = to;
}
+ /**
+ * @return if we are filtering yes {@code true} no {@code false}
+ */
public boolean isFiltering()
{
return filtering;
}
+ /**
+ * @param filtering set filtering yes / no.
+ */
public void setFiltering( boolean filtering )
{
this.filtering = filtering;
Modified: maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/MavenReaderFilterRequest.java
URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/MavenReaderFilterRequest.java?rev=1632663&r1=1632662&r2=1632663&view=diff
==============================================================================
--- maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/MavenReaderFilterRequest.java (original)
+++ maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/MavenReaderFilterRequest.java Fri Oct 17 20:55:33 2014
@@ -39,11 +39,24 @@ public class MavenReaderFilterRequest
private boolean filtering;
+ /**
+ * Default constructor.
+ */
public MavenReaderFilterRequest()
{
// nothing
}
+ /**
+ * @param from To read from
+ * @param filtering filter yes/no
+ * @param mavenProject The Maven Project.
+ * @param filters The list of filters which will be used.
+ * @param escapedBackslashesInFilePath escape backslashes in file paths.
+ * @param encoding Encoding
+ * @param mavenSession The Maven Session.
+ * @param additionalProperties supplemental properties.
+ */
public MavenReaderFilterRequest(
Reader from,
boolean filtering,
@@ -61,21 +74,33 @@ public class MavenReaderFilterRequest
setEscapeWindowsPaths( escapedBackslashesInFilePath );
}
+ /**
+ * @return where we read from.
+ */
public Reader getFrom()
{
return from;
}
+ /**
+ * @param from set where to read from.
+ */
public void setFrom( Reader from )
{
this.from = from;
}
+ /**
+ * @return is filtering active ({@code true}) false otherwise.
+ */
public boolean isFiltering()
{
return filtering;
}
+ /**
+ * @param filtering turn filtering on {@code true}) or off ({@code false}).
+ */
public void setFiltering( boolean filtering )
{
this.filtering = filtering;
Modified: maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/MultiDelimiterInterpolatorFilterReaderLineEnding.java
URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/MultiDelimiterInterpolatorFilterReaderLineEnding.java?rev=1632663&r1=1632662&r2=1632663&view=diff
==============================================================================
--- maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/MultiDelimiterInterpolatorFilterReaderLineEnding.java (original)
+++ maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/MultiDelimiterInterpolatorFilterReaderLineEnding.java Fri Oct 17 20:55:33 2014
@@ -441,21 +441,33 @@ public class MultiDelimiterInterpolatorF
}
+ /**
+ * @return interpolate with prefix pattern {@code true} (active) {@code false} otherwise.
+ */
public boolean isInterpolateWithPrefixPattern()
{
return interpolateWithPrefixPattern;
}
+ /**
+ * @param interpolateWithPrefixPattern set the interpolate with prefix pattern.
+ */
public void setInterpolateWithPrefixPattern( boolean interpolateWithPrefixPattern )
{
this.interpolateWithPrefixPattern = interpolateWithPrefixPattern;
}
+ /**
+ * @return the escapce string.
+ */
public String getEscapeString()
{
return escapeString;
}
+ /**
+ * @param escapeString Set the value of the escape string.
+ */
public void setEscapeString( String escapeString )
{
// TODO NPE if escapeString is null ?
@@ -467,21 +479,34 @@ public class MultiDelimiterInterpolatorF
}
}
+ /**
+ * @return state of preserve escape string.
+ */
public boolean isPreserveEscapeString()
{
return preserveEscapeString;
}
+ /**
+ * @param preserveEscapeString preserve escape string {@code true} or {@code false}.
+ */
public void setPreserveEscapeString( boolean preserveEscapeString )
{
this.preserveEscapeString = preserveEscapeString;
}
+ /**
+ * @return {@link RecursionInterceptor}
+ */
public RecursionInterceptor getRecursionInterceptor()
{
return recursionInterceptor;
}
+ /**
+ * @param givenRecursionInterceptor {@link RecursionInterceptor}
+ * @return this
+ */
public MultiDelimiterInterpolatorFilterReaderLineEnding setRecursionInterceptor( RecursionInterceptor givenRecursionInterceptor )
{
this.recursionInterceptor = givenRecursionInterceptor;