Skip to content

8382397: Make lint category property declaration more straightforward #30776

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
liach wants to merge 1 commit into
base: master
Choose a base branch
from
Open

8382397: Make lint category property declaration more straightforward #30776

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
72 changes: 40 additions & 32 deletions src/jdk.compiler/share/classes/com/sun/tools/javac/code/Lint.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,14 +25,14 @@

package com.sun.tools.javac.code;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.EnumSet;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.SequencedMap;
import java.util.SequencedSet;
import java.util.Set;
import java.util.stream.Stream;

Expand Down Expand Up @@ -119,8 +119,6 @@ public Lint suppress(LintCategory... lc) {
private EnumSet<LintCategory> values;
private EnumSet<LintCategory> suppressedValues;

private static final Map<String, LintCategory> map = new LinkedHashMap<>(40);

@SuppressWarnings("this-escape")
protected Lint(Context context) {
this.context = context;
Expand Down Expand Up @@ -202,7 +200,7 @@ public enum LintCategory {
* <p>
* This category is not supported by {@code @SuppressWarnings}.
*/
CLASSFILE("classfile", false, false),
CLASSFILE("classfile", Property.NO_ANNOTATION_SUPPRESSION),

/**
* Warn about "dangling" documentation comments,
Expand All @@ -219,7 +217,7 @@ public enum LintCategory {
* Warn about items which are documented with an {@code @deprecated} JavaDoc
* comment, but which do not have {@code @Deprecated} annotation.
*/
DEP_ANN("dep-ann", true, true),
DEP_ANN("dep-ann", Property.ENABLED_BY_DEFAULT),

/**
* Warn about division by constant integer 0.
Expand Down Expand Up @@ -249,15 +247,15 @@ public enum LintCategory {
/**
* Warn about uses of @ValueBased classes where an identity class is expected.
*/
IDENTITY("identity", true, true, "synchronization"),
IDENTITY(List.of("identity", "synchronization"), Property.ENABLED_BY_DEFAULT),

/**
* Warn about use of incubating modules.
*
* <p>
* This category is not supported by {@code @SuppressWarnings}.
*/
INCUBATING("incubating", false, true),
INCUBATING("incubating", Property.NO_ANNOTATION_SUPPRESSION, Property.ENABLED_BY_DEFAULT),

/**
* Warn about compiler possible lossy conversions.
Expand All @@ -272,28 +270,28 @@ public enum LintCategory {
/**
* Warn about module system related issues.
*/
MODULE("module", true, true),
MODULE("module", Property.ENABLED_BY_DEFAULT),

/**
* Warn about issues regarding module opens.
*/
OPENS("opens", true, true),
OPENS("opens", Property.ENABLED_BY_DEFAULT),

/**
* Warn about issues relating to use of command line options.
*
* <p>
* This category is not supported by {@code @SuppressWarnings}.
*/
OPTIONS("options", false, false),
OPTIONS("options", Property.NO_ANNOTATION_SUPPRESSION),

/**
* Warn when any output file is written to more than once.
*
* <p>
* This category is not supported by {@code @SuppressWarnings}.
*/
OUTPUT_FILE_CLASH("output-file-clash", false, false),
OUTPUT_FILE_CLASH("output-file-clash", Property.NO_ANNOTATION_SUPPRESSION),

/**
* Warn about issues regarding method overloads.
Expand All @@ -311,15 +309,15 @@ public enum LintCategory {
* <p>
* This category is not supported by {@code @SuppressWarnings}.
*/
PATH("path", false, false),
PATH("path", Property.NO_ANNOTATION_SUPPRESSION),

/**
* Warn about issues regarding annotation processing.
*
* <p>
* This category is not supported by {@code @SuppressWarnings}.
*/
PROCESSING("processing", false, false),
PROCESSING("processing", Property.NO_ANNOTATION_SUPPRESSION),

/**
* Warn about unchecked operations on raw types.
Expand All @@ -329,7 +327,7 @@ public enum LintCategory {
/**
* Warn about use of deprecated-for-removal items.
*/
REMOVAL("removal", true, true),
REMOVAL("removal", Property.ENABLED_BY_DEFAULT),

/**
* Warn about use of automatic modules in the requires clauses.
Expand All @@ -339,7 +337,7 @@ public enum LintCategory {
/**
* Warn about automatic modules in requires transitive.
*/
REQUIRES_TRANSITIVE_AUTOMATIC("requires-transitive-automatic", true, true),
REQUIRES_TRANSITIVE_AUTOMATIC("requires-transitive-automatic", Property.ENABLED_BY_DEFAULT),

/**
* Warn about Serializable classes that do not provide a serial version ID.
Expand All @@ -354,7 +352,7 @@ public enum LintCategory {
/**
* Warn about unnecessary uses of the strictfp modifier
*/
STRICTFP("strictfp", true, true),
STRICTFP("strictfp", Property.ENABLED_BY_DEFAULT),

/**
* Warn about issues relating to use of text blocks
Expand Down Expand Up @@ -384,43 +382,53 @@ public enum LintCategory {
/**
* Warn about use of preview features.
*/
PREVIEW("preview", true, true),
PREVIEW("preview", Property.ENABLED_BY_DEFAULT),

/**
* Warn about use of restricted methods.
*/
RESTRICTED("restricted");

LintCategory(String option) {
this(option, true, false);
enum Property { NO_ANNOTATION_SUPPRESSION, ENABLED_BY_DEFAULT }

LintCategory(String option, Property... properties) {
this(List.of(option), properties);
}

LintCategory(String option, boolean annotationSuppression, boolean enabledByDefault, String... aliases) {
this.option = option;
this.annotationSuppression = annotationSuppression;
this.enabledByDefault = enabledByDefault;
ArrayList<String> optionList = new ArrayList<>(1 + aliases.length);
optionList.add(option);
Collections.addAll(optionList, aliases);
this.optionList = Collections.unmodifiableList(optionList);
this.optionList.forEach(ident -> map.put(ident, this));
LintCategory(List<String> options, Property... properties) {
this.option = options.getFirst();
this.optionList = options;
Set<Property> propertySet = properties.length == 0 ? Set.of() : EnumSet.copyOf(Arrays.asList(properties));
this.annotationSuppression = !propertySet.contains(Property.NO_ANNOTATION_SUPPRESSION);
this.enabledByDefault = propertySet.contains(Property.ENABLED_BY_DEFAULT);
}

private static final SequencedMap<String, LintCategory> lookup = createLookup();

private static SequencedMap<String, LintCategory> createLookup() {
var map = new LinkedHashMap<String, LintCategory>();
for (var category : values()) {
category.optionList.forEach(id -> map.put(id, category));
}
return Collections.unmodifiableSequencedMap(map);
}


/**
* Get the {@link LintCategory} having the given command line option.
*
* @param option lint category option string
* @return corresponding {@link LintCategory}, or empty if none exists
*/
public static Optional<LintCategory> get(String option) {
return Optional.ofNullable(map.get(option));
return Optional.ofNullable(lookup.get(option));
}

/**
* Get all lint category option strings and aliases.
*/
public static Set<String> options() {
return Collections.unmodifiableSet(map.keySet());
public static SequencedSet<String> options() {
return lookup.sequencedKeySet();
}

public static EnumSet<LintCategory> newEmptySet() {
Expand Down