This is an automated email from the ASF dual-hosted git repository. slachiewicz pushed a commit to branch cleanup2 in repository https://gitbox.apache.org/repos/asf/maven-dependency-analyzer.git
commit 817e5b408e8ed4765ba1f9f7226c122a5607a98b Author: Sylwester Lachiewicz <[email protected]> AuthorDate: Tue Aug 18 22:38:12 2020 +0200 Cleanup code, javadocs, use Java 7 --- pom.xml | 28 ++++---- .../shared/dependency/analyzer/ClassAnalyzer.java | 16 +++-- .../dependency/analyzer/ClassFileVisitor.java | 11 ++- .../dependency/analyzer/ClassFileVisitorUtils.java | 43 ++++-------- .../analyzer/CollectorClassFileVisitor.java | 26 +++---- .../dependency/analyzer/DefaultClassAnalyzer.java | 5 +- .../analyzer/DefaultProjectDependencyAnalyzer.java | 50 ++++---------- .../dependency/analyzer/DependencyAnalyzer.java | 16 +++-- .../analyzer/ProjectDependencyAnalysis.java | 80 +++++++++++++--------- .../analyzer/ProjectDependencyAnalyzer.java | 16 +++-- .../ProjectDependencyAnalyzerException.java | 20 ++++-- .../analyzer/asm/ASMDependencyAnalyzer.java | 11 +-- .../analyzer/asm/ConstantPoolParser.java | 32 +++++++-- .../analyzer/asm/DefaultAnnotationVisitor.java | 13 ++-- .../analyzer/asm/DefaultClassVisitor.java | 42 +++++++++--- .../analyzer/asm/DefaultFieldVisitor.java | 8 ++- .../analyzer/asm/DefaultMethodVisitor.java | 22 ++++-- .../analyzer/asm/DefaultSignatureVisitor.java | 8 ++- .../analyzer/asm/DependencyClassFileVisitor.java | 19 ++--- .../dependency/analyzer/asm/ResultCollector.java | 17 +++++ src/site/site.xml | 2 +- 21 files changed, 281 insertions(+), 204 deletions(-) diff --git a/pom.xml b/pom.xml index b700b29..48c1c1e 100644 --- a/pom.xml +++ b/pom.xml @@ -25,7 +25,7 @@ <groupId>org.apache.maven.shared</groupId> <artifactId>maven-shared-components</artifactId> <version>34</version> - <relativePath>../../pom/maven/maven-shared-components/pom.xml</relativePath> + <relativePath /> </parent> <artifactId>maven-dependency-analyzer</artifactId> @@ -133,24 +133,22 @@ </dependencies> <build> + <pluginManagement> + <plugins> + <plugin> + <artifactId>maven-javadoc-plugin</artifactId> + <version>3.2.0</version> + </plugin> + <plugin> + <artifactId>maven-project-info-reports-plugin</artifactId> + <version>3.1.0</version> + </plugin> + </plugins> + </pluginManagement> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-enforcer-plugin</artifactId> - <executions> - <execution> - <id>enforce-bytecode-version</id> - <configuration> - <rules> - <enforceBytecodeVersion> - <ignoreClasses> - <ignoreClass>module-info</ignoreClass> - </ignoreClasses> - </enforceBytecodeVersion> - </rules> - </configuration> - </execution> - </executions> </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId> diff --git a/src/main/java/org/apache/maven/shared/dependency/analyzer/ClassAnalyzer.java b/src/main/java/org/apache/maven/shared/dependency/analyzer/ClassAnalyzer.java index deb5746..6f8adca 100644 --- a/src/main/java/org/apache/maven/shared/dependency/analyzer/ClassAnalyzer.java +++ b/src/main/java/org/apache/maven/shared/dependency/analyzer/ClassAnalyzer.java @@ -25,18 +25,22 @@ import java.util.Set; /** * Gets the set of classes contained in a library given either as a jar file or an exploded directory. - * + * * @author <a href="mailto:[email protected]";>Mark Hobson</a> - * @version $Id$ */ public interface ClassAnalyzer { - // fields ----------------------------------------------------------------- - + /** Constant <code>ROLE="ClassAnalyzer.class.getName()"</code> */ + @Deprecated String ROLE = ClassAnalyzer.class.getName(); - // public methods --------------------------------------------------------- - + /** + * <p>analyze.</p> + * + * @param url a {@link java.net.URL} object. + * @return a {@link java.util.Set} object. + * @throws java.io.IOException if any. + */ Set<String> analyze( URL url ) throws IOException; } diff --git a/src/main/java/org/apache/maven/shared/dependency/analyzer/ClassFileVisitor.java b/src/main/java/org/apache/maven/shared/dependency/analyzer/ClassFileVisitor.java index ab8e4c5..ffa87d5 100644 --- a/src/main/java/org/apache/maven/shared/dependency/analyzer/ClassFileVisitor.java +++ b/src/main/java/org/apache/maven/shared/dependency/analyzer/ClassFileVisitor.java @@ -22,12 +22,17 @@ package org.apache.maven.shared.dependency.analyzer; import java.io.InputStream; /** - * - * + * <p>ClassFileVisitor interface.</p> + * * @author <a href="mailto:[email protected]";>Mark Hobson</a> - * @version $Id$ */ public interface ClassFileVisitor { + /** + * <p>visitClass.</p> + * + * @param className a {@link java.lang.String} object. + * @param in a {@link java.io.InputStream} object. + */ void visitClass( String className, InputStream in ); } diff --git a/src/main/java/org/apache/maven/shared/dependency/analyzer/ClassFileVisitorUtils.java b/src/main/java/org/apache/maven/shared/dependency/analyzer/ClassFileVisitorUtils.java index 35eb420..412b02a 100644 --- a/src/main/java/org/apache/maven/shared/dependency/analyzer/ClassFileVisitorUtils.java +++ b/src/main/java/org/apache/maven/shared/dependency/analyzer/ClassFileVisitorUtils.java @@ -31,28 +31,26 @@ import java.net.URL; import java.util.jar.JarEntry; import java.util.jar.JarInputStream; - /** * Utility to visit classes in a library given either as a jar file or an exploded directory. - * + * * @author <a href="mailto:[email protected]";>Mark Hobson</a> - * @version $Id$ */ public final class ClassFileVisitorUtils { - // constants -------------------------------------------------------------- - - private static final String[] CLASS_INCLUDES = { "**/*.class" }; - - // constructors ----------------------------------------------------------- private ClassFileVisitorUtils() { // private constructor for utility class } - // public methods --------------------------------------------------------- - + /** + * <p>accept.</p> + * + * @param url a {@link java.net.URL} object. + * @param visitor a {@link org.apache.maven.shared.dependency.analyzer.ClassFileVisitor} object. + * @throws java.io.IOException if any. + */ public static void accept( URL url, ClassFileVisitor visitor ) throws IOException { @@ -77,9 +75,8 @@ public final class ClassFileVisitorUtils } catch ( URISyntaxException exception ) { - IllegalArgumentException e = new IllegalArgumentException( "Cannot accept visitor on URL: " + url ); - e.initCause( exception ); - throw e; + throw new IllegalArgumentException( "Cannot accept visitor on URL: " + url, + exception ); } } else @@ -93,15 +90,12 @@ public final class ClassFileVisitorUtils private static void acceptJar( URL url, ClassFileVisitor visitor ) throws IOException { - JarInputStream in = new JarInputStream( url.openStream() ); - try + try ( JarInputStream in = new JarInputStream( url.openStream() ) ) { - JarEntry entry = null; - + JarEntry entry; while ( ( entry = in.getNextJarEntry() ) != null ) { String name = entry.getName(); - // ignore files like package-info.class and module-info.class if ( name.endsWith( ".class" ) && name.indexOf( '-' ) == -1 ) { @@ -109,10 +103,6 @@ public final class ClassFileVisitorUtils } } } - finally - { - in.close(); - } } private static void acceptDirectory( File directory, ClassFileVisitor visitor ) @@ -126,7 +116,7 @@ public final class ClassFileVisitorUtils DirectoryScanner scanner = new DirectoryScanner(); scanner.setBasedir( directory ); - scanner.setIncludes( CLASS_INCLUDES ); + scanner.setIncludes( new String[] { "**/*.class" } ); scanner.scan(); @@ -137,16 +127,11 @@ public final class ClassFileVisitorUtils path = path.replace( File.separatorChar, '/' ); File file = new File( directory, path ); - FileInputStream in = new FileInputStream( file ); - try + try ( InputStream in = new FileInputStream( file ) ) { visitClass( path, in, visitor ); } - finally - { - in.close(); - } } } diff --git a/src/main/java/org/apache/maven/shared/dependency/analyzer/CollectorClassFileVisitor.java b/src/main/java/org/apache/maven/shared/dependency/analyzer/CollectorClassFileVisitor.java index ef6c7f0..2c66488 100644 --- a/src/main/java/org/apache/maven/shared/dependency/analyzer/CollectorClassFileVisitor.java +++ b/src/main/java/org/apache/maven/shared/dependency/analyzer/CollectorClassFileVisitor.java @@ -25,38 +25,34 @@ import java.util.Set; /** * Simply collects the set of visited classes. - * + * * @author <a href="mailto:[email protected]";>Mark Hobson</a> - * @version $Id$ * @see #getClasses() */ public class CollectorClassFileVisitor implements ClassFileVisitor { - // fields ----------------------------------------------------------------- - private final Set<String> classes; - // constructors ----------------------------------------------------------- - + /** + * <p>Constructor for CollectorClassFileVisitor.</p> + */ public CollectorClassFileVisitor() { - classes = new HashSet<String>(); + classes = new HashSet<>(); } - // ClassFileVisitor methods ----------------------------------------------- - - /* - * @see org.apache.maven.shared.dependency.analyzer.ClassFileVisitor#visitClass(java.lang.String, - * java.io.InputStream) - */ + /** {@inheritDoc} */ public void visitClass( String className, InputStream in ) { classes.add( className ); } - // public methods --------------------------------------------------------- - + /** + * <p>Getter for the field <code>classes</code>.</p> + * + * @return a {@link java.util.Set} object. + */ public Set<String> getClasses() { return classes; diff --git a/src/main/java/org/apache/maven/shared/dependency/analyzer/DefaultClassAnalyzer.java b/src/main/java/org/apache/maven/shared/dependency/analyzer/DefaultClassAnalyzer.java index 89c3a15..52ecd18 100644 --- a/src/main/java/org/apache/maven/shared/dependency/analyzer/DefaultClassAnalyzer.java +++ b/src/main/java/org/apache/maven/shared/dependency/analyzer/DefaultClassAnalyzer.java @@ -27,17 +27,16 @@ import java.util.zip.ZipException; import org.codehaus.plexus.component.annotations.Component; /** - * + * <p>DefaultClassAnalyzer class.</p> * * @author <a href="mailto:[email protected]";>Mark Hobson</a> - * @version $Id$ */ @Component( role = ClassAnalyzer.class ) public class DefaultClassAnalyzer implements ClassAnalyzer { - // ClassAnalyzer methods -------------------------------------------------- + /** {@inheritDoc} */ public Set<String> analyze( URL url ) throws IOException { diff --git a/src/main/java/org/apache/maven/shared/dependency/analyzer/DefaultProjectDependencyAnalyzer.java b/src/main/java/org/apache/maven/shared/dependency/analyzer/DefaultProjectDependencyAnalyzer.java index 7b05372..b4b505c 100644 --- a/src/main/java/org/apache/maven/shared/dependency/analyzer/DefaultProjectDependencyAnalyzer.java +++ b/src/main/java/org/apache/maven/shared/dependency/analyzer/DefaultProjectDependencyAnalyzer.java @@ -38,15 +38,14 @@ import org.codehaus.plexus.component.annotations.Component; import org.codehaus.plexus.component.annotations.Requirement; /** + * <p>DefaultProjectDependencyAnalyzer class.</p> + * * @author <a href="mailto:[email protected]";>Mark Hobson</a> - * @version $Id$ */ @Component( role = ProjectDependencyAnalyzer.class ) public class DefaultProjectDependencyAnalyzer implements ProjectDependencyAnalyzer { - // fields ----------------------------------------------------------------- - /** * ClassAnalyzer */ @@ -59,11 +58,7 @@ public class DefaultProjectDependencyAnalyzer @Requirement private DependencyAnalyzer dependencyAnalyzer; - // ProjectDependencyAnalyzer methods -------------------------------------- - - /* - * @see org.apache.maven.shared.dependency.analyzer.ProjectDependencyAnalyzer#analyze(org.apache.maven.project.MavenProject) - */ + /** {@inheritDoc} */ public ProjectDependencyAnalysis analyze( MavenProject project ) throws ProjectDependencyAnalyzerException { @@ -81,13 +76,13 @@ public class DefaultProjectDependencyAnalyzer Set<Artifact> testOnlyArtifacts = buildUsedArtifacts( artifactClassMap, testOnlyDependencyClasses ); - Set<Artifact> usedDeclaredArtifacts = new LinkedHashSet<Artifact>( declaredArtifacts ); + Set<Artifact> usedDeclaredArtifacts = new LinkedHashSet<>( declaredArtifacts ); usedDeclaredArtifacts.retainAll( usedArtifacts ); - Set<Artifact> usedUndeclaredArtifacts = new LinkedHashSet<Artifact>( usedArtifacts ); + Set<Artifact> usedUndeclaredArtifacts = new LinkedHashSet<>( usedArtifacts ); usedUndeclaredArtifacts = removeAll( usedUndeclaredArtifacts, declaredArtifacts ); - Set<Artifact> unusedDeclaredArtifacts = new LinkedHashSet<Artifact>( declaredArtifacts ); + Set<Artifact> unusedDeclaredArtifacts = new LinkedHashSet<>( declaredArtifacts ); unusedDeclaredArtifacts = removeAll( unusedDeclaredArtifacts, usedArtifacts ); Set<Artifact> testArtifactsWithNonTestScope = getTestArtifactsWithNonTestScope( testOnlyArtifacts ); @@ -111,7 +106,7 @@ public class DefaultProjectDependencyAnalyzer */ private Set<Artifact> removeAll( Set<Artifact> start, Set<Artifact> remove ) { - Set<Artifact> results = new LinkedHashSet<Artifact>( start.size() ); + Set<Artifact> results = new LinkedHashSet<>( start.size() ); for ( Artifact artifact : start ) { @@ -137,7 +132,7 @@ public class DefaultProjectDependencyAnalyzer private Set<Artifact> getTestArtifactsWithNonTestScope( Set<Artifact> testOnlyArtifacts ) { - Set<Artifact> nonTestScopeArtifacts = new LinkedHashSet<Artifact>(); + Set<Artifact> nonTestScopeArtifacts = new LinkedHashSet<>(); for ( Artifact artifact : testOnlyArtifacts ) { @@ -153,7 +148,7 @@ public class DefaultProjectDependencyAnalyzer private Map<Artifact, Set<String>> buildArtifactClassMap( MavenProject project ) throws IOException { - Map<Artifact, Set<String>> artifactClassMap = new LinkedHashMap<Artifact, Set<String>>(); + Map<Artifact, Set<String>> artifactClassMap = new LinkedHashMap<>(); @SuppressWarnings( "unchecked" ) Set<Artifact> dependencyArtifacts = project.getArtifacts(); @@ -165,13 +160,12 @@ public class DefaultProjectDependencyAnalyzer if ( file != null && file.getName().endsWith( ".jar" ) ) { // optimized solution for the jar case - JarFile jarFile = new JarFile( file ); - try + try ( JarFile jarFile = new JarFile( file ) ) { Enumeration<JarEntry> jarEntries = jarFile.entries(); - Set<String> classes = new HashSet<String>(); + Set<String> classes = new HashSet<>(); while ( jarEntries.hasMoreElements() ) { @@ -186,17 +180,6 @@ public class DefaultProjectDependencyAnalyzer artifactClassMap.put( artifact, classes ); } - finally - { - try - { - jarFile.close(); - } - catch ( IOException ignore ) - { - // ingore - } - } } else if ( file != null && file.isDirectory() ) { @@ -212,15 +195,13 @@ public class DefaultProjectDependencyAnalyzer private Set<String> buildTestDependencyClasses( MavenProject project ) throws IOException { - Set<String> nonTestDependencyClasses = new HashSet<>(); - Set<String> testDependencyClasses = new HashSet<>(); Set<String> testOnlyDependencyClasses = new HashSet<>(); String outputDirectory = project.getBuild().getOutputDirectory(); - nonTestDependencyClasses.addAll( buildDependencyClasses( outputDirectory ) ); + Set<String> nonTestDependencyClasses = new HashSet<>( buildDependencyClasses( outputDirectory ) ); String testOutputDirectory = project.getBuild().getTestOutputDirectory(); - testDependencyClasses.addAll( buildDependencyClasses( testOutputDirectory ) ); + Set<String> testDependencyClasses = new HashSet<>( buildDependencyClasses( testOutputDirectory ) ); for ( String testString : testDependencyClasses ) { @@ -236,10 +217,9 @@ public class DefaultProjectDependencyAnalyzer private Set<String> buildDependencyClasses( MavenProject project ) throws IOException { - Set<String> dependencyClasses = new HashSet<String>(); String outputDirectory = project.getBuild().getOutputDirectory(); - dependencyClasses.addAll( buildDependencyClasses( outputDirectory ) ); + Set<String> dependencyClasses = new HashSet<>( buildDependencyClasses( outputDirectory ) ); String testOutputDirectory = project.getBuild().getTestOutputDirectory(); dependencyClasses.addAll( buildDependencyClasses( testOutputDirectory ) ); @@ -271,7 +251,7 @@ public class DefaultProjectDependencyAnalyzer private Set<Artifact> buildUsedArtifacts( Map<Artifact, Set<String>> artifactClassMap, Set<String> dependencyClasses ) { - Set<Artifact> usedArtifacts = new HashSet<Artifact>(); + Set<Artifact> usedArtifacts = new HashSet<>(); for ( String className : dependencyClasses ) { diff --git a/src/main/java/org/apache/maven/shared/dependency/analyzer/DependencyAnalyzer.java b/src/main/java/org/apache/maven/shared/dependency/analyzer/DependencyAnalyzer.java index 5de91e9..5ea73e1 100644 --- a/src/main/java/org/apache/maven/shared/dependency/analyzer/DependencyAnalyzer.java +++ b/src/main/java/org/apache/maven/shared/dependency/analyzer/DependencyAnalyzer.java @@ -25,18 +25,22 @@ import java.util.Set; /** * Gets the set of classes referenced by a library given either as a jar file or an exploded directory. - * + * * @author <a href="mailto:[email protected]";>Mark Hobson</a> - * @version $Id$ */ public interface DependencyAnalyzer { - // fields ----------------------------------------------------------------- - + /** Constant <code>ROLE="DependencyAnalyzer.class.getName()"</code> */ + @Deprecated String ROLE = DependencyAnalyzer.class.getName(); - // public methods --------------------------------------------------------- - + /** + * <p>analyze.</p> + * + * @param url a {@link java.net.URL} object. + * @return a {@link java.util.Set} object. + * @throws java.io.IOException if any. + */ Set<String> analyze( URL url ) throws IOException; } diff --git a/src/main/java/org/apache/maven/shared/dependency/analyzer/ProjectDependencyAnalysis.java b/src/main/java/org/apache/maven/shared/dependency/analyzer/ProjectDependencyAnalysis.java index ecfc6d1..e92ec2a 100644 --- a/src/main/java/org/apache/maven/shared/dependency/analyzer/ProjectDependencyAnalysis.java +++ b/src/main/java/org/apache/maven/shared/dependency/analyzer/ProjectDependencyAnalysis.java @@ -30,9 +30,8 @@ import org.apache.maven.artifact.Artifact; /** * Project dependencies analysis result. - * + * * @author <a href="mailto:[email protected]";>Mark Hobson</a> - * @version $Id$ */ public class ProjectDependencyAnalysis { @@ -46,14 +45,21 @@ public class ProjectDependencyAnalysis private final Set<Artifact> testArtifactsWithNonTestScope; - // constructors ----------------------------------------------------------- - + /** + * <p>Constructor for ProjectDependencyAnalysis.</p> + */ public ProjectDependencyAnalysis() { this( null, null, null, null ); } - // constructor to maintain compatibility with old API + /** + * <p>Constructor for ProjectDependencyAnalysis to maintain compatibility with old API</p> + * + * @param usedDeclaredArtifacts a {@link java.util.Set} object. + * @param usedUndeclaredArtifacts a {@link java.util.Set} object. + * @param unusedDeclaredArtifacts a {@link java.util.Set} object. + */ public ProjectDependencyAnalysis( Set<Artifact> usedDeclaredArtifacts, Set<Artifact> usedUndeclaredArtifacts, Set<Artifact> unusedDeclaredArtifacts ) { @@ -63,6 +69,14 @@ public class ProjectDependencyAnalysis this.testArtifactsWithNonTestScope = new HashSet<>(); } + /** + * <p>Constructor for ProjectDependencyAnalysis.</p> + * + * @param usedDeclaredArtifacts a {@link java.util.Set} object. + * @param usedUndeclaredArtifacts a {@link java.util.Set} object. + * @param unusedDeclaredArtifacts a {@link java.util.Set} object. + * @param testArtifactsWithNonTestScope a {@link java.util.Set} object. + */ public ProjectDependencyAnalysis( Set<Artifact> usedDeclaredArtifacts, Set<Artifact> usedUndeclaredArtifacts, Set<Artifact> unusedDeclaredArtifacts, Set<Artifact> testArtifactsWithNonTestScope ) @@ -73,11 +87,10 @@ public class ProjectDependencyAnalysis this.testArtifactsWithNonTestScope = safeCopy( testArtifactsWithNonTestScope ); } - // public methods --------------------------------------------------------- - /** * Used and declared artifacts. - * @return {@link Artifact} + * + * @return {@link org.apache.maven.artifact.Artifact} */ public Set<Artifact> getUsedDeclaredArtifacts() { @@ -86,7 +99,8 @@ public class ProjectDependencyAnalysis /** * Used but not declared artifacts. - * @return {@link Artifact} + * + * @return {@link org.apache.maven.artifact.Artifact} */ public Set<Artifact> getUsedUndeclaredArtifacts() { @@ -95,7 +109,8 @@ public class ProjectDependencyAnalysis /** * Unused but declared artifacts. - * @return {@link Artifact} + * + * @return {@link org.apache.maven.artifact.Artifact} */ public Set<Artifact> getUnusedDeclaredArtifacts() { @@ -104,7 +119,8 @@ public class ProjectDependencyAnalysis /** * Test Artifacts that have a non-test scope - * @return {@link Artifact} + * + * @return {@link org.apache.maven.artifact.Artifact} */ public Set<Artifact> getTestArtifactsWithNonTestScope() { @@ -113,13 +129,13 @@ public class ProjectDependencyAnalysis /** * Filter not-compile scoped artifacts from unused declared. - * + * * @return updated project dependency analysis * @since 1.3 */ public ProjectDependencyAnalysis ignoreNonCompile() { - Set<Artifact> filteredUnusedDeclared = new HashSet<Artifact>( unusedDeclaredArtifacts ); + Set<Artifact> filteredUnusedDeclared = new HashSet<>( unusedDeclaredArtifacts ); for ( Iterator<Artifact> iter = filteredUnusedDeclared.iterator(); iter.hasNext(); ) { Artifact artifact = iter.next(); @@ -136,23 +152,25 @@ public class ProjectDependencyAnalysis /** * Force use status of some declared dependencies, to manually fix consequences of bytecode-level analysis which * happens to not detect some effective use (constants, annotation with source-retention, javadoc). - * + * * @param forceUsedDependencies dependencies to move from "unused-declared" to "used-declared", with - * <code>groupId:artifactId</code> format + * <code>groupId:artifactId</code> format * @return updated project dependency analysis * @throws ProjectDependencyAnalyzerException if dependencies forced were either not declared or already detected as - * used + * used * @since 1.3 */ + @SuppressWarnings( "UnusedReturnValue" ) public ProjectDependencyAnalysis forceDeclaredDependenciesUsage( String[] forceUsedDependencies ) throws ProjectDependencyAnalyzerException { - Set<String> forced = new HashSet<String>( Arrays.asList( forceUsedDependencies ) ); + Set<String> forced = new HashSet<>( Arrays.asList( forceUsedDependencies ) ); - Set<Artifact> forcedUnusedDeclared = new HashSet<Artifact>( unusedDeclaredArtifacts ); - Set<Artifact> forcedUsedDeclared = new HashSet<Artifact>( usedDeclaredArtifacts ); + Set<Artifact> forcedUnusedDeclared = new HashSet<>( unusedDeclaredArtifacts ); + Set<Artifact> forcedUsedDeclared = new HashSet<>( usedDeclaredArtifacts ); - for ( Iterator<Artifact> iter = forcedUnusedDeclared.iterator(); iter.hasNext(); ) + Iterator<Artifact> iter = forcedUnusedDeclared.iterator(); + while ( iter.hasNext() ) { Artifact artifact = iter.next(); @@ -167,7 +185,7 @@ public class ProjectDependencyAnalysis if ( !forced.isEmpty() ) { // trying to force dependencies as used-declared which were not declared or already detected as used - Set<String> used = new HashSet<String>(); + Set<String> used = new HashSet<>(); for ( Artifact artifact : usedDeclaredArtifacts ) { String id = artifact.getGroupId() + ':' + artifact.getArtifactId(); @@ -197,10 +215,10 @@ public class ProjectDependencyAnalysis testArtifactsWithNonTestScope ); } - // Object methods --------------------------------------------------------- - - /* - * @see java.lang.Object#hashCode() + /** + * <p>hashCode.</p> + * + * @return a int. */ public int hashCode() { @@ -212,9 +230,7 @@ public class ProjectDependencyAnalysis return hashCode; } - /* - * @see java.lang.Object#equals(java.lang.Object) - */ + /** {@inheritDoc} */ public boolean equals( Object object ) { if ( object instanceof ProjectDependencyAnalysis ) @@ -230,8 +246,10 @@ public class ProjectDependencyAnalysis return false; } - /* - * @see java.lang.Object#toString() + /** + * <p>toString.</p> + * + * @return a {@link java.lang.String} object. */ public String toString() { @@ -285,6 +303,6 @@ public class ProjectDependencyAnalysis private Set<Artifact> safeCopy( Set<Artifact> set ) { return ( set == null ) ? Collections.<Artifact>emptySet() - : Collections.unmodifiableSet( new LinkedHashSet<Artifact>( set ) ); + : Collections.unmodifiableSet( new LinkedHashSet<>( set ) ); } } diff --git a/src/main/java/org/apache/maven/shared/dependency/analyzer/ProjectDependencyAnalyzer.java b/src/main/java/org/apache/maven/shared/dependency/analyzer/ProjectDependencyAnalyzer.java index 7673997..9b406d4 100644 --- a/src/main/java/org/apache/maven/shared/dependency/analyzer/ProjectDependencyAnalyzer.java +++ b/src/main/java/org/apache/maven/shared/dependency/analyzer/ProjectDependencyAnalyzer.java @@ -28,18 +28,22 @@ import org.apache.maven.project.MavenProject; * <li>used but not declared,</li> * <li>not used but declared.</li> * </ul> - * + * * @author <a href="mailto:[email protected]";>Mark Hobson</a> - * @version $Id$ */ public interface ProjectDependencyAnalyzer { - // fields ----------------------------------------------------------------- - + /** Constant <code>ROLE="ProjectDependencyAnalyzer.class.getName"{trunked}</code> */ + @Deprecated String ROLE = ProjectDependencyAnalyzer.class.getName(); - // public methods --------------------------------------------------------- - + /** + * <p>analyze.</p> + * + * @param project a {@link org.apache.maven.project.MavenProject} object. + * @return a {@link org.apache.maven.shared.dependency.analyzer.ProjectDependencyAnalysis} object. + * @throws org.apache.maven.shared.dependency.analyzer.ProjectDependencyAnalyzerException if any. + */ ProjectDependencyAnalysis analyze( MavenProject project ) throws ProjectDependencyAnalyzerException; } diff --git a/src/main/java/org/apache/maven/shared/dependency/analyzer/ProjectDependencyAnalyzerException.java b/src/main/java/org/apache/maven/shared/dependency/analyzer/ProjectDependencyAnalyzerException.java index 34bd8a0..de7abaa 100644 --- a/src/main/java/org/apache/maven/shared/dependency/analyzer/ProjectDependencyAnalyzerException.java +++ b/src/main/java/org/apache/maven/shared/dependency/analyzer/ProjectDependencyAnalyzerException.java @@ -20,28 +20,34 @@ package org.apache.maven.shared.dependency.analyzer; */ /** - * - * + * <p>ProjectDependencyAnalyzerException class.</p> + * * @author <a href="mailto:[email protected]";>Mark Hobson</a> - * @version $Id$ */ public class ProjectDependencyAnalyzerException extends Exception { - // constants -------------------------------------------------------------- - /** * The serialisation unique ID. */ private static final long serialVersionUID = -5954447543668196977L; - // constructors ----------------------------------------------------------- - + /** + * <p>Constructor for ProjectDependencyAnalyzerException.</p> + * + * @param message a {@link java.lang.String} object. + */ public ProjectDependencyAnalyzerException( String message ) { super( message ); } + /** + * <p>Constructor for ProjectDependencyAnalyzerException.</p> + * + * @param message a {@link java.lang.String} object. + * @param cause a {@link java.lang.Throwable} object. + */ public ProjectDependencyAnalyzerException( String message, Throwable cause ) { super( message, cause ); diff --git a/src/main/java/org/apache/maven/shared/dependency/analyzer/asm/ASMDependencyAnalyzer.java b/src/main/java/org/apache/maven/shared/dependency/analyzer/asm/ASMDependencyAnalyzer.java index facad09..2836c4d 100644 --- a/src/main/java/org/apache/maven/shared/dependency/analyzer/asm/ASMDependencyAnalyzer.java +++ b/src/main/java/org/apache/maven/shared/dependency/analyzer/asm/ASMDependencyAnalyzer.java @@ -28,20 +28,15 @@ import org.apache.maven.shared.dependency.analyzer.DependencyAnalyzer; import org.codehaus.plexus.component.annotations.Component; /** - * ASMDependencyAnalyzer - * + * ASMDependencyAnalyzer + * * @author <a href="mailto:[email protected]";>Mark Hobson</a> - * @version $Id$ */ @Component( role = DependencyAnalyzer.class ) public class ASMDependencyAnalyzer implements DependencyAnalyzer { - // DependencyAnalyzer methods --------------------------------------------- - - /* - * @see org.apache.maven.shared.dependency.analyzer.DependencyAnalyzer#analyze(java.net.URL) - */ + /** {@inheritDoc} */ public Set<String> analyze( URL url ) throws IOException { diff --git a/src/main/java/org/apache/maven/shared/dependency/analyzer/asm/ConstantPoolParser.java b/src/main/java/org/apache/maven/shared/dependency/analyzer/asm/ConstantPoolParser.java index c0e0cac..81494ed 100644 --- a/src/main/java/org/apache/maven/shared/dependency/analyzer/asm/ConstantPoolParser.java +++ b/src/main/java/org/apache/maven/shared/dependency/analyzer/asm/ConstantPoolParser.java @@ -33,48 +33,65 @@ import java.util.Set; * ASM does not support. * * Adapted from http://stackoverflow.com/a/32278587/23691 - * + * * Constant pool types: - * + * * @see <a href="https://docs.oracle.com/javase/specs/jvms/se9/html/jvms-4.html#jvms-4.4";>JVM 9 Sepc</a> * @see <a href="https://docs.oracle.com/javase/specs/jvms/se10/html/jvms-4.html#jvms-4.4";>JVM 10 Sepc</a> - * */ public class ConstantPoolParser { + /** Constant <code>HEAD=0xcafebabe</code> */ public static final int HEAD = 0xcafebabe; // Constant pool types + + /** Constant <code>CONSTANT_UTF8=1</code> */ public static final byte CONSTANT_UTF8 = 1; + /** Constant <code>CONSTANT_INTEGER=3</code> */ public static final byte CONSTANT_INTEGER = 3; + /** Constant <code>CONSTANT_FLOAT=4</code> */ public static final byte CONSTANT_FLOAT = 4; + /** Constant <code>CONSTANT_LONG=5</code> */ public static final byte CONSTANT_LONG = 5; + /** Constant <code>CONSTANT_DOUBLE=6</code> */ public static final byte CONSTANT_DOUBLE = 6; + /** Constant <code>CONSTANT_CLASS=7</code> */ public static final byte CONSTANT_CLASS = 7; + /** Constant <code>CONSTANT_STRING=8</code> */ public static final byte CONSTANT_STRING = 8; + /** Constant <code>CONSTANT_FIELDREF=9</code> */ public static final byte CONSTANT_FIELDREF = 9; + /** Constant <code>CONSTANT_METHODREF=10</code> */ public static final byte CONSTANT_METHODREF = 10; + /** Constant <code>CONSTANT_INTERFACEMETHODREF=11</code> */ public static final byte CONSTANT_INTERFACEMETHODREF = 11; + /** Constant <code>CONSTANT_NAME_AND_TYPE=12</code> */ public static final byte CONSTANT_NAME_AND_TYPE = 12; + /** Constant <code>CONSTANT_METHODHANDLE=15</code> */ public static final byte CONSTANT_METHODHANDLE = 15; + /** Constant <code>CONSTANT_METHOD_TYPE=16</code> */ public static final byte CONSTANT_METHOD_TYPE = 16; + /** Constant <code>CONSTANT_INVOKE_DYNAMIC=18</code> */ public static final byte CONSTANT_INVOKE_DYNAMIC = 18; - + + /** Constant <code>CONSTANT_MODULE=19</code> */ public static final byte CONSTANT_MODULE = 19; + /** Constant <code>CONSTANT_PACKAGE=20</code> */ public static final byte CONSTANT_PACKAGE = 20; private static final int OXF0 = 0xf0; @@ -96,8 +113,8 @@ public class ConstantPoolParser return Collections.emptySet(); } buf.getChar() ; buf.getChar(); // minor + ver - Set<Integer> classes = new HashSet<Integer>(); - Map<Integer, String> stringConstants = new HashMap<Integer, String>(); + Set<Integer> classes = new HashSet<>(); + Map<Integer, String> stringConstants = new HashMap<>(); for ( int ix = 1, num = buf.getChar(); ix < num; ix++ ) { byte tag = buf.get(); @@ -150,7 +167,7 @@ public class ConstantPoolParser break; } } - Set<String> result = new HashSet<String>(); + Set<String> result = new HashSet<>(); for ( Integer aClass : classes ) { result.add( stringConstants.get( aClass ) ); @@ -162,6 +179,7 @@ public class ConstantPoolParser { int size = buf.getChar(); // Explicit cast for compatibility with covariant return type on JDK 9's ByteBuffer + @SuppressWarnings( "RedundantCast" ) int oldLimit = ( (Buffer) buf ).limit(); ( (Buffer) buf ).limit( buf.position() + size ); StringBuilder sb = new StringBuilder( size + ( size >> 1 ) + 16 ); diff --git a/src/main/java/org/apache/maven/shared/dependency/analyzer/asm/DefaultAnnotationVisitor.java b/src/main/java/org/apache/maven/shared/dependency/analyzer/asm/DefaultAnnotationVisitor.java index 6511207..6f4449c 100644 --- a/src/main/java/org/apache/maven/shared/dependency/analyzer/asm/DefaultAnnotationVisitor.java +++ b/src/main/java/org/apache/maven/shared/dependency/analyzer/asm/DefaultAnnotationVisitor.java @@ -28,19 +28,24 @@ import org.objectweb.asm.Type; * Inspired by <code>org.objectweb.asm.depend.DependencyVisitor</code> in the ASM dependencies example. * * @author <a href="mailto:[email protected]";>Mark Hobson</a> - * @version $Id$ */ public class DefaultAnnotationVisitor extends AnnotationVisitor { private final ResultCollector resultCollector; + /** + * <p>Constructor for DefaultAnnotationVisitor.</p> + * + * @param resultCollector a {@link org.apache.maven.shared.dependency.analyzer.asm.ResultCollector} object. + */ public DefaultAnnotationVisitor( ResultCollector resultCollector ) { super( Opcodes.ASM8 ); this.resultCollector = resultCollector; } + /** {@inheritDoc} */ public void visit( final String name, final Object value ) { if ( value instanceof Type ) @@ -49,11 +54,13 @@ public class DefaultAnnotationVisitor } } + /** {@inheritDoc} */ public void visitEnum( final String name, final String desc, final String value ) { resultCollector.addDesc( desc ); } + /** {@inheritDoc} */ public AnnotationVisitor visitAnnotation( final String name, final String desc ) { resultCollector.addDesc( desc ); @@ -61,9 +68,7 @@ public class DefaultAnnotationVisitor return this; } - /* - * @see org.objectweb.asm.AnnotationVisitor#visitArray(java.lang.String) - */ + /** {@inheritDoc} */ public AnnotationVisitor visitArray( final String name ) { return this; diff --git a/src/main/java/org/apache/maven/shared/dependency/analyzer/asm/DefaultClassVisitor.java b/src/main/java/org/apache/maven/shared/dependency/analyzer/asm/DefaultClassVisitor.java index 54003fd..85fb2ed 100644 --- a/src/main/java/org/apache/maven/shared/dependency/analyzer/asm/DefaultClassVisitor.java +++ b/src/main/java/org/apache/maven/shared/dependency/analyzer/asm/DefaultClassVisitor.java @@ -34,13 +34,10 @@ import org.objectweb.asm.signature.SignatureVisitor; * Inspired by <code>org.objectweb.asm.depend.DependencyVisitor</code> in the ASM dependencies example. * * @author <a href="mailto:[email protected]";>Mark Hobson</a> - * @version $Id$ */ public class DefaultClassVisitor extends ClassVisitor { - // fields ----------------------------------------------------------------- - private final ResultCollector resultCollector; private final SignatureVisitor signatureVisitor; @@ -51,8 +48,15 @@ public class DefaultClassVisitor private final MethodVisitor methodVisitor; - // constructors ----------------------------------------------------------- - + /** + * <p>Constructor for DefaultClassVisitor.</p> + * + * @param signatureVisitor a {@link org.objectweb.asm.signature.SignatureVisitor} object. + * @param annotationVisitor a {@link org.objectweb.asm.AnnotationVisitor} object. + * @param fieldVisitor a {@link org.objectweb.asm.FieldVisitor} object. + * @param methodVisitor a {@link org.objectweb.asm.MethodVisitor} object. + * @param resultCollector a {@link org.apache.maven.shared.dependency.analyzer.asm.ResultCollector} object. + */ public DefaultClassVisitor( SignatureVisitor signatureVisitor, AnnotationVisitor annotationVisitor, FieldVisitor fieldVisitor, MethodVisitor methodVisitor, ResultCollector resultCollector ) @@ -65,6 +69,16 @@ public class DefaultClassVisitor this.resultCollector = resultCollector; } + /** + * <p>visit.</p> + * + * @param version a int. + * @param access a int. + * @param name a {@link java.lang.String} object. + * @param signature a {@link java.lang.String} object. + * @param superName a {@link java.lang.String} object. + * @param interfaces an array of {@link java.lang.String} objects. + */ public void visit( final int version, final int access, final String name, final String signature, final String superName, final String[] interfaces ) { @@ -79,6 +93,7 @@ public class DefaultClassVisitor } } + /** {@inheritDoc} */ public AnnotationVisitor visitAnnotation( final String desc, final boolean visible ) { resultCollector.addDesc( desc ); @@ -86,6 +101,7 @@ public class DefaultClassVisitor return annotationVisitor; } + /** {@inheritDoc} */ public FieldVisitor visitField( final int access, final String name, final String desc, final String signature, final Object value ) { @@ -106,6 +122,16 @@ public class DefaultClassVisitor return fieldVisitor; } + /** + * <p>visitMethod.</p> + * + * @param access a int. + * @param name a {@link java.lang.String} object. + * @param desc a {@link java.lang.String} object. + * @param signature a {@link java.lang.String} object. + * @param exceptions an array of {@link java.lang.String} objects. + * @return a {@link org.objectweb.asm.MethodVisitor} object. + */ public MethodVisitor visitMethod( final int access, final String name, final String desc, final String signature, final String[] exceptions ) { @@ -123,18 +149,18 @@ public class DefaultClassVisitor return methodVisitor; } + /** {@inheritDoc} */ public void visitNestHost( final String nestHost ) { resultCollector.addName( nestHost ); } + /** {@inheritDoc} */ public void visitNestMember( final String nestMember ) { resultCollector.addName( nestMember ); } - // private methods -------------------------------------------------------- - private void addSignature( final String signature ) { if ( signature != null ) @@ -150,6 +176,4 @@ public class DefaultClassVisitor new SignatureReader( signature ).acceptType( signatureVisitor ); } } - - } diff --git a/src/main/java/org/apache/maven/shared/dependency/analyzer/asm/DefaultFieldVisitor.java b/src/main/java/org/apache/maven/shared/dependency/analyzer/asm/DefaultFieldVisitor.java index d7bd15d..d8f6aa1 100644 --- a/src/main/java/org/apache/maven/shared/dependency/analyzer/asm/DefaultFieldVisitor.java +++ b/src/main/java/org/apache/maven/shared/dependency/analyzer/asm/DefaultFieldVisitor.java @@ -28,7 +28,6 @@ import org.objectweb.asm.Opcodes; * Inspired by <code>org.objectweb.asm.depend.DependencyVisitor</code> in the ASM dependencies example. * * @author <a href="mailto:[email protected]";>Mark Hobson</a> - * @version $Id$ */ public class DefaultFieldVisitor extends FieldVisitor @@ -37,6 +36,12 @@ public class DefaultFieldVisitor private final ResultCollector resultCollector; + /** + * <p>Constructor for DefaultFieldVisitor.</p> + * + * @param annotationVisitor a {@link org.objectweb.asm.AnnotationVisitor} object. + * @param resultCollector a {@link org.apache.maven.shared.dependency.analyzer.asm.ResultCollector} object. + */ public DefaultFieldVisitor( AnnotationVisitor annotationVisitor, ResultCollector resultCollector ) { super( Opcodes.ASM8 ); @@ -44,6 +49,7 @@ public class DefaultFieldVisitor this.resultCollector = resultCollector; } + /** {@inheritDoc} */ public AnnotationVisitor visitAnnotation( final String desc, final boolean visible ) { resultCollector.addDesc( desc ); diff --git a/src/main/java/org/apache/maven/shared/dependency/analyzer/asm/DefaultMethodVisitor.java b/src/main/java/org/apache/maven/shared/dependency/analyzer/asm/DefaultMethodVisitor.java index d6128cb..0840ba3 100644 --- a/src/main/java/org/apache/maven/shared/dependency/analyzer/asm/DefaultMethodVisitor.java +++ b/src/main/java/org/apache/maven/shared/dependency/analyzer/asm/DefaultMethodVisitor.java @@ -28,13 +28,11 @@ import org.objectweb.asm.TypePath; import org.objectweb.asm.signature.SignatureReader; import org.objectweb.asm.signature.SignatureVisitor; - /** * Computes the set of classes referenced by visited code. * Inspired by <code>org.objectweb.asm.depend.DependencyVisitor</code> in the ASM dependencies example. * * @author <a href="mailto:[email protected]";>Mark Hobson</a> - * @version $Id$ */ public class DefaultMethodVisitor extends MethodVisitor @@ -45,6 +43,13 @@ public class DefaultMethodVisitor private final ResultCollector resultCollector; + /** + * <p>Constructor for DefaultMethodVisitor.</p> + * + * @param annotationVisitor a {@link org.objectweb.asm.AnnotationVisitor} object. + * @param signatureVisitor a {@link org.objectweb.asm.signature.SignatureVisitor} object. + * @param resultCollector a {@link org.apache.maven.shared.dependency.analyzer.asm.ResultCollector} object. + */ public DefaultMethodVisitor( AnnotationVisitor annotationVisitor, SignatureVisitor signatureVisitor, ResultCollector resultCollector ) { @@ -54,6 +59,7 @@ public class DefaultMethodVisitor this.resultCollector = resultCollector; } + /** {@inheritDoc} */ public AnnotationVisitor visitAnnotation( final String desc, final boolean visible ) { resultCollector.addDesc( desc ); @@ -61,6 +67,7 @@ public class DefaultMethodVisitor return annotationVisitor; } + /** {@inheritDoc} */ @Override public AnnotationVisitor visitTypeAnnotation( int typeRef, TypePath typePath, String desc, boolean visible ) { @@ -69,6 +76,7 @@ public class DefaultMethodVisitor return annotationVisitor; } + /** {@inheritDoc} */ public AnnotationVisitor visitParameterAnnotation( final int parameter, final String desc, final boolean visible ) { resultCollector.addDesc( desc ); @@ -76,6 +84,7 @@ public class DefaultMethodVisitor return annotationVisitor; } + /** {@inheritDoc} */ @Override public AnnotationVisitor visitLocalVariableAnnotation( int typeRef, TypePath typePath, Label[] start, Label[] end, int[] index, String desc, boolean visible ) @@ -85,6 +94,7 @@ public class DefaultMethodVisitor return annotationVisitor; } + /** {@inheritDoc} */ public void visitTypeInsn( final int opcode, final String desc ) { if ( desc.charAt( 0 ) == '[' ) @@ -97,6 +107,7 @@ public class DefaultMethodVisitor } } + /** {@inheritDoc} */ public void visitFieldInsn( final int opcode, final String owner, final String name, final String desc ) { resultCollector.addName( owner ); @@ -108,12 +119,14 @@ public class DefaultMethodVisitor */ } + /** {@inheritDoc} */ @Override public void visitMethodInsn( int opcode, String owner, String name, String desc, boolean itf ) { resultCollector.addName( owner ); } + /** {@inheritDoc} */ public void visitLdcInsn( final Object cst ) { if ( cst instanceof Type ) @@ -122,16 +135,19 @@ public class DefaultMethodVisitor } } + /** {@inheritDoc} */ public void visitMultiANewArrayInsn( final String desc, final int dims ) { resultCollector.addDesc( desc ); } + /** {@inheritDoc} */ public void visitTryCatchBlock( final Label start, final Label end, final Label handler, final String type ) { resultCollector.addName( type ); } + /** {@inheritDoc} */ public void visitLocalVariable( final String name, final String desc, final String signature, final Label start, final Label end, final int index ) { @@ -145,8 +161,6 @@ public class DefaultMethodVisitor } } - - private void addTypeSignature( final String signature ) { if ( signature != null ) diff --git a/src/main/java/org/apache/maven/shared/dependency/analyzer/asm/DefaultSignatureVisitor.java b/src/main/java/org/apache/maven/shared/dependency/analyzer/asm/DefaultSignatureVisitor.java index ac73810..1c27895 100644 --- a/src/main/java/org/apache/maven/shared/dependency/analyzer/asm/DefaultSignatureVisitor.java +++ b/src/main/java/org/apache/maven/shared/dependency/analyzer/asm/DefaultSignatureVisitor.java @@ -27,24 +27,30 @@ import org.objectweb.asm.signature.SignatureVisitor; * Inspired by <code>org.objectweb.asm.depend.DependencyVisitor</code> in the ASM dependencies example. * * @author <a href="mailto:[email protected]";>Mark Hobson</a> - * @version $Id$ */ public class DefaultSignatureVisitor extends SignatureVisitor { private final ResultCollector resultCollector; + /** + * <p>Constructor for DefaultSignatureVisitor.</p> + * + * @param resultCollector a {@link org.apache.maven.shared.dependency.analyzer.asm.ResultCollector} object. + */ public DefaultSignatureVisitor( ResultCollector resultCollector ) { super( Opcodes.ASM8 ); this.resultCollector = resultCollector; } + /** {@inheritDoc} */ public void visitClassType( final String name ) { resultCollector.addName( name ); } + /** {@inheritDoc} */ public void visitInnerClassType( final String name ) { resultCollector.addName( name ); diff --git a/src/main/java/org/apache/maven/shared/dependency/analyzer/asm/DependencyClassFileVisitor.java b/src/main/java/org/apache/maven/shared/dependency/analyzer/asm/DependencyClassFileVisitor.java index e0b41b0..c6f3afc 100644 --- a/src/main/java/org/apache/maven/shared/dependency/analyzer/asm/DependencyClassFileVisitor.java +++ b/src/main/java/org/apache/maven/shared/dependency/analyzer/asm/DependencyClassFileVisitor.java @@ -37,28 +37,21 @@ import java.util.Set; * <a href="DependencyVisitor.html">DependencyVisitor</a>. * * @author <a href="mailto:[email protected]";>Mark Hobson</a> - * @version $Id$ * @see #getDependencies() */ public class DependencyClassFileVisitor implements ClassFileVisitor { - // fields ----------------------------------------------------------------- - private final ResultCollector resultCollector = new ResultCollector(); - // constructors ----------------------------------------------------------- - + /** + * <p>Constructor for DependencyClassFileVisitor.</p> + */ public DependencyClassFileVisitor() { } - // ClassFileVisitor methods ----------------------------------------------- - - /* - * @see org.apache.maven.shared.dependency.analyzer.ClassFileVisitor#visitClass(java.lang.String, - * java.io.InputStream) - */ + /** {@inheritDoc} */ public void visitClass( String className, InputStream in ) { try @@ -93,9 +86,9 @@ public class DependencyClassFileVisitor } } - // public methods --------------------------------------------------------- - /** + * <p>getDependencies.</p> + * * @return the set of classes referenced by visited class files */ public Set<String> getDependencies() diff --git a/src/main/java/org/apache/maven/shared/dependency/analyzer/asm/ResultCollector.java b/src/main/java/org/apache/maven/shared/dependency/analyzer/asm/ResultCollector.java index 187c63e..5dce9a2 100644 --- a/src/main/java/org/apache/maven/shared/dependency/analyzer/asm/ResultCollector.java +++ b/src/main/java/org/apache/maven/shared/dependency/analyzer/asm/ResultCollector.java @@ -25,6 +25,8 @@ import java.util.HashSet; import java.util.Set; /** + * <p>ResultCollector class.</p> + * * @author Kristian Rosenvold */ public class ResultCollector @@ -32,11 +34,21 @@ public class ResultCollector private final Set<String> classes = new HashSet<String>(); + /** + * <p>getDependencies.</p> + * + * @return a {@link java.util.Set} object. + */ public Set<String> getDependencies() { return classes; } + /** + * <p>addName.</p> + * + * @param name a {@link java.lang.String} object. + */ public void addName( String name ) { if ( name == null ) @@ -77,6 +89,11 @@ public class ResultCollector } } + /** + * <p>add.</p> + * + * @param name a {@link java.lang.String} object. + */ public void add( String name ) { classes.add( name ); diff --git a/src/site/site.xml b/src/site/site.xml index a18a2a6..45215f4 100644 --- a/src/site/site.xml +++ b/src/site/site.xml @@ -27,7 +27,7 @@ under the License. <item name="Source Xref" href="xref/index.html"/> <!--item name="FAQ" href="faq.html"/--> <!-- According to https://issues.apache.org/jira/browse/MNGSITE-152 --> - <item name="License" href="http://www.apache.org/licenses/"/> + <item name="License" href="https://www.apache.org/licenses/"/> <item name="Download" href="download.html"/> </menu>
