Skip to content

Commit

Permalink
Add javadoc to note 2 classes Whitelist and WhitelistConstructor shou…
Browse files Browse the repository at this point in the history
…ld be final

Signed-off-by: Tianli Feng <ftianli@amazon.com>
  • Loading branch information
Tianli Feng committed Aug 3, 2022
1 parent 6f77583 commit 355b748
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -43,12 +43,12 @@
* 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
* An 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
* allowlist object for more detail.
*
* @deprecated As of 2.2, because supporting inclusive language, replaced by {@link Allowlist}
* @deprecated As of 2.2, because supporting inclusive language, replaced by {@link Allowlist}. The class was declared with final keyword.
*/
@Deprecated
public class Whitelist {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
* 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}.
*
* @deprecated As of 2.2, because supporting inclusive language, replaced by {@link AllowlistConstructor}
* @deprecated As of 2.2, because supporting inclusive language, replaced by {@link AllowlistConstructor}. The class was declared with final keyword.
*/
@Deprecated
public class WhitelistConstructor {
Expand All @@ -63,7 +63,7 @@ public class WhitelistConstructor {
public final Map<Class<?>, Object> painlessAnnotations;

/** Standard constructor. All values must be not {@code null}. */
WhitelistConstructor(String origin, List<String> canonicalTypeNameParameters, List<Object> painlessAnnotations) {
public WhitelistConstructor(String origin, List<String> canonicalTypeNameParameters, List<Object> painlessAnnotations) {
this.origin = Objects.requireNonNull(origin);
this.canonicalTypeNameParameters = Collections.unmodifiableList(Objects.requireNonNull(canonicalTypeNameParameters));

Expand Down

0 comments on commit 355b748

Please sign in to comment.