Skip to content

Commit

Permalink
Rename Whitelist class names in the javadoc of Allowlist classes
Browse files Browse the repository at this point in the history
Signed-off-by: Tianli Feng <ftianli@amazon.com>
  • Loading branch information
Tianli Feng committed Aug 3, 2022
1 parent 56e1b54 commit 6f77583
Show file tree
Hide file tree
Showing 5 changed files with 11 additions and 11 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,9 @@
* constructors, methods, and fields that can be used within a Painless script at both compile-time
* and run-time.
*
* A Allowlist consists of several pieces with {@link WhitelistClass}s as the top level. Each
* {@link WhitelistClass} will contain zero-to-many {@link WhitelistConstructor}s, {@link WhitelistMethod}s, and
* {@link WhitelistField}s which are what will be available with a Painless script. See each individual
* An Allowlist consists of several pieces with {@link AllowlistClass}s as the top level. Each
* {@link AllowlistClass} will contain zero-to-many {@link AllowlistConstructor}s, {@link AllowlistMethod}s, and
* {@link AllowlistField}s which are what will be available with a Painless script. See each individual
* allowlist object for more detail.
*/
public final class Allowlist extends Whitelist {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,13 +30,13 @@
*/
public final class AllowlistClass extends WhitelistClass {

/** The {@link List} of allowlisted ({@link WhitelistConstructor}s) available to this class. */
/** The {@link List} of allowlisted ({@link AllowlistConstructor}s) available to this class. */
public final List<AllowlistConstructor> allowlistConstructors;

/** The {@link List} of allowlisted ({@link WhitelistMethod}s) available to this class. */
/** The {@link List} of allowlisted ({@link AllowlistMethod}s) available to this class. */
public final List<AllowlistMethod> allowlistMethods;

/** The {@link List} of allowlisted ({@link WhitelistField}s) available to this class. */
/** The {@link List} of allowlisted ({@link AllowlistField}s) available to this class. */
public final List<AllowlistField> allowlistFields;

/** Standard constructor. All values must be not {@code null}. */
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
* Constructor represents the equivalent of a Java constructor available as a allowlisted class
* constructor within Painless. Constructors for Painless classes may be accessed exactly as
* constructors for Java classes are using the 'new' keyword. Painless classes may have multiple
* constructors as long as they comply with arity overloading described for {@link WhitelistClass}.
* constructors as long as they comply with arity overloading described for {@link AllowlistClass}.
*/
public final class AllowlistConstructor extends WhitelistConstructor {
/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,11 @@
import java.util.List;
import java.util.Map;

/** Loads and creates a {@link Whitelist} from one to many text files. */
/** Loads and creates a {@link Allowlist} from one to many text files. */
public final class AllowlistLoader {

/**
* Loads and creates a {@link Whitelist} from one to many text files using only the base annotation parsers.
* Loads and creates a {@link Allowlist} from one to many text files using only the base annotation parsers.
* See {@link #loadFromResourceFiles(Class, Map, String...)} for information on how to structure an allowlist
* text file.
*/
Expand All @@ -38,7 +38,7 @@ public static Allowlist loadFromResourceFiles(Class<?> resource, String... filep
}

/**
* Loads and creates a {@link Whitelist} from one to many text files. The file paths are passed in as an array of
* Loads and creates a {@link Allowlist} from one to many text files. The file paths are passed in as an array of
* {@link String}s with a single {@link Class} to be be used to load the resources where each {@link String}
* is the path of a single text file. The {@link Class}'s {@link ClassLoader} will be used to lookup the Java
* reflection objects for each individual {@link Class}, {@link Constructor}, {@link Method}, and {@link Field}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
* within Painless. Methods for Painless classes may be accessed exactly as methods for Java classes
* are using the '.' operator on an existing class variable/field. Painless classes may have multiple
* methods with the same name as long as they comply with arity overloading described in
* {@link WhitelistClass}.
* {@link AllowlistClass}.
*
* Classes may also have additional methods that are not part of the Java class the class represents -
* these are known as augmented methods. An augmented method can be added to a class as a part of any
Expand Down

0 comments on commit 6f77583

Please sign in to comment.