8310815: Clarify the name of the main class, services and provider classes in module descriptor

8314449: Clarify the name of the declaring class of StackTraceElement

Reviewed-by: alanb
This commit is contained in:
Mandy Chung 2023-08-18 17:10:39 +00:00
parent aecbb1b5c3
commit 50a2ce01f4
2 changed files with 21 additions and 22 deletions
src/java.base/share/classes/java/lang

@ -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
@ -137,8 +138,9 @@ public final class StackTraceElement implements java.io.Serializable {
* @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
@ -249,11 +251,9 @@ public final class StackTraceElement implements java.io.Serializable {
}
/**
* 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;
@ -332,7 +332,7 @@ public final class StackTraceElement implements java.io.Serializable {
* 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.
*

@ -847,26 +847,25 @@ public class ModuleDescriptor
}
/**
* 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,
@ -1446,8 +1445,8 @@ public class ModuleDescriptor
* <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;
@ -1510,7 +1509,7 @@ public class ModuleDescriptor
/**
* <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);