JDK-7149626 : (reflect) Improve javadoc of java.lang.reflect.Executable
  • Type: Bug
  • Component: core-libs
  • Sub-Component: java.lang:reflect
  • Affected Version: 8
  • Priority: P4
  • Status: Closed
  • Resolution: Fixed
  • OS: generic
  • CPU: generic
  • Submitted: 2012-02-28
  • Updated: 2012-09-28
  • Resolved: 2012-05-17
The Version table provides details related to the release that this issue/RFE will be addressed.

Unresolved : Release in which this issue/RFE will be addressed.
Resolved: Release in which this issue/RFE has been resolved.
Fixed : Release in which this issue/RFE has been fixed. The release containing this fix may be available for download as an Early Access Release or a General Availability Release.

To download the current JDK release, click here.
JDK 8
8 b29Fixed
Related Reports
Relates :  
JDK-7007535 - (reflect) Please generalize Constructor and Method
Description
After the fix for 7007535 was pushed, feedback was received on various small improvements/corrections that could be made to the javadoc of java.lang.reflect.Executable.
Comments
SUGGESTED FIX # HG changeset patch # User darcy # Date 1330463687 28800 # Node ID b62922b5417021fff574cf5fffb0e5b40de668dd # Parent c0a5140c641c1eab31d29bf77cbedbcdb518ad5e 7149626: (reflect) Improve javadoc of java.lang.reflect.Executable Reviewed-by: mduigou --- a/src/share/classes/java/lang/reflect/Executable.java Tue Feb 28 17:00:28 2012 +0400 +++ b/src/share/classes/java/lang/reflect/Executable.java Tue Feb 28 13:14:47 2012 -0800 @@ -180,7 +180,7 @@ public abstract class Executable extends /** * Returns the {@code Class} object representing the class or interface - * that declares the method represented by this executable object. + * that declares the executable represented by this object. */ public abstract Class<?> getDeclaringClass(); @@ -215,18 +215,18 @@ public abstract class Executable extends * Returns an array of {@code Class} objects that represent the formal * parameter types, in declaration order, of the executable * represented by this object. Returns an array of length - * 0 if the underlying method takes no parameters. - * - * @return the parameter types for the method this object + * 0 if the underlying executable takes no parameters. + * + * @return the parameter types for the executable this object * represents */ public abstract Class<?>[] getParameterTypes(); /** * Returns an array of {@code Type} objects that represent the formal - * parameter types, in declaration order, of the method represented by - * this executable object. Returns an array of length 0 if the - * underlying method takes no parameters. + * parameter types, in declaration order, of the executable represented by + * this object. Returns an array of length 0 if the + * underlying executable takes no parameters. * * <p>If a formal parameter type is a parameterized type, * the {@code Type} object returned for it must accurately reflect @@ -236,16 +236,16 @@ public abstract class Executable extends * type, it is created. Otherwise, it is resolved. * * @return an array of {@code Type}s that represent the formal - * parameter types of the underlying method, in declaration order + * parameter types of the underlying executable, in declaration order * @throws GenericSignatureFormatError * if the generic method signature does not conform to the format * specified in * <cite>The Java&trade; Virtual Machine Specification</cite> * @throws TypeNotPresentException if any of the parameter - * types of the underlying method refers to a non-existent type + * types of the underlying executable refers to a non-existent type * declaration * @throws MalformedParameterizedTypeException if any of - * the underlying method's parameter types refer to a parameterized + * the underlying executable's parameter types refer to a parameterized * type that cannot be instantiated for any reason */ public Type[] getGenericParameterTypes() { @@ -277,15 +277,15 @@ public abstract class Executable extends * type, it is created. Otherwise, it is resolved. * * @return an array of Types that represent the exception types - * thrown by the underlying method + * thrown by the underlying executable * @throws GenericSignatureFormatError * if the generic method signature does not conform to the format * specified in * <cite>The Java&trade; Virtual Machine Specification</cite> - * @throws TypeNotPresentException if the underlying method's + * @throws TypeNotPresentException if the underlying executable's * {@code throws} clause refers to a non-existent type declaration * @throws MalformedParameterizedTypeException if - * the underlying method's {@code throws} clause refers to a + * the underlying executable's {@code throws} clause refers to a * parameterized type that cannot be instantiated for any reason */ public Type[] getGenericExceptionTypes() { @@ -330,7 +330,7 @@ public abstract class Executable extends * Returns an array of arrays that represent the annotations on * the formal parameters, in declaration order, of the executable * represented by this object. (Returns an array of length zero if - * the underlying method is parameterless. If the executable has + * the underlying executable is parameterless. If the executable has * one or more parameters, a nested array of length zero is * returned for each parameter with no annotations.) The * annotation objects contained in the returned arrays are @@ -339,7 +339,7 @@ public abstract class Executable extends * to other callers. * * @return an array of arrays that represent the annotations on the formal - * parameters, in declaration order, of the exectuable represented by this + * parameters, in declaration order, of the executable represented by this * object */ public abstract Annotation[][] getParameterAnnotations();
28-02-2012
PUBLIC COMMENTS See http://hg.openjdk.java.net/jdk8/tl/jdk/rev/b62922b54170
28-02-2012
EVALUATION A fine idea.
28-02-2012