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 21:18:55 UTC
svn commit: r1632653 -
/maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/
Author: khmarbaise
Date: Fri Oct 17 19:18:55 2014
New Revision: 1632653
URL: http://svn.apache.org/r1632653
Log:
[MSHARED-367]
- Followup less message of checkstyle.
Modified:
maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/AbstractMavenFilteringRequest.java
maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/BoundedReader.java
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/DefaultMavenFileFilter.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/FilteringUtils.java
maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/InterpolatorFilterReaderLineEnding.java
maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/MavenResourcesExecution.java
maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/MultiDelimiterInterpolatorFilterReaderLineEnding.java
maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/PropertyUtils.java
Modified: maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/AbstractMavenFilteringRequest.java
URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/AbstractMavenFilteringRequest.java?rev=1632653&r1=1632652&r2=1632653&view=diff
==============================================================================
--- maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/AbstractMavenFilteringRequest.java (original)
+++ maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/AbstractMavenFilteringRequest.java Fri Oct 17 19:18:55 2014
@@ -86,11 +86,21 @@ public class AbstractMavenFilteringReque
*/
private boolean supportMultiLineFiltering;
+ /**
+ * Create instance.
+ */
protected AbstractMavenFilteringRequest()
{
initDefaults();
}
+ /**
+ * Create instance with given parameters
+ * @param mavenProject The instance of MavenProject.
+ * @param filters The list of filters.
+ * @param encoding The encoding.
+ * @param mavenSession The MavenSession.
+ */
protected AbstractMavenFilteringRequest(
MavenProject mavenProject,
List<String> filters,
@@ -113,31 +123,54 @@ public class AbstractMavenFilteringReque
delimiters.add( "@" );
}
+ /**
+ * @return The MavenProject
+ */
public MavenProject getMavenProject()
{
return mavenProject;
}
+ /**
+ * Set the MavenProject.
+ * @param mavenProject The MavenProject to be set.
+ */
public void setMavenProject( MavenProject mavenProject )
{
this.mavenProject = mavenProject;
}
+ /**
+ * The list of filters.
+ * @return The list of currently set filters.
+ */
public List<String> getFilters()
{
return filters;
}
+ /**
+ * Set the filters.
+ * @param filters Set the list of filters
+ */
public void setFilters( List<String> filters )
{
this.filters = filters;
}
+ /**
+ * Alias for {@link #getFilters()}.
+ * @return The list of filters.
+ */
public List<String> getFileFilters()
{
return getFilters();
}
+ /**
+ * Alias for {@link #setFilters(List)}
+ * @param filters The list of filters to be set.
+ */
public void setFileFilters( List<String> filters )
{
setFilters( filters );
@@ -145,6 +178,7 @@ public class AbstractMavenFilteringReque
/**
* @since 1.0-beta-3
+ * @return true if escape is activated false otherwise.
*/
public boolean isEscapeWindowsPaths()
{
@@ -153,43 +187,67 @@ public class AbstractMavenFilteringReque
/**
* @since 1.0-beta-3
+ * @param escapedBackslashesInFilePath true or false.
*/
public void setEscapeWindowsPaths( boolean escapedBackslashesInFilePath )
{
this.escapeWindowsPaths = escapedBackslashesInFilePath;
}
+ /**
+ * Alias for {@link #isEscapeWindowsPaths()}
+ * @return The current value of {@link #isEscapeWindowsPaths()}
+ */
public boolean isEscapedBackslashesInFilePath()
{
return isEscapeWindowsPaths();
}
+ /**
+ * Alias for {@link #setEscapeWindowsPaths(boolean)}
+ * @param escape activate or deactivate escaping.
+ */
public void setEscapedBackslashesInFilePath( boolean escape )
{
setEscapeWindowsPaths( escape );
}
+ /**
+ * Return the encoding.
+ * @return Current encoding.
+ */
public String getEncoding()
{
return encoding;
}
+ /**
+ * Set the value for encoding.
+ * @param encoding Give the new value for encoding.
+ */
public void setEncoding( String encoding )
{
this.encoding = encoding;
}
+ /**
+ * @return Current value of mavenSession
+ */
public MavenSession getMavenSession()
{
return mavenSession;
}
+ /**
+ * @param mavenSession Set new value for the MavenSession of the instance.
+ */
public void setMavenSession( MavenSession mavenSession )
{
this.mavenSession = mavenSession;
}
/**
+ * @return the additional properties.
* @since 1.0-beta-3
*/
public Properties getAdditionalProperties()
@@ -198,6 +256,7 @@ public class AbstractMavenFilteringReque
}
/**
+ * @param additionalProperties The additional properties to be set.
* @since 1.0-beta-3
*/
public void setAdditionalProperties( Properties additionalProperties )
@@ -206,6 +265,7 @@ public class AbstractMavenFilteringReque
}
/**
+ * @return the current value of injectProjectBuildFilters.
* @since 1.0-beta-3
*/
public boolean isInjectProjectBuildFilters()
@@ -214,6 +274,7 @@ public class AbstractMavenFilteringReque
}
/**
+ * @param injectProjectBuildFilters true or false.
* @since 1.0-beta-3
*/
public void setInjectProjectBuildFilters( boolean injectProjectBuildFilters )
@@ -222,6 +283,7 @@ public class AbstractMavenFilteringReque
}
/**
+ * @return Current value of escapeString.
* @since 1.0-beta-2
*/
public String getEscapeString()
@@ -239,6 +301,7 @@ public class AbstractMavenFilteringReque
}
/**
+ * @return The list of project start expressions.
* @since 1.0-beta-2
*/
public List<String> getProjectStartExpressions()
@@ -287,11 +350,17 @@ public class AbstractMavenFilteringReque
}
}
+ /**
+ * @return If support multiple line filtering is active or not.
+ */
public boolean isSupportMultiLineFiltering()
{
return supportMultiLineFiltering;
}
+ /**
+ * @param supportMultiLineFiltering activate or deactivate multiple line filtering support.
+ */
public void setSupportMultiLineFiltering( boolean supportMultiLineFiltering )
{
this.supportMultiLineFiltering = supportMultiLineFiltering;
Modified: maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/BoundedReader.java
URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/BoundedReader.java?rev=1632653&r1=1632652&r2=1632653&view=diff
==============================================================================
--- maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/BoundedReader.java (original)
+++ maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/BoundedReader.java Fri Oct 17 19:18:55 2014
@@ -63,11 +63,11 @@ public class BoundedReader
}
@Override
- public void mark( int readAheadLimit )
+ public void mark( int theReadAheadLimit )
throws IOException
{
- this.readAheadLimit = readAheadLimit;
- target.mark( readAheadLimit );
+ this.readAheadLimit = theReadAheadLimit;
+ target.mark( theReadAheadLimit );
}
@Override
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=1632653&r1=1632652&r2=1632653&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 19:18:55 2014
@@ -27,6 +27,10 @@ import org.apache.maven.execution.MavenS
import org.apache.maven.project.MavenProject;
import org.apache.maven.shared.utils.io.FileUtils;
+/**
+ *
+ * @author Kristian Rosenvold
+ */
public interface DefaultFilterInfo
{
/**
@@ -42,6 +46,9 @@ public interface DefaultFilterInfo
*
* @param mavenProject The maven project
* @param filters {@link java.util.List} of properties file
+ * @param escapedBackslashesInFilePath true to escape backslashes in file path.
+ * @param mavenSession The maven session which will be used.
+ * @throws MavenFilteringException
* @return {@link java.util.List} of FileUtils.FilterWrapper
* @deprecated use
* {@link #getDefaultFilterWrappers(org.apache.maven.project.MavenProject, java.util.List, boolean, org.apache.maven.execution.MavenSession, org.apache.maven.shared.filtering.MavenResourcesExecution)}
@@ -58,8 +65,8 @@ public interface DefaultFilterInfo
* @param escapedBackslashesInFilePath escape backslashes ?
* @param mavenSession The maven session
* @param mavenResourcesExecution The filtering configuration
+ * @throws MavenFilteringException
* @return {@link java.util.List} of FileUtils.FilterWrapper
- * @throws org.apache.maven.shared.filtering.MavenFilteringException
* @since 1.0-beta-2
*/
@Nonnull
@@ -71,8 +78,8 @@ public interface DefaultFilterInfo
/**
* @param request The filtering request
- * @return {@link java.util.List} of FileUtils.FilterWrapper
* @throws org.apache.maven.shared.filtering.MavenFilteringException
+ * @return {@link java.util.List} of FileUtils.FilterWrapper
* @since 1.0-beta-3
*/
@Nonnull
Modified: maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/DefaultMavenFileFilter.java
URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/DefaultMavenFileFilter.java?rev=1632653&r1=1632652&r2=1632653&view=diff
==============================================================================
--- maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/DefaultMavenFileFilter.java (original)
+++ maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/DefaultMavenFileFilter.java Fri Oct 17 19:18:55 2014
@@ -80,6 +80,9 @@ public class DefaultMavenFileFilter
copyFile( from, to, filtering, filterWrappers, encoding );
}
+ /* (non-Javadoc)
+ * @see org.apache.maven.shared.filtering.MavenFileFilter#copyFile(org.apache.maven.shared.filtering.MavenFileFilterRequest)
+ */
public void copyFile( MavenFileFilterRequest mavenFileFilterRequest )
throws MavenFilteringException
{
@@ -89,6 +92,9 @@ public class DefaultMavenFileFilter
mavenFileFilterRequest.isFiltering(), filterWrappers, mavenFileFilterRequest.getEncoding() );
}
+ /* (non-Javadoc)
+ * @see org.apache.maven.shared.filtering.MavenFileFilter#copyFile(java.io.File, java.io.File, boolean, java.util.List, java.lang.String)
+ */
public void copyFile( File from, File to, boolean filtering, List<FileUtils.FilterWrapper> filterWrappers,
String encoding )
throws MavenFilteringException
@@ -97,6 +103,9 @@ public class DefaultMavenFileFilter
copyFile( from, to, filtering, filterWrappers, encoding, false );
}
+ /* (non-Javadoc)
+ * @see org.apache.maven.shared.filtering.MavenFileFilter#copyFile(java.io.File, java.io.File, boolean, java.util.List, java.lang.String, boolean)
+ */
public void copyFile( File from, File to, boolean filtering, List<FileUtils.FilterWrapper> filterWrappers,
String encoding, boolean overwrite )
throws MavenFilteringException
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=1632653&r1=1632652&r2=1632653&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 19:18:55 2014
@@ -38,6 +38,9 @@ public class DefaultMavenReaderFilter
extends BaseFilter
implements MavenReaderFilter
{
+ /* (non-Javadoc)
+ * @see org.apache.maven.shared.filtering.MavenReaderFilter#filter(java.io.Reader, boolean, org.apache.maven.project.MavenProject, java.util.List, boolean, org.apache.maven.execution.MavenSession)
+ */
@Nonnull
public Reader filter( @Nonnull Reader from, boolean filtering, MavenProject mavenProject, List<String> filters,
boolean escapedBackslashesInFilePath, MavenSession mavenSession )
@@ -54,6 +57,9 @@ public class DefaultMavenReaderFilter
return filter( from, filtering, filterWrappers );
}
+ /* (non-Javadoc)
+ * @see org.apache.maven.shared.filtering.MavenReaderFilter#filter(org.apache.maven.shared.filtering.MavenReaderFilterRequest)
+ */
@Nonnull
public Reader filter( @Nonnull MavenReaderFilterRequest mavenFileFilterRequest )
throws MavenFilteringException
@@ -62,12 +68,17 @@ public class DefaultMavenReaderFilter
return filter( mavenFileFilterRequest.getFrom(), mavenFileFilterRequest.isFiltering(), filterWrappers );
}
- public @Nonnull Reader filter( @Nonnull Reader from, boolean filtering, @Nonnull List<FilterWrapper> filterWrappers )
+ /* (non-Javadoc)
+ * @see org.apache.maven.shared.filtering.MavenReaderFilter#filter(java.io.Reader, boolean, java.util.List)
+ */
+ @Nonnull
+ public Reader filter( @Nonnull Reader from, boolean filtering, @Nonnull List<FilterWrapper> filterWrappers )
{
return filterWrap( from, filtering ? filterWrappers : Collections.<FilterWrapper> emptyList() );
}
- private static @Nonnull Reader filterWrap( @Nonnull Reader from, @Nonnull Iterable<FilterWrapper> wrappers )
+ @Nonnull
+ private static Reader filterWrap( @Nonnull Reader from, @Nonnull Iterable<FilterWrapper> wrappers )
{
Reader reader = from;
for ( FilterWrapper wrapper : wrappers )
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=1632653&r1=1632652&r2=1632653&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 19:18:55 2014
@@ -48,6 +48,10 @@ import org.sonatype.plexus.build.increme
* @plexus.component role="org.apache.maven.shared.filtering.MavenResourcesFiltering"
* role-hint="default"
*/
+/**
+ * @author kama
+ *
+ */
public class DefaultMavenResourcesFiltering
extends AbstractLogEnabled
implements MavenResourcesFiltering, Initializable
@@ -67,6 +71,9 @@ public class DefaultMavenResourcesFilter
// ------------------------------------------------
// Plexus lifecycle
// ------------------------------------------------
+ /* (non-Javadoc)
+ * @see org.codehaus.plexus.personality.plexus.lifecycle.phase.Initializable#initialize()
+ */
public void initialize()
throws InitializationException
{
@@ -84,6 +91,9 @@ public class DefaultMavenResourcesFilter
*/
private MavenFileFilter mavenFileFilter;
+ /* (non-Javadoc)
+ * @see org.apache.maven.shared.filtering.MavenResourcesFiltering#filterResources(java.util.List, java.io.File, org.apache.maven.project.MavenProject, java.lang.String, java.util.List, java.util.List, org.apache.maven.execution.MavenSession)
+ */
public void filterResources( List<Resource> resources, File outputDirectory, MavenProject mavenProject,
String encoding, List<String> fileFilters, List<String> nonFilteredFileExtensions,
MavenSession mavenSession )
@@ -98,6 +108,9 @@ public class DefaultMavenResourcesFilter
filterResources( mavenResourcesExecution );
}
+ /* (non-Javadoc)
+ * @see org.apache.maven.shared.filtering.MavenResourcesFiltering#filterResources(java.util.List, java.io.File, java.lang.String, java.util.List, java.io.File, java.util.List)
+ */
public void filterResources( List<Resource> resources, File outputDirectory, String encoding,
List<FileUtils.FilterWrapper> filterWrappers, File resourcesBaseDirectory,
List<String> nonFilteredFileExtensions )
@@ -109,6 +122,9 @@ public class DefaultMavenResourcesFilter
filterResources( mavenResourcesExecution );
}
+ /* (non-Javadoc)
+ * @see org.apache.maven.shared.filtering.MavenResourcesFiltering#filteredFileExtension(java.lang.String, java.util.List)
+ */
public boolean filteredFileExtension( String fileName, List<String> userNonFilteredFileExtensions )
{
List<String> nonFilteredFileExtensions = new ArrayList<String>( getDefaultNonFilteredFileExtensions() );
@@ -126,6 +142,9 @@ public class DefaultMavenResourcesFilter
return filteredFileExtension;
}
+ /* (non-Javadoc)
+ * @see org.apache.maven.shared.filtering.MavenResourcesFiltering#getDefaultNonFilteredFileExtensions()
+ */
public List<String> getDefaultNonFilteredFileExtensions()
{
if ( this.defaultNonFilteredFileExtensions == null )
@@ -135,6 +154,9 @@ public class DefaultMavenResourcesFilter
return this.defaultNonFilteredFileExtensions;
}
+ /* (non-Javadoc)
+ * @see org.apache.maven.shared.filtering.MavenResourcesFiltering#filterResources(org.apache.maven.shared.filtering.MavenResourcesExecution)
+ */
public void filterResources( MavenResourcesExecution mavenResourcesExecution )
throws MavenFilteringException
{
Modified: maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/FilteringUtils.java
URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/FilteringUtils.java?rev=1632653&r1=1632652&r2=1632653&view=diff
==============================================================================
--- maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/FilteringUtils.java (original)
+++ maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/FilteringUtils.java Fri Oct 17 19:18:55 2014
@@ -43,6 +43,10 @@ public final class FilteringUtils
// TODO: Correct to handle relative windows paths. (http://jira.codehaus.org/browse/MSHARED-121)
// How do we distinguish a relative windows path from some other value that happens to contain backslashes??
+ /**
+ * @param val The value to be escaped.
+ * @return Escaped value
+ */
public static String escapeWindowsPath( String val )
{
if ( !StringUtils.isEmpty( val ) && PATTERN.matcher( val ).matches() )
Modified: maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/InterpolatorFilterReaderLineEnding.java
URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/InterpolatorFilterReaderLineEnding.java?rev=1632653&r1=1632652&r2=1632653&view=diff
==============================================================================
--- maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/InterpolatorFilterReaderLineEnding.java (original)
+++ maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/InterpolatorFilterReaderLineEnding.java Fri Oct 17 19:18:55 2014
@@ -151,7 +151,6 @@ public class InterpolatorFilterReaderLin
*
* @param n The number of characters to skip
* @return the number of characters actually skipped
- * @throws IllegalArgumentException If <code>n</code> is negative.
* @throws IOException If an I/O error occurs
*/
public long skip( long n )
@@ -396,21 +395,33 @@ public class InterpolatorFilterReaderLin
}
+ /**
+ * @return current state of interpolate with prefix pattern.
+ */
public boolean isInterpolateWithPrefixPattern()
{
return interpolateWithPrefixPattern;
}
+ /**
+ * @param interpolateWithPrefixPattern interpolate with prefix pattern.
+ */
public void setInterpolateWithPrefixPattern( boolean interpolateWithPrefixPattern )
{
this.interpolateWithPrefixPattern = interpolateWithPrefixPattern;
}
+ /**
+ * @return The current value of escapeString.
+ */
public String getEscapeString()
{
return escapeString;
}
+ /**
+ * @param escapeString Set the value for escapeString.
+ */
public void setEscapeString( String escapeString )
{
// TODO NPE if escapeString is null ?
@@ -422,6 +433,9 @@ public class InterpolatorFilterReaderLin
}
}
+ /**
+ * @return state of preserve escape string.
+ */
public boolean isPreserveEscapeString()
{
return preserveEscapeString;
@@ -437,9 +451,9 @@ public class InterpolatorFilterReaderLin
return recursionInterceptor;
}
- public InterpolatorFilterReaderLineEnding setRecursionInterceptor( RecursionInterceptor recursionInterceptor )
+ public InterpolatorFilterReaderLineEnding setRecursionInterceptor( RecursionInterceptor theRecursionInterceptor )
{
- this.recursionInterceptor = recursionInterceptor;
+ this.recursionInterceptor = theRecursionInterceptor;
return this;
}
Modified: maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/MavenResourcesExecution.java
URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/MavenResourcesExecution.java?rev=1632653&r1=1632652&r2=1632653&view=diff
==============================================================================
--- maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/MavenResourcesExecution.java (original)
+++ maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/MavenResourcesExecution.java Fri Oct 17 19:18:55 2014
@@ -78,6 +78,9 @@ public class MavenResourcesExecution
*/
private boolean supportMultiLineFiltering;
+ /**
+ * Do nothing.
+ */
public MavenResourcesExecution()
{
// no op
@@ -86,13 +89,13 @@ public class MavenResourcesExecution
/**
* As we use a Maven project <code>useDefaultFilterWrappers</code> will be set to <code>true</code>.
*
- * @param resources
- * @param outputDirectory
- * @param mavenProject
- * @param encoding
- * @param fileFilters
- * @param nonFilteredFileExtensions
- * @param mavenSession
+ * @param resources The list of resources.
+ * @param outputDirectory The output directory.
+ * @param mavenProject The maven project.
+ * @param encoding The given encoding.
+ * @param fileFilters The file filters.
+ * @param nonFilteredFileExtensions The extensions which should not being filtered.
+ * @param mavenSession The maven session.
*/
public MavenResourcesExecution(
List<Resource> resources,
@@ -111,6 +114,14 @@ public class MavenResourcesExecution
this.resourcesBaseDirectory = mavenProject.getBasedir();
}
+ /**
+ * @param resources The list of resources.
+ * @param outputDirectory The output directory.
+ * @param encoding The given encoding.
+ * @param filterWrappers The list of filter wrappers.
+ * @param resourcesBaseDirectory The resources base directory.
+ * @param nonFilteredFileExtensions The list of extensions which should not being filtered.
+ */
public MavenResourcesExecution(
List<Resource> resources,
File outputDirectory,
@@ -145,11 +156,17 @@ public class MavenResourcesExecution
this.resources = resources;
}
+ /**
+ * @return The output directory.
+ */
public File getOutputDirectory()
{
return outputDirectory;
}
+ /**
+ * @param outputDirectory The output directory.
+ */
public void setOutputDirectory( File outputDirectory )
{
this.outputDirectory = outputDirectory;
@@ -187,6 +204,9 @@ public class MavenResourcesExecution
this.filterWrappers = filterWrappers;
}
+ /**
+ * @param filterWrapper The filter wrapper which should be added.
+ */
public void addFilterWrapper( FilterWrapper filterWrapper )
{
if ( this.filterWrappers == null )
@@ -200,7 +220,7 @@ public class MavenResourcesExecution
* Helper to add {@link FileUtils.FilterWrapper}, will {@link RegexBasedInterpolator} with default regex Exp ${ }
* and InterpolatorFilterReaderLineEnding with defaultTokens ${ }.
*
- * @param valueSource
+ * @param valueSource The value Source.
* @deprecated This doesn't support escaping use
* {@link #addFilerWrapperWithEscaping(ValueSource, String, String, String, boolean)}
*/
@@ -221,11 +241,11 @@ public class MavenResourcesExecution
}
/**
- * @param valueSource
- * @param startRegExp
- * @param endRegExp
- * @param startToken
- * @param endToken
+ * @param valueSource The valueSource.
+ * @param startRegExp The start regular expression.
+ * @param endRegExp The end regular expression.
+ * @param startToken The start token.
+ * @param endToken The end token.
* @deprecated This doesn't support escaping use
* {@link #addFilerWrapperWithEscaping(ValueSource, String, String, String, boolean)}
*/
@@ -245,10 +265,10 @@ public class MavenResourcesExecution
}
/**
- * @param valueSource
- * @param startExp start token like ${
- * @param endExp endToken }
- * @param escapeString
+ * @param valueSource {@link ValueSource}
+ * @param startExp start token like <code>${</code>
+ * @param endExp endToken <code>}</code>
+ * @param escapeString The escape string.
* @since 1.0-beta-2
* @deprecated This doesn't support escaping use
* {@link #addFilerWrapperWithEscaping(ValueSource, String, String, String, boolean)}
@@ -272,10 +292,10 @@ public class MavenResourcesExecution
}
/**
- * @param valueSource
- * @param startExp start token like ${
- * @param endExp endToken }
- * @param escapeString
+ * @param valueSource {@link ValueSource}
+ * @param startExp start token like <code>${</code>
+ * @param endExp endToken <code>}</code>
+ * @param escapeString The escape string.
* @param supportMultiLineFiltering do we support or use filtering on multi lines with start and endtoken on multi
* lines
* @since 1.0
@@ -299,21 +319,33 @@ public class MavenResourcesExecution
} );
}
+ /**
+ * @return The resource base directory.
+ */
public File getResourcesBaseDirectory()
{
return resourcesBaseDirectory;
}
+ /**
+ * @param resourcesBaseDirectory Set the resource base directory.
+ */
public void setResourcesBaseDirectory( File resourcesBaseDirectory )
{
this.resourcesBaseDirectory = resourcesBaseDirectory;
}
+ /**
+ * @return use default filter wrapper
+ */
public boolean isUseDefaultFilterWrappers()
{
return useDefaultFilterWrappers;
}
+ /**
+ * @param useDefaultFilterWrappers
+ */
public void setUseDefaultFilterWrappers( boolean useDefaultFilterWrappers )
{
this.useDefaultFilterWrappers = useDefaultFilterWrappers;
@@ -332,7 +364,7 @@ public class MavenResourcesExecution
/**
* Overwrite existing files even if the destination files are newer.
*
- * @param overwrite
+ * @param overwrite overwrite true or false.
* @since 1.0-beta-2
*/
public void setOverwrite( boolean overwrite )
@@ -353,7 +385,7 @@ public class MavenResourcesExecution
/**
* Copy any empty directories included in the Resources.
*
- * @param includeEmptyDirs
+ * @param includeEmptyDirs {@code true} to include empty directories, otherwise {@code false}.
* @since 1.0-beta-2
*/
public void setIncludeEmptyDirs( boolean includeEmptyDirs )
@@ -379,6 +411,9 @@ public class MavenResourcesExecution
this.filterFilenames = filterFilenames;
}
+ /**
+ * @return {@link MavenResourcesExecution}
+ */
public MavenResourcesExecution copyOf()
{
MavenResourcesExecution mre = new MavenResourcesExecution();
@@ -419,11 +454,17 @@ public class MavenResourcesExecution
}
}
+ /* (non-Javadoc)
+ * @see org.apache.maven.shared.filtering.AbstractMavenFilteringRequest#isSupportMultiLineFiltering()
+ */
public boolean isSupportMultiLineFiltering()
{
return supportMultiLineFiltering;
}
+ /* (non-Javadoc)
+ * @see org.apache.maven.shared.filtering.AbstractMavenFilteringRequest#setSupportMultiLineFiltering(boolean)
+ */
public void setSupportMultiLineFiltering( boolean supportMultiLineFiltering )
{
this.supportMultiLineFiltering = supportMultiLineFiltering;
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=1632653&r1=1632652&r2=1632653&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 19:18:55 2014
@@ -98,7 +98,7 @@ public class MultiDelimiterInterpolatorF
*/
private int markLength = 128;
- private static final int maxBufferSize = 8192;
+ private static final int MAXIMUM_BUFFER_SIZE = 8192;
private boolean eof = false;
@@ -130,7 +130,7 @@ public class MultiDelimiterInterpolatorF
boolean supportMultiLineFiltering )
{
// wrap our own buffer, so we can use mark/reset safely.
- super( new BufferedReader( in, maxBufferSize ) );
+ super( new BufferedReader( in, MAXIMUM_BUFFER_SIZE ) );
this.interpolator = interpolator;
@@ -169,9 +169,9 @@ public class MultiDelimiterInterpolatorF
* the stream is reached.
*
* @param n The number of characters to skip
- * @return the number of characters actually skipped
* @throws IllegalArgumentException If <code>n</code> is negative.
* @throws IOException If an I/O error occurs
+ * @return the number of characters actually skipped
*/
public long skip( long n )
throws IOException
@@ -482,9 +482,9 @@ public class MultiDelimiterInterpolatorF
return recursionInterceptor;
}
- public MultiDelimiterInterpolatorFilterReaderLineEnding setRecursionInterceptor( RecursionInterceptor recursionInterceptor )
+ public MultiDelimiterInterpolatorFilterReaderLineEnding setRecursionInterceptor( RecursionInterceptor givenRecursionInterceptor )
{
- this.recursionInterceptor = recursionInterceptor;
+ this.recursionInterceptor = givenRecursionInterceptor;
return this;
}
Modified: maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/PropertyUtils.java
URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/PropertyUtils.java?rev=1632653&r1=1632652&r2=1632653&view=diff
==============================================================================
--- maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/PropertyUtils.java (original)
+++ maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/PropertyUtils.java Fri Oct 17 19:18:55 2014
@@ -23,7 +23,6 @@ import java.io.File;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.IOException;
-import java.util.Iterator;
import java.util.Properties;
import org.apache.maven.shared.utils.StringUtils;