Skip to content
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

[3.0] Memory improvements #366

Merged
merged 4 commits into from
May 13, 2024
Merged

[3.0] Memory improvements #366

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2db03f2
Reduce allocations when creating immutable array-backed lists
Ladicek Jun 22, 2023
0375661
replace lists with arrays in Index
Ladicek Mar 27, 2024
8110aa5
move seldom used fields of MethodInternal to a separate class
Ladicek Mar 27, 2024
1b1fecb
move seldom used fields of ClassInfo to a separate class
Ladicek Mar 28, 2024
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
105 changes: 51 additions & 54 deletions core/src/main/java/org/jboss/jandex/AnnotationInstance.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@

/**
* An annotation instance represents a specific usage of an annotation on a
* target. It contains a set of values, as well as a reference to the target
* target. It contains a set of members, as well as a reference to the target
* itself (e.g. class, field, method, etc).
*
* <p>
Expand Down Expand Up @@ -131,25 +131,25 @@ public static AnnotationInstanceBuilder builder(DotName annotationType, boolean
}

/**
* Construct a new mock annotation instance. The passed values array will be defensively copied.
* Construct a new mock annotation instance. The passed {@code values} array will be defensively copied.
* It is assumed that the annotation is {@link #runtimeVisible()}.
*
* @param name the name of the annotation instance
* @param target the thing the annotation is declared on
* @param values the values of this annotation instance
* @param values the members of this annotation instance
* @return the new mock Annotation Instance
*/
public static AnnotationInstance create(DotName name, AnnotationTarget target, AnnotationValue[] values) {
return create(name, true, target, values);
}

/**
* Construct a new mock annotation instance. The passed values array will be defensively copied.
* Construct a new mock annotation instance. The passed {@code values} array will be defensively copied.
*
* @param name the name of the annotation instance
* @param visible whether the annotation is visible at runtime via the reflection API
* @param target the thing the annotation is declared on
* @param values the values of this annotation instance
* @param values the members of this annotation instance
* @return the new mock Annotation Instance
*/
public static AnnotationInstance create(DotName name, boolean visible, AnnotationTarget target,
Expand All @@ -173,25 +173,25 @@ public int compare(AnnotationValue o1, AnnotationValue o2) {
}

/**
* Construct a new mock annotation instance. The passed values list will be defensively copied.
* Construct a new mock annotation instance. The passed {@code values} list will be defensively copied.
* It is assumed that the annotation is {@link #runtimeVisible()}.
*
* @param name the name of the annotation instance
* @param target the thing the annotation is declared on
* @param values the values of this annotation instance
* @param values the members of this annotation instance
* @return the new mock Annotation Instance
*/
public static AnnotationInstance create(DotName name, AnnotationTarget target, List<AnnotationValue> values) {
return create(name, true, target, values);
}

/**
* Construct a new mock annotation instance. The passed values list will be defensively copied.
* Construct a new mock annotation instance. The passed {@code values} list will be defensively copied.
*
* @param name the name of the annotation instance
* @param visible whether the annotation is visible at runtime via the reflection API
* @param target the thing the annotation is declared on
* @param values the values of this annotation instance
* @param values the members of this annotation instance
* @return the new mock Annotation Instance
*/
public static AnnotationInstance create(DotName name, boolean visible, AnnotationTarget target,
Expand Down Expand Up @@ -222,10 +222,10 @@ public DotName name() {
}

/**
* The Java element that this annotation was declared on. This can be
* a class, a field, a method, or a method parameter. In addition it may
* be null if this instance is a nested annotation, in which case there is
* no target.
* The program element that this annotation was declared on. This can be
* a class, a field, a method, a method parameter, or a type in case of
* type annotations. In addition, it may be {@code null} if this instance
* is a nested annotation, in which case there is no target.
*
* @return the target this annotation instance refers to
*/
Expand All @@ -234,13 +234,13 @@ public AnnotationTarget target() {
}

/**
* Returns a value that corresponds with the specified parameter name.
* If the parameter was not specified by this instance then null is
* returned. Note that this also applies to a defaulted parameter,
* which is not recorded in the target class.
* Returns the member of this annotation that has the specified name.
* If the member was not specified by this instance, {@code null} is
* returned. Note that this also applies to a defaulted member,
* whose value is not recorded in the target class file.
*
* @param name the parameter name
* @return the value of the specified parameter, or null if not provided
* @param name the name of the annotation member
* @return the annotation member with specified name, or {@code null}
*/
public AnnotationValue value(final String name) {
int result = Arrays.binarySearch(values, name, new Comparator<Object>() {
Expand All @@ -252,34 +252,32 @@ public int compare(Object o1, Object o2) {
}

/**
* Returns the value that is associated with the special default "value"
* parameter.
* Returns the member that has the special default name {@code value}.
*
* @return the "value" value
* @return the {@code value} member
*/
public AnnotationValue value() {
return value("value");
}

/**
* Returns a value that corresponds with the specified parameter name,
* Returns the member of this annotation that has the specified name,
* accounting for its default value. Since an annotation's defaults are
* only stored on the annotation's defining class, and not usages of the
* annotation, an index containing the Annotation class must be provided
* annotation, an index containing the annotation class must be provided
* as a parameter. If the index does not contain the defining annotation
* class, then an <code>IllegalArgumentException</code> will be thrown to
* class, then an {@code IllegalArgumentException} will be thrown to
* prevent non-deterministic results.
*
* <p>
* If the parameter was not specified by this instance, then the
* annotation's <code>ClassInfo</code> is checked for a default value.
* If there is a default, that value is returned. Otherwise null is
* returned.
* If the member was not specified by this annotation instance, then the
* annotation's {@code ClassInfo} is checked for a default value. If there
* is a default, that value is returned. Otherwise {@code null} is returned.
* </p>
*
* @param index the index containing the defining annotation class
* @param name the name of the annotation parameter
* @return the value of the specified parameter, the default, or null
* @param name the name of the annotation member
* @return the annotation member with specified name, or {@code null}
* @throws IllegalArgumentException if index does not contain the defining
* annotation class
* @since 2.1
Expand All @@ -300,23 +298,22 @@ public AnnotationValue valueWithDefault(IndexView index, String name) {
}

/**
* Returns the value that is associated with the special default "value"
* parameter, also accounting for a value default. Since an annotation's
* defaults are only stored on the annotation's defining class, and not
* usages of the annotation, an index containing the Annotation class must
* be provided as a parameter. If the index does not contain the defining
* annotation class, then an <code>IllegalArgumentException</code> will be
* thrown to prevent non-deterministic results.
* Returns the member of this annotation that has special name {@code value},
* accounting for its default value. Since an annotation's defaults are only
* stored on the annotation's defining class, and not usages of the annotation,
* an index containing the annotation class must be provided as a parameter.
* If the index does not contain the defining annotation class, then an
* {@code IllegalArgumentException} will be thrown to prevent non-deterministic
* results.
*
* <p>
* If the "value" parameter was not specified by this instance, then the
* annotation's <code>ClassInfo</code> is checked for a default value.
* If there is a default, that value is returned. Otherwise null is
* returned.
* If the {@code value} member was not specified by this instance, then the
* annotation's {@code ClassInfo} is checked for a default value. If there
* is a default, that value is returned. Otherwise {@code null} is returned.
* </p>
*
* @param index the index containing the defining annotation class
* @return the "value" value, or its default, or null
* @return the {@code value} annotation member, or {@code null}
* @throws IllegalArgumentException if index does not contain the defining
* annotation class
* @since 2.1
Expand All @@ -326,19 +323,19 @@ public AnnotationValue valueWithDefault(IndexView index) {
}

/**
* Returns a list of all parameter values on this annotation instance,
* including default values id defined. Since an annotation's defaults are
* only stored on the annotation's defining class, and not usages of the
* annotation, an index containing the Annotation class must be provided as
* a parameter. If the index does not contain the defining annotation class,
* then an <code>IllegalArgumentException</code> will be thrown to prevent
* non-deterministic results.
* Returns a list of all members of this annotation instance, including default
* values if defined. Since an annotation's defaults are only stored on the
* annotation's defining class, and not usages of the annotation, an index
* containing the annotation class must be provided as a parameter. If the index
* does not contain the defining annotation class, then an
* {@code IllegalArgumentException} will be thrown to prevent non-deterministic
* results.
*
* <p>
* The order of this list is undefined.
* </p>
*
* @return the parameter values of this annotation
* @return immutable list of this annotation's members
* @throws IllegalArgumentException if index does not contain the defining
* annotation class
* @since 2.1
Expand All @@ -365,15 +362,15 @@ public List<AnnotationValue> valuesWithDefaults(IndexView index) {
}

/**
* Returns a list of all parameter values on this annotation instance.
* Returns an immutable list of all members of this annotation instance.
* While random access is allowed, the ordering algorithm
* of the list should not be relied upon. Although it will
* be consistent for the life of this instance.
*
* @return the parameter values of this annotation
* @return immutable list of this annotation's members
*/
public List<AnnotationValue> values() {
return Collections.unmodifiableList(Arrays.asList(values));
return new ImmutableArrayList<>(values);
}

AnnotationValue[] valueArray() {
Expand Down
Loading
Loading