Skip to content

Commit

Permalink
8310815: Clarify the name of the main class, services and provider cl…
Browse files Browse the repository at this point in the history
…asses in module descriptor

8314449: Clarify the name of the declaring class of StackTraceElement

Reviewed-by: alanb
  • Loading branch information
Mandy Chung committed Aug 18, 2023
1 parent aecbb1b commit 50a2ce0
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 22 deletions.
20 changes: 10 additions & 10 deletions src/java.base/share/classes/java/lang/StackTraceElement.java
Original file line number Diff line number Diff line change
Expand Up @@ -102,8 +102,9 @@ public final class StackTraceElement implements java.io.Serializable {
* #getModuleVersion module version} of the stack trace element will
* be {@code null}.
*
* @param declaringClass the fully qualified name of the class containing
* the execution point represented by the stack trace element
* @param declaringClass the {@linkplain ClassLoader##binary-name binary name}
* of the class containing the execution point represented by
* the stack trace element
* @param methodName the name of the method containing the execution point
* represented by the stack trace element
* @param fileName the name of the file containing the execution point
Expand Down Expand Up @@ -137,8 +138,9 @@ public StackTraceElement(String declaringClass, String methodName,
* @param moduleVersion the module version if the class containing the
* execution point represented by the stack trace is in a named
* module that has a version; otherwise {@code null}
* @param declaringClass the fully qualified name of the class containing
* the execution point represented by the stack trace element
* @param declaringClass the {@linkplain ClassLoader##binary-name binary name}
* of the class containing the execution point represented by
* the stack trace element
* @param methodName the name of the method containing the execution point
* represented by the stack trace element
* @param fileName the name of the file containing the execution point
Expand Down Expand Up @@ -249,11 +251,9 @@ public String getClassLoaderName() {
}

/**
* Returns the fully qualified name of the class containing the
* execution point represented by this stack trace element.
*
* @return the fully qualified name of the {@code Class} containing
* the execution point represented by this stack trace element.
* {@return the {@linkplain ClassLoader##binary-name binary name}
* of the {@code Class} containing the execution point represented
* by this stack trace element}
*/
public String getClassName() {
return declaringClass;
Expand Down Expand Up @@ -332,7 +332,7 @@ public boolean isNativeMethod() {
* the name of the class loader. The second element "{@code foo@9.0}"
* is the module name and version. The third element is the method
* containing the execution point; "{@code com.foo.Main"}" is the
* fully-qualified class name and "{@code run}" is the name of the method.
* binary name and "{@code run}" is the name of the method.
* "{@code Main.java}" is the source file name and "{@code 101}" is
* the line number.
*
Expand Down
23 changes: 11 additions & 12 deletions src/java.base/share/classes/java/lang/module/ModuleDescriptor.java
Original file line number Diff line number Diff line change
Expand Up @@ -847,26 +847,25 @@ private Provides(String service, List<String> providers, boolean unused) {
}

/**
* Returns the fully qualified class name of the service type.
*
* @return The fully qualified class name of the service type
* {@return the {@linkplain ClassLoader##binary-name binary name} of the service type}
*/
public String service() { return service; }

/**
* Returns the list of the fully qualified class names of the providers
* or provider factories.
* Returns the list of the {@linkplain ClassLoader##binary-name binary names}
* of the providers or provider factories.
*
* @return A non-empty and unmodifiable list of the fully qualified class
* names of the providers or provider factories
* @return A non-empty and unmodifiable list of the {@linkplain ClassLoader##binary-name
* binary names} of the providers or provider factories
*/
public List<String> providers() { return providers; }

/**
* Compares this {@code Provides} to another.
*
* <p> Two {@code Provides} objects are compared by comparing the fully
* qualified class name of the service type lexicographically. Where the
* <p> Two {@code Provides} objects are compared by comparing the
* {@linkplain ClassLoader##binary-name binary name}
* of the service type lexicographically. Where the
* class names are equal then the list of the provider class names are
* compared by comparing the corresponding elements of both lists
* lexicographically and in sequence. Where the lists differ in size,
Expand Down Expand Up @@ -1446,8 +1445,8 @@ public Set<Opens> opens() {
* <p> If this module is an automatic module then the set of service
* dependences is empty. </p>
*
* @return A possibly-empty unmodifiable set of the fully qualified class
* names of the service types used
* @return A possibly-empty unmodifiable set of the {@linkplain ClassLoader##binary-name
* binary names} of the service types used
*/
public Set<String> uses() {
return uses;
Expand Down Expand Up @@ -1510,7 +1509,7 @@ public String toNameAndVersion() {
/**
* <p> Returns the module main class. </p>
*
* @return The fully qualified class name of the module's main class
* @return The {@linkplain ClassLoader##binary-name binary name} of the module's main class
*/
public Optional<String> mainClass() {
return Optional.ofNullable(mainClass);
Expand Down

1 comment on commit 50a2ce0

@openjdk-notifier
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.