You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@groovy.apache.org by pa...@apache.org on 2022/04/19 07:46:51 UTC
[groovy] 01/02: minor refactor: fix groovy-groovydoc style warnings
This is an automated email from the ASF dual-hosted git repository.
paulk pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/groovy.git
commit 978cc4e224bbf5d9adf7b65bb1e9f20d56b60dcb
Author: Paul King <pa...@asert.com.au>
AuthorDate: Tue Apr 19 17:13:40 2022 +1000
minor refactor: fix groovy-groovydoc style warnings
---
.../java/org/codehaus/groovy/groovydoc/GroovyDoc.java | 2 +-
.../groovy/tools/groovydoc/ArrayClassDocWrapper.java | 3 ++-
.../tools/groovydoc/ExternalGroovyClassDoc.java | 3 ++-
.../groovy/tools/groovydoc/MockOutputTool.java | 10 +++++-----
.../groovy/tools/groovydoc/SimpleGroovyDoc.java | 8 ++------
.../groovydoc/SimpleGroovyExecutableMemberDoc.java | 6 +++---
.../groovy/tools/groovydoc/SimpleGroovyRootDoc.java | 19 +++++++++----------
7 files changed, 24 insertions(+), 27 deletions(-)
diff --git a/subprojects/groovy-groovydoc/src/main/java/org/codehaus/groovy/groovydoc/GroovyDoc.java b/subprojects/groovy-groovydoc/src/main/java/org/codehaus/groovy/groovydoc/GroovyDoc.java
index 7bffe8cfd9..fedfc83d6e 100644
--- a/subprojects/groovy-groovydoc/src/main/java/org/codehaus/groovy/groovydoc/GroovyDoc.java
+++ b/subprojects/groovy-groovydoc/src/main/java/org/codehaus/groovy/groovydoc/GroovyDoc.java
@@ -18,7 +18,7 @@
*/
package org.codehaus.groovy.groovydoc;
-public interface GroovyDoc extends Comparable {
+public interface GroovyDoc extends Comparable<GroovyDoc> {
String commentText();
diff --git a/subprojects/groovy-groovydoc/src/main/java/org/codehaus/groovy/tools/groovydoc/ArrayClassDocWrapper.java b/subprojects/groovy-groovydoc/src/main/java/org/codehaus/groovy/tools/groovydoc/ArrayClassDocWrapper.java
index 5930ef3fac..c443c630fb 100644
--- a/subprojects/groovy-groovydoc/src/main/java/org/codehaus/groovy/tools/groovydoc/ArrayClassDocWrapper.java
+++ b/subprojects/groovy-groovydoc/src/main/java/org/codehaus/groovy/tools/groovydoc/ArrayClassDocWrapper.java
@@ -21,6 +21,7 @@ package org.codehaus.groovy.tools.groovydoc;
import org.codehaus.groovy.groovydoc.GroovyAnnotationRef;
import org.codehaus.groovy.groovydoc.GroovyClassDoc;
import org.codehaus.groovy.groovydoc.GroovyConstructorDoc;
+import org.codehaus.groovy.groovydoc.GroovyDoc;
import org.codehaus.groovy.groovydoc.GroovyFieldDoc;
import org.codehaus.groovy.groovydoc.GroovyMethodDoc;
import org.codehaus.groovy.groovydoc.GroovyPackageDoc;
@@ -349,7 +350,7 @@ public class ArrayClassDocWrapper implements GroovyClassDoc {
}
@Override
- public int compareTo(Object o) {
+ public int compareTo(GroovyDoc o) {
return delegate.compareTo(o);
}
diff --git a/subprojects/groovy-groovydoc/src/main/java/org/codehaus/groovy/tools/groovydoc/ExternalGroovyClassDoc.java b/subprojects/groovy-groovydoc/src/main/java/org/codehaus/groovy/tools/groovydoc/ExternalGroovyClassDoc.java
index e773fb59e4..f5c6ac8ad6 100644
--- a/subprojects/groovy-groovydoc/src/main/java/org/codehaus/groovy/tools/groovydoc/ExternalGroovyClassDoc.java
+++ b/subprojects/groovy-groovydoc/src/main/java/org/codehaus/groovy/tools/groovydoc/ExternalGroovyClassDoc.java
@@ -21,6 +21,7 @@ package org.codehaus.groovy.tools.groovydoc;
import org.codehaus.groovy.groovydoc.GroovyAnnotationRef;
import org.codehaus.groovy.groovydoc.GroovyClassDoc;
import org.codehaus.groovy.groovydoc.GroovyConstructorDoc;
+import org.codehaus.groovy.groovydoc.GroovyDoc;
import org.codehaus.groovy.groovydoc.GroovyFieldDoc;
import org.codehaus.groovy.groovydoc.GroovyMethodDoc;
import org.codehaus.groovy.groovydoc.GroovyPackageDoc;
@@ -379,7 +380,7 @@ public class ExternalGroovyClassDoc implements GroovyClassDoc {
}
@Override
- public int compareTo(Object o) {
+ public int compareTo(GroovyDoc o) {
return 0;
}
}
diff --git a/subprojects/groovy-groovydoc/src/main/java/org/codehaus/groovy/tools/groovydoc/MockOutputTool.java b/subprojects/groovy-groovydoc/src/main/java/org/codehaus/groovy/tools/groovydoc/MockOutputTool.java
index c71b3f4d7b..4ca48511fc 100644
--- a/subprojects/groovy-groovydoc/src/main/java/org/codehaus/groovy/tools/groovydoc/MockOutputTool.java
+++ b/subprojects/groovy-groovydoc/src/main/java/org/codehaus/groovy/tools/groovydoc/MockOutputTool.java
@@ -24,12 +24,12 @@ import java.util.Map;
import java.util.Set;
public class MockOutputTool implements OutputTool {
- Set outputAreas; // dirs
- Map output;
+ private Set<String> outputAreas; // dirs
+ private Map<String, String> output;
public MockOutputTool() {
- outputAreas = new LinkedHashSet();
- output = new LinkedHashMap();
+ outputAreas = new LinkedHashSet<>();
+ output = new LinkedHashMap<>();
}
@Override
@@ -47,7 +47,7 @@ public class MockOutputTool implements OutputTool {
}
public String getText(String fileName) {
- return (String) output.get(fileName);
+ return output.get(fileName);
}
@Override
diff --git a/subprojects/groovy-groovydoc/src/main/java/org/codehaus/groovy/tools/groovydoc/SimpleGroovyDoc.java b/subprojects/groovy-groovydoc/src/main/java/org/codehaus/groovy/tools/groovydoc/SimpleGroovyDoc.java
index c13595fe98..7031daba8f 100644
--- a/subprojects/groovy-groovydoc/src/main/java/org/codehaus/groovy/tools/groovydoc/SimpleGroovyDoc.java
+++ b/subprojects/groovy-groovydoc/src/main/java/org/codehaus/groovy/tools/groovydoc/SimpleGroovyDoc.java
@@ -201,12 +201,8 @@ public class SimpleGroovyDoc implements GroovyDoc/*, GroovyTokenTypes*/ {
// Methods from Comparable
@Override
- public int compareTo(Object that) {
- if (that instanceof GroovyDoc) {
- return name.compareTo(((GroovyDoc) that).name());
- } else {
- throw new ClassCastException(String.format("Cannot compare object of type %s.", that.getClass()));
- }
+ public int compareTo(GroovyDoc that) {
+ return name.compareTo((that).name());
}
// Methods from GroovyDoc
diff --git a/subprojects/groovy-groovydoc/src/main/java/org/codehaus/groovy/tools/groovydoc/SimpleGroovyExecutableMemberDoc.java b/subprojects/groovy-groovydoc/src/main/java/org/codehaus/groovy/tools/groovydoc/SimpleGroovyExecutableMemberDoc.java
index f157e8e60c..78a607481f 100644
--- a/subprojects/groovy-groovydoc/src/main/java/org/codehaus/groovy/tools/groovydoc/SimpleGroovyExecutableMemberDoc.java
+++ b/subprojects/groovy-groovydoc/src/main/java/org/codehaus/groovy/tools/groovydoc/SimpleGroovyExecutableMemberDoc.java
@@ -28,16 +28,16 @@ import java.util.List;
public class SimpleGroovyExecutableMemberDoc extends SimpleGroovyMemberDoc implements GroovyExecutableMemberDoc {
private static final GroovyParameter[] EMPTY_GROOVYPARAMETER_ARRAY = new GroovyParameter[0];
- List parameters;
+ List<GroovyParameter> parameters;
public SimpleGroovyExecutableMemberDoc(String name, GroovyClassDoc belongsToClass) {
super(name, belongsToClass);
- parameters = new ArrayList();
+ parameters = new ArrayList<>();
}
@Override
public GroovyParameter[] parameters() {
- return (GroovyParameter[]) parameters.toArray(EMPTY_GROOVYPARAMETER_ARRAY);
+ return parameters.toArray(EMPTY_GROOVYPARAMETER_ARRAY);
}
public void add(GroovyParameter parameter) {
diff --git a/subprojects/groovy-groovydoc/src/main/java/org/codehaus/groovy/tools/groovydoc/SimpleGroovyRootDoc.java b/subprojects/groovy-groovydoc/src/main/java/org/codehaus/groovy/tools/groovydoc/SimpleGroovyRootDoc.java
index e97524163c..7052cb19dd 100644
--- a/subprojects/groovy-groovydoc/src/main/java/org/codehaus/groovy/tools/groovydoc/SimpleGroovyRootDoc.java
+++ b/subprojects/groovy-groovydoc/src/main/java/org/codehaus/groovy/tools/groovydoc/SimpleGroovyRootDoc.java
@@ -32,7 +32,7 @@ import java.util.Objects;
import java.util.regex.Pattern;
public class SimpleGroovyRootDoc extends SimpleGroovyDoc implements GroovyRootDoc {
- private final static Pattern EQUIVALENT_PACKAGE_IMPORT = Pattern.compile("[^/]+$");
+ private static final Pattern EQUIVALENT_PACKAGE_IMPORT = Pattern.compile("[^/]+$");
private static final GroovyClassDoc[] EMPTY_GROOVYCLASSDOC_ARRAY = new GroovyClassDoc[0];
private static final GroovyPackageDoc[] EMPTY_GROOVYPACKAGEDOC_ARRAY = new GroovyPackageDoc[0];
@@ -41,16 +41,16 @@ public class SimpleGroovyRootDoc extends SimpleGroovyDoc implements GroovyRootDo
private final Map<String, GroovyClassDoc> classDocs;
private final Map<String, String> equivalentPackageImports;
private List<GroovyClassDoc> classDocValues = null;
- private final Map<String, GroovyClassDoc> cachedResolvedClasses = new HashMap<String, GroovyClassDoc>();
+ private final Map<String, GroovyClassDoc> cachedResolvedClasses = new HashMap<>();
private final ClassNamedCache classNamedCache;
private String description = "";
public SimpleGroovyRootDoc(String name) {
super(name);
- packageDocs = new LinkedHashMap<String, GroovyPackageDoc>();
- classDocs = new LinkedHashMap<String, GroovyClassDoc>();
- equivalentPackageImports = new HashMap<String, String>();
+ packageDocs = new LinkedHashMap<>();
+ classDocs = new LinkedHashMap<>();
+ equivalentPackageImports = new HashMap<>();
classNamedCache = new ClassNamedCache(classDocs);
}
@@ -82,7 +82,7 @@ public class SimpleGroovyRootDoc extends SimpleGroovyDoc implements GroovyRootDo
@Override
public GroovyClassDoc[] classes() {
if (classDocValues == null) {
- classDocValues = new ArrayList<GroovyClassDoc>(classDocs.values());
+ classDocValues = new ArrayList<>(classDocs.values());
Collections.sort(classDocValues);
}
return classDocValues.toArray(EMPTY_GROOVYCLASSDOC_ARRAY);
@@ -116,7 +116,7 @@ public class SimpleGroovyRootDoc extends SimpleGroovyDoc implements GroovyRootDo
@Override
public GroovyPackageDoc[] specifiedPackages() {
if (packageDocValues == null) {
- packageDocValues = new ArrayList<GroovyPackageDoc>(packageDocs.values());
+ packageDocValues = new ArrayList<>(packageDocs.values());
Collections.sort(packageDocValues);
}
return packageDocValues.toArray(EMPTY_GROOVYPACKAGEDOC_ARRAY);
@@ -124,7 +124,7 @@ public class SimpleGroovyRootDoc extends SimpleGroovyDoc implements GroovyRootDo
@Override
public Map<String, GroovyClassDoc> getVisibleClasses(List importedClassesAndPackages) {
- Map<String, GroovyClassDoc> visibleClasses = new LinkedHashMap<String, GroovyClassDoc>();
+ Map<String, GroovyClassDoc> visibleClasses = new LinkedHashMap<>();
for (Map.Entry<String, GroovyClassDoc> entry : classDocs.entrySet()) {
String fullClassName = entry.getKey();
String equivalentPackageImport = findEquivalentPackageImport(fullClassName);
@@ -208,8 +208,7 @@ public class SimpleGroovyRootDoc extends SimpleGroovyDoc implements GroovyRootDo
if (lastSlashIdx > 0) {
String shortKey = key.substring(lastSlashIdx + 1);
if (shortKey.equals(name) && (!hasPackage || key.startsWith(fullPathName))) {
- GroovyClassDoc value = entry.getValue();
- return value;
+ return entry.getValue();
}
}
}