You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by hb...@apache.org on 2020/02/13 22:11:20 UTC

[maven-filtering] 10/44: fix some checkstyle errors

This is an automated email from the ASF dual-hosted git repository.

hboutemy pushed a commit to annotated tag maven-filtering-1.0-alpha-1
in repository https://gitbox.apache.org/repos/asf/maven-filtering.git

commit d01b93a372d6e57908934951815050f55cdeb755
Author: Oliver Lamy <ol...@apache.org>
AuthorDate: Thu Feb 7 22:14:13 2008 +0000

    fix some checkstyle errors
    
    git-svn-id: https://svn.apache.org/repos/asf/maven/sandbox/trunk/shared/maven-filtering@619666 13f79535-47bb-0310-9956-ffa450edef68
---
 .../shared/filtering/DefaultMavenFileFilter.java   | 26 ++++++++-------------
 .../filtering/DefaultMavenResourcesFiltering.java  |  3 ++-
 .../maven/shared/filtering/MavenFileFilter.java    | 15 ++++++------
 .../shared/filtering/MavenFilteringException.java  |  3 ++-
 .../shared/filtering/MavenResourcesFiltering.java  |  8 +++----
 .../maven/shared/filtering/PropertyUtils.java      | 27 +++++++++++++---------
 .../shared/filtering/ReflectionProperties.java     |  6 ++---
 7 files changed, 43 insertions(+), 45 deletions(-)

diff --git a/src/main/java/org/apache/maven/shared/filtering/DefaultMavenFileFilter.java b/src/main/java/org/apache/maven/shared/filtering/DefaultMavenFileFilter.java
index 0437f11..1467c36 100755
--- a/src/main/java/org/apache/maven/shared/filtering/DefaultMavenFileFilter.java
+++ b/src/main/java/org/apache/maven/shared/filtering/DefaultMavenFileFilter.java
@@ -1,3 +1,5 @@
+package org.apache.maven.shared.filtering;
+
 /*
  * Licensed to the Apache Software Foundation (ASF) under one
  * or more contributor license agreements.  See the NOTICE file
@@ -16,7 +18,6 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-package org.apache.maven.shared.filtering;
 
 import java.io.File;
 import java.io.IOException;
@@ -42,10 +43,7 @@ import org.codehaus.plexus.util.InterpolationFilterReader;
 public class DefaultMavenFileFilter
     implements MavenFileFilter
 {
-    
-    /** 
-     * @see org.apache.maven.shared.filtering.MavenFileFilter#copyFile(java.io.File, java.io.File, boolean, org.apache.maven.project.MavenProject, java.util.List)
-     */
+
     public void copyFile( File from, File to, boolean filtering, MavenProject mavenProject, List filters,
                           boolean escapedBackslashesInFilePath, String encoding )
         throws MavenFilteringException
@@ -54,9 +52,6 @@ public class DefaultMavenFileFilter
         copyFile( from, to, filtering, filterWrappers, encoding );
     }
 
-    /** 
-     * @see org.apache.maven.shared.filtering.MavenFileFilter#copyFile(java.io.File, java.io.File, boolean, java.util.List)
-     */
     public void copyFile( File from, File to, boolean filtering, List filterWrappers, String encoding )
         throws MavenFilteringException
     {
@@ -81,9 +76,6 @@ public class DefaultMavenFileFilter
 
     }
 
-    /** 
-     * @see org.apache.maven.shared.filtering.MavenFileFilter#getDefaultFilterWrappers(org.apache.maven.project.MavenProject, java.util.List)
-     */
     public List getDefaultFilterWrappers( final MavenProject mavenProject, List filters,
                                           final boolean escapedBackslashesInFilePath )
         throws MavenFilteringException
@@ -121,9 +113,9 @@ public class DefaultMavenFileFilter
         }
         
         List buildFilters = mavenProject.getFilters();
-        if (buildFilters != null)
+        if ( buildFilters != null )
         {
-            for (Iterator iterator = buildFilters.iterator();iterator.hasNext();)
+            for ( Iterator iterator = buildFilters.iterator(); iterator.hasNext(); )
             {
                 String filterFile = (String) iterator.next();
                 try
@@ -137,12 +129,12 @@ public class DefaultMavenFileFilter
                     throw new MavenFilteringException( "Error loading property file '" + filterFile + "'", e );
                 }
             }
-        }        
-        
+        }
+
         buildFilters = mavenProject.getBuild().getFilters();
-        if (buildFilters != null)
+        if ( buildFilters != null )
         {
-            for (Iterator iterator = buildFilters.iterator();iterator.hasNext();)
+            for ( Iterator iterator = buildFilters.iterator(); iterator.hasNext(); )
             {
                 String filterFile = (String) iterator.next();
                 try
diff --git a/src/main/java/org/apache/maven/shared/filtering/DefaultMavenResourcesFiltering.java b/src/main/java/org/apache/maven/shared/filtering/DefaultMavenResourcesFiltering.java
index be4e863..d02f4ec 100755
--- a/src/main/java/org/apache/maven/shared/filtering/DefaultMavenResourcesFiltering.java
+++ b/src/main/java/org/apache/maven/shared/filtering/DefaultMavenResourcesFiltering.java
@@ -1,3 +1,5 @@
+package org.apache.maven.shared.filtering;
+
 /*
  * Licensed to the Apache Software Foundation (ASF) under one
  * or more contributor license agreements.  See the NOTICE file
@@ -16,7 +18,6 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-package org.apache.maven.shared.filtering;
 
 import java.io.File;
 import java.util.Arrays;
diff --git a/src/main/java/org/apache/maven/shared/filtering/MavenFileFilter.java b/src/main/java/org/apache/maven/shared/filtering/MavenFileFilter.java
index ea8a452..8fc4a59 100755
--- a/src/main/java/org/apache/maven/shared/filtering/MavenFileFilter.java
+++ b/src/main/java/org/apache/maven/shared/filtering/MavenFileFilter.java
@@ -1,3 +1,5 @@
+package org.apache.maven.shared.filtering;
+
 /*
  * Licensed to the Apache Software Foundation (ASF) under one
  * or more contributor license agreements.  See the NOTICE file
@@ -16,7 +18,6 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-package org.apache.maven.shared.filtering;
 
 import java.io.File;
 import java.io.IOException;
@@ -34,7 +35,7 @@ public interface MavenFileFilter
     
     /**
      * Will copy a file with some filtering using defaultFilterWrappers 
-     * @see #getDefaultFilterWrappers(MavenProject, List)
+     * @see #getDefaultFilterWrappers(MavenProject, List, boolean)
      * 
      * @param from file to copy/filter
      * @param to destination file
@@ -43,7 +44,7 @@ public interface MavenFileFilter
      * @param filters {@link List} of properties file 
      * @throws IOException 
      */
-    public void copyFile( File from, final File to, boolean filtering, MavenProject mavenProject, List filters,
+    void copyFile( File from, final File to, boolean filtering, MavenProject mavenProject, List filters,
                           boolean escapedBackslashesInFilePath, String encoding )
         throws MavenFilteringException;
 
@@ -54,7 +55,7 @@ public interface MavenFileFilter
      * @param filterWrappers {@link List} of FileUtils.FilterWrapper
      * @throws MavenFilteringException
      */
-    public void copyFile( File from, final File to, boolean filtering, List filterWrappers, String encoding )
+    void copyFile( File from, final File to, boolean filtering, List filterWrappers, String encoding )
         throws MavenFilteringException;
 
     /**
@@ -62,8 +63,8 @@ public interface MavenFileFilter
      * Will return the default FileUtils.FilterWrappers
      * 
      * <ul>
-     *   <li>interpolation with token ${ } and values from System.getProperties, project.getProperties, from filters and project filters.</li>
-     *   <li>interpolation with token @ @ and values from System.getProperties, project.getProperties, from filters and project filters.</li>
+     *   <li>interpolation with token ${ } and values from SystemProps, project.properties, from filters and project filters.</li>
+     *   <li>interpolation with token @ @ and values from SystemProps, project.properties, from filters and project filters.</li>
      *   <li>interpolation with token ${ } and values from mavenProject interpolation.</li>
      * </ul>
      * 
@@ -73,6 +74,6 @@ public interface MavenFileFilter
      * @return {@link List} of FileUtils.FilterWrapper 
      * 
      */
-    public List getDefaultFilterWrappers( MavenProject mavenProject, List filters, boolean escapedBackslashesInFilePath )
+    List getDefaultFilterWrappers( MavenProject mavenProject, List filters, boolean escapedBackslashesInFilePath )
         throws MavenFilteringException;
 }
diff --git a/src/main/java/org/apache/maven/shared/filtering/MavenFilteringException.java b/src/main/java/org/apache/maven/shared/filtering/MavenFilteringException.java
index 25cb808..0a72f99 100755
--- a/src/main/java/org/apache/maven/shared/filtering/MavenFilteringException.java
+++ b/src/main/java/org/apache/maven/shared/filtering/MavenFilteringException.java
@@ -1,3 +1,5 @@
+package org.apache.maven.shared.filtering;
+
 /*
  * Licensed to the Apache Software Foundation (ASF) under one
  * or more contributor license agreements.  See the NOTICE file
@@ -16,7 +18,6 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-package org.apache.maven.shared.filtering;
 
 /**
  * @author <a href="mailto:olamy@apache.org">olamy</a>
diff --git a/src/main/java/org/apache/maven/shared/filtering/MavenResourcesFiltering.java b/src/main/java/org/apache/maven/shared/filtering/MavenResourcesFiltering.java
index bae9373..5acba81 100755
--- a/src/main/java/org/apache/maven/shared/filtering/MavenResourcesFiltering.java
+++ b/src/main/java/org/apache/maven/shared/filtering/MavenResourcesFiltering.java
@@ -1,3 +1,5 @@
+package org.apache.maven.shared.filtering;
+
 /*
  * Licensed to the Apache Software Foundation (ASF) under one
  * or more contributor license agreements.  See the NOTICE file
@@ -16,13 +18,10 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-package org.apache.maven.shared.filtering;
 
 import java.io.File;
-import java.io.IOException;
 import java.util.List;
 
-import org.apache.maven.model.Resource;
 import org.apache.maven.project.MavenProject;
 
 /**
@@ -40,9 +39,8 @@ public interface MavenResourcesFiltering
      * @param encoding
      * @param fileFilters {@link List} of Properties file
      * @throws MavenFilteringException
-     * @throws IOException
      */
-    public void filterResources( List resources, File outputDirectory, MavenProject mavenProject, String encoding,
+    void filterResources( List resources, File outputDirectory, MavenProject mavenProject, String encoding,
                                  List fileFilters )
         throws MavenFilteringException;
 
diff --git a/src/main/java/org/apache/maven/shared/filtering/PropertyUtils.java b/src/main/java/org/apache/maven/shared/filtering/PropertyUtils.java
index df94eda..8e7ada0 100755
--- a/src/main/java/org/apache/maven/shared/filtering/PropertyUtils.java
+++ b/src/main/java/org/apache/maven/shared/filtering/PropertyUtils.java
@@ -18,6 +18,7 @@ package org.apache.maven.shared.filtering;
  * specific language governing permissions and limitations
  * under the License.
  */
+
 import org.codehaus.plexus.util.IOUtil;
 import org.codehaus.plexus.util.StringUtils;
 
@@ -36,6 +37,9 @@ import java.util.Properties;
  */
 public final class PropertyUtils
 {
+    /**
+     * private empty constructor to prevent instantiation
+     */
     private PropertyUtils()
     {
         // prevent instantiation
@@ -44,8 +48,8 @@ public final class PropertyUtils
     /**
      * Reads a property file, resolving all internal variables, using the supplied base properties.
      * <p>
-     * The properties are resolved iteratively, so if the value of property A refers to property B, then after resolution
-     * the value of property B will contain the value of property B.
+     * The properties are resolved iteratively, so if the value of property A refers to property B, 
+     * then after resolution the value of property B will contain the value of property B.
      * </p>
      * 
      * @param propFile The property file to load.
@@ -109,26 +113,27 @@ public final class PropertyUtils
         
         final Properties baseProps = new Properties();
 
-        if (useSystemProps) 
+        if ( useSystemProps )
         {
-            baseProps.putAll(System.getProperties());
+            baseProps.putAll( System.getProperties() );
         }
 
         final Properties resolvedProps = new Properties();
-        try 
+        try
         {
-            resolvedProps.putAll(loadPropertyFile(propfile, baseProps));
-        } catch (FileNotFoundException e)
+            resolvedProps.putAll( loadPropertyFile( propfile, baseProps ) );
+        }
+        catch ( FileNotFoundException e )
         {
-            if (fail) 
+            if ( fail )
             {
-                throw new FileNotFoundException(propfile.toString());
+                throw new FileNotFoundException( propfile.toString() );
             }
         }
 
-        if (useSystemProps) 
+        if ( useSystemProps )
         {
-            resolvedProps.putAll(baseProps);
+            resolvedProps.putAll( baseProps );
         }
 
         return resolvedProps;
diff --git a/src/main/java/org/apache/maven/shared/filtering/ReflectionProperties.java b/src/main/java/org/apache/maven/shared/filtering/ReflectionProperties.java
index 2663eac..dd35a46 100755
--- a/src/main/java/org/apache/maven/shared/filtering/ReflectionProperties.java
+++ b/src/main/java/org/apache/maven/shared/filtering/ReflectionProperties.java
@@ -38,11 +38,11 @@ public class ReflectionProperties
 
     private MavenProject project;
 
-    boolean escapedBackslashesInFilePath;
+    private boolean escapedBackslashesInFilePath;
 
     public ReflectionProperties( MavenProject mavenProject  ) 
     {
-       this(mavenProject, false);
+       this( mavenProject, false );
     }    
     
     public ReflectionProperties( MavenProject mavenProject, boolean escapedBackslashesInFilePath ) 
@@ -56,7 +56,7 @@ public class ReflectionProperties
     
     public Object get( Object key )
     {
-        if (key == null || StringUtils.isEmpty( key.toString() ))
+        if ( key == null || StringUtils.isEmpty( key.toString() ) )
         {
             return null;
         }