Executable.java 22.4 KB
Newer Older
1
/*
2
 * Copyright (c) 2012, 2013, Oracle and/or its affiliates. All rights reserved.
3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

package java.lang.reflect;

import java.lang.annotation.*;
import java.util.Map;
30
import java.util.Objects;
31
import sun.reflect.annotation.AnnotationParser;
32
import sun.reflect.annotation.AnnotationSupport;
33 34
import sun.reflect.annotation.TypeAnnotationParser;
import sun.reflect.annotation.TypeAnnotation;
35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53
import sun.reflect.generics.repository.ConstructorRepository;

/**
 * A shared superclass for the common functionality of {@link Method}
 * and {@link Constructor}.
 *
 * @since 1.8
 */
public abstract class Executable extends AccessibleObject
    implements Member, GenericDeclaration {
    /*
     * Only grant package-visibility to the constructor.
     */
    Executable() {}

    /**
     * Accessor method to allow code sharing
     */
    abstract byte[] getAnnotationBytes();
54
    abstract byte[] getTypeAnnotationBytes();
55 56 57 58 59 60 61 62 63 64 65 66 67 68 69

    /**
     * Does the Executable have generic information.
     */
    abstract boolean hasGenericInformation();

    abstract ConstructorRepository getGenericInfo();

    boolean equalParamTypes(Class<?>[] params1, Class<?>[] params2) {
        /* Avoid unnecessary cloning */
        if (params1.length == params2.length) {
            for (int i = 0; i < params1.length; i++) {
                if (params1[i] != params2[i])
                    return false;
            }
70
            return true;
71
        }
72
        return false;
73 74 75 76 77 78 79 80 81 82 83 84
    }

    Annotation[][] parseParameterAnnotations(byte[] parameterAnnotations) {
        return AnnotationParser.parseParameterAnnotations(
               parameterAnnotations,
               sun.misc.SharedSecrets.getJavaLangAccess().
               getConstantPool(getDeclaringClass()),
               getDeclaringClass());
    }

    void separateWithCommas(Class<?>[] types, StringBuilder sb) {
        for (int j = 0; j < types.length; j++) {
85
            sb.append(types[j].getTypeName());
86 87 88 89 90 91
            if (j < (types.length - 1))
                sb.append(",");
        }

    }

92
    void printModifiersIfNonzero(StringBuilder sb, int mask, boolean isDefault) {
93
        int mod = getModifiers() & mask;
94 95

        if (mod != 0 && !isDefault) {
96
            sb.append(Modifier.toString(mod)).append(' ');
97 98 99 100 101 102 103 104 105
        } else {
            int access_mod = mod & Modifier.ACCESS_MODIFIERS;
            if (access_mod != 0)
                sb.append(Modifier.toString(access_mod)).append(' ');
            if (isDefault)
                sb.append("default ");
            mod = (mod & ~Modifier.ACCESS_MODIFIERS);
            if (mod != 0)
                sb.append(Modifier.toString(mod)).append(' ');
106 107 108 109
        }
    }

    String sharedToString(int modifierMask,
110
                          boolean isDefault,
111 112 113 114 115
                          Class<?>[] parameterTypes,
                          Class<?>[] exceptionTypes) {
        try {
            StringBuilder sb = new StringBuilder();

116
            printModifiersIfNonzero(sb, modifierMask, isDefault);
117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137
            specificToStringHeader(sb);

            sb.append('(');
            separateWithCommas(parameterTypes, sb);
            sb.append(')');
            if (exceptionTypes.length > 0) {
                sb.append(" throws ");
                separateWithCommas(exceptionTypes, sb);
            }
            return sb.toString();
        } catch (Exception e) {
            return "<" + e + ">";
        }
    }

    /**
     * Generate toString header information specific to a method or
     * constructor.
     */
    abstract void specificToStringHeader(StringBuilder sb);

138
    String sharedToGenericString(int modifierMask, boolean isDefault) {
139 140 141
        try {
            StringBuilder sb = new StringBuilder();

142
            printModifiersIfNonzero(sb, modifierMask, isDefault);
143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163

            TypeVariable<?>[] typeparms = getTypeParameters();
            if (typeparms.length > 0) {
                boolean first = true;
                sb.append('<');
                for(TypeVariable<?> typeparm: typeparms) {
                    if (!first)
                        sb.append(',');
                    // Class objects can't occur here; no need to test
                    // and call Class.getName().
                    sb.append(typeparm.toString());
                    first = false;
                }
                sb.append("> ");
            }

            specificToGenericStringHeader(sb);

            sb.append('(');
            Type[] params = getGenericParameterTypes();
            for (int j = 0; j < params.length; j++) {
164
                String param = params[j].getTypeName();
165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196
                if (isVarArgs() && (j == params.length - 1)) // replace T[] with T...
                    param = param.replaceFirst("\\[\\]$", "...");
                sb.append(param);
                if (j < (params.length - 1))
                    sb.append(',');
            }
            sb.append(')');
            Type[] exceptions = getGenericExceptionTypes();
            if (exceptions.length > 0) {
                sb.append(" throws ");
                for (int k = 0; k < exceptions.length; k++) {
                    sb.append((exceptions[k] instanceof Class)?
                              ((Class)exceptions[k]).getName():
                              exceptions[k].toString());
                    if (k < (exceptions.length - 1))
                        sb.append(',');
                }
            }
            return sb.toString();
        } catch (Exception e) {
            return "<" + e + ">";
        }
    }

    /**
     * Generate toGenericString header information specific to a
     * method or constructor.
     */
    abstract void specificToGenericStringHeader(StringBuilder sb);

    /**
     * Returns the {@code Class} object representing the class or interface
197
     * that declares the executable represented by this object.
198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231
     */
    public abstract Class<?> getDeclaringClass();

    /**
     * Returns the name of the executable represented by this object.
     */
    public abstract String getName();

    /**
     * Returns the Java language {@linkplain Modifier modifiers} for
     * the executable represented by this object.
     */
    public abstract int getModifiers();

    /**
     * Returns an array of {@code TypeVariable} objects that represent the
     * type variables declared by the generic declaration represented by this
     * {@code GenericDeclaration} object, in declaration order.  Returns an
     * array of length 0 if the underlying generic declaration declares no type
     * variables.
     *
     * @return an array of {@code TypeVariable} objects that represent
     *     the type variables declared by this generic declaration
     * @throws GenericSignatureFormatError if the generic
     *     signature of this generic declaration does not conform to
     *     the format specified in
     *     <cite>The Java&trade; Virtual Machine Specification</cite>
     */
    public abstract TypeVariable<?>[] getTypeParameters();

    /**
     * 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
232
     * 0 if the underlying executable takes no parameters.
233
     *
234
     * @return the parameter types for the executable this object
235 236 237 238
     * represents
     */
    public abstract Class<?>[] getParameterTypes();

239
    /**
240 241
     * Returns the number of formal parameters (whether explicitly
     * declared or implicitly declared or neither) for the executable
242 243 244 245 246 247 248 249 250
     * represented by this object.
     *
     * @return The number of formal parameters for the executable this
     * object represents
     */
    public int getParameterCount() {
        throw new AbstractMethodError();
    }

251 252
    /**
     * Returns an array of {@code Type} objects that represent the formal
253 254 255
     * 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.
256 257 258 259 260 261 262 263 264
     *
     * <p>If a formal parameter type is a parameterized type,
     * the {@code Type} object returned for it must accurately reflect
     * the actual type parameters used in the source code.
     *
     * <p>If a formal parameter type is a type variable or a parameterized
     * type, it is created. Otherwise, it is resolved.
     *
     * @return an array of {@code Type}s that represent the formal
265
     *     parameter types of the underlying executable, in declaration order
266 267 268 269 270
     * @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
271
     *     types of the underlying executable refers to a non-existent type
272 273
     *     declaration
     * @throws MalformedParameterizedTypeException if any of
274
     *     the underlying executable's parameter types refer to a parameterized
275 276 277 278 279 280 281 282 283
     *     type that cannot be instantiated for any reason
     */
    public Type[] getGenericParameterTypes() {
        if (hasGenericInformation())
            return getGenericInfo().getParameterTypes();
        else
            return getParameterTypes();
    }

284 285 286 287 288 289
    /**
     * Returns an array of {@code Parameter} objects that represent
     * all the parameters to the underlying executable represented by
     * this object.  Returns an array of length 0 if the executable
     * has no parameters.
     *
290 291 292 293
     * The parameters of the underlying executable do not necessarily
     * have unique names, or names that are legal identifiers in the
     * Java programming language (JLS 3.8).
     *
294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341
     * @return an array of {@code Parameter} objects representing all
     * the parameters to the executable this object represents
     */
    public Parameter[] getParameters() {
        // TODO: This may eventually need to be guarded by security
        // mechanisms similar to those in Field, Method, etc.
        //
        // Need to copy the cached array to prevent users from messing
        // with it.  Since parameters are immutable, we can
        // shallow-copy.
        return privateGetParameters().clone();
    }

    private Parameter[] synthesizeAllParams() {
        final int realparams = getParameterCount();
        final Parameter[] out = new Parameter[realparams];
        for (int i = 0; i < realparams; i++)
            // TODO: is there a way to synthetically derive the
            // modifiers?  Probably not in the general case, since
            // we'd have no way of knowing about them, but there
            // may be specific cases.
            out[i] = new Parameter("arg" + i, 0, this, i);
        return out;
    }

    private Parameter[] privateGetParameters() {
        // Use tmp to avoid multiple writes to a volatile.
        Parameter[] tmp = parameters;

        if (tmp == null) {

            // Otherwise, go to the JVM to get them
            tmp = getParameters0();

            // If we get back nothing, then synthesize parameters
            if (tmp == null)
                tmp = synthesizeAllParams();

            parameters = tmp;
        }

        return tmp;
    }

    private transient volatile Parameter[] parameters;

    private native Parameter[] getParameters0();

342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363
    /**
     * Returns an array of {@code Class} objects that represent the
     * types of exceptions declared to be thrown by the underlying
     * executable represented by this object.  Returns an array of
     * length 0 if the executable declares no exceptions in its {@code
     * throws} clause.
     *
     * @return the exception types declared as being thrown by the
     * executable this object represents
     */
    public abstract Class<?>[] getExceptionTypes();

    /**
     * Returns an array of {@code Type} objects that represent the
     * exceptions declared to be thrown by this executable object.
     * Returns an array of length 0 if the underlying executable declares
     * no exceptions in its {@code throws} clause.
     *
     * <p>If an exception type is a type variable or a parameterized
     * type, it is created. Otherwise, it is resolved.
     *
     * @return an array of Types that represent the exception types
364
     *     thrown by the underlying executable
365 366 367 368
     * @throws GenericSignatureFormatError
     *     if the generic method signature does not conform to the format
     *     specified in
     *     <cite>The Java&trade; Virtual Machine Specification</cite>
369
     * @throws TypeNotPresentException if the underlying executable's
370 371
     *     {@code throws} clause refers to a non-existent type declaration
     * @throws MalformedParameterizedTypeException if
372
     *     the underlying executable's {@code throws} clause refers to a
373 374 375 376 377 378 379 380 381 382 383 384 385 386
     *     parameterized type that cannot be instantiated for any reason
     */
    public Type[] getGenericExceptionTypes() {
        Type[] result;
        if (hasGenericInformation() &&
            ((result = getGenericInfo().getExceptionTypes()).length > 0))
            return result;
        else
            return getExceptionTypes();
    }

    /**
     * Returns a string describing this {@code Executable}, including
     * any type parameters.
387 388
     * @return a string describing this {@code Executable}, including
     * any type parameters
389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409
     */
    public abstract String toGenericString();

    /**
     * Returns {@code true} if this executable was declared to take a
     * variable number of arguments; returns {@code false} otherwise.
     *
     * @return {@code true} if an only if this executable was declared
     * to take a variable number of arguments.
     */
    public boolean isVarArgs()  {
        return (getModifiers() & Modifier.VARARGS) != 0;
    }

    /**
     * Returns {@code true} if this executable is a synthetic
     * construct; returns {@code false} otherwise.
     *
     * @return true if and only if this executable is a synthetic
     * construct as defined by
     * <cite>The Java&trade; Language Specification</cite>.
410
     * @jls 13.1 The Form of a Binary
411 412 413 414 415 416 417 418 419
     */
    public boolean isSynthetic() {
        return Modifier.isSynthetic(getModifiers());
    }

    /**
     * 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
420
     * the underlying executable is parameterless.  If the executable has
421 422 423 424 425 426 427 428
     * 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
     * serializable.  The caller of this method is free to modify the
     * returned arrays; it will have no effect on the arrays returned
     * to other callers.
     *
     * @return an array of arrays that represent the annotations on the formal
429
     *    parameters, in declaration order, of the executable represented by this
430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452
     *    object
     */
    public abstract Annotation[][] getParameterAnnotations();

    Annotation[][] sharedGetParameterAnnotations(Class<?>[] parameterTypes,
                                                 byte[] parameterAnnotations) {
        int numParameters = parameterTypes.length;
        if (parameterAnnotations == null)
            return new Annotation[numParameters][0];

        Annotation[][] result = parseParameterAnnotations(parameterAnnotations);

        if (result.length != numParameters)
            handleParameterNumberMismatch(result.length, numParameters);
        return result;
    }

    abstract void handleParameterNumberMismatch(int resultLength, int numParameters);

    /**
     * {@inheritDoc}
     * @throws NullPointerException  {@inheritDoc}
     */
453
    public <T extends Annotation> T getAnnotation(Class<T> annotationClass) {
454
        Objects.requireNonNull(annotationClass);
455
        return annotationClass.cast(declaredAnnotations().get(annotationClass));
456 457 458 459 460 461 462
    }

    /**
     * {@inheritDoc}
     * @throws NullPointerException {@inheritDoc}
     * @since 1.8
     */
463 464
    @Override
    public <T extends Annotation> T[] getAnnotationsByType(Class<T> annotationClass) {
465 466 467
        Objects.requireNonNull(annotationClass);

        return AnnotationSupport.getMultipleAnnotations(declaredAnnotations(), annotationClass);
468 469 470 471 472 473
    }

    /**
     * {@inheritDoc}
     */
    public Annotation[] getDeclaredAnnotations()  {
474
        return AnnotationParser.toArray(declaredAnnotations());
475 476 477 478 479 480 481 482 483 484 485 486 487 488
    }

    private transient Map<Class<? extends Annotation>, Annotation> declaredAnnotations;

    private synchronized  Map<Class<? extends Annotation>, Annotation> declaredAnnotations() {
        if (declaredAnnotations == null) {
            declaredAnnotations = AnnotationParser.parseAnnotations(
                getAnnotationBytes(),
                sun.misc.SharedSecrets.getJavaLangAccess().
                getConstantPool(getDeclaringClass()),
                getDeclaringClass());
        }
        return declaredAnnotations;
    }
489

490
    /**
491 492
     * Returns an AnnotatedType object that represents the use of a type to
     * specify the return type of the method/constructor represented by this
493 494 495 496 497 498 499 500
     * Executable.
     *
     * If this Executable represents a constructor, the AnnotatedType object
     * represents the type of the constructed object.
     *
     * If this Executable represents a method, the AnnotatedType object
     * represents the use of a type to specify the return type of the method.
     *
501 502
     * @return an object representing the return type of this method
     * or constructor
503 504 505
     * @since 1.8
     */
    public abstract AnnotatedType getAnnotatedReturnType();
506 507 508 509 510 511 512 513 514 515 516

    /* Helper for subclasses of Executable.
     *
     * Returns an AnnotatedType object that represents the use of a type to
     * specify the return type of the method/constructor represented by this
     * Executable.
     *
     * @since 1.8
     */
    AnnotatedType getAnnotatedReturnType0(Type returnType) {
        return TypeAnnotationParser.buildAnnotatedType(getTypeAnnotationBytes(),
517 518 519 520 521 522
                sun.misc.SharedSecrets.getJavaLangAccess().
                        getConstantPool(getDeclaringClass()),
                this,
                getDeclaringClass(),
                returnType,
                TypeAnnotation.TypeAnnotationTarget.METHOD_RETURN);
523 524 525 526 527 528 529 530 531 532 533 534 535 536 537
    }

    /**
     * Returns an AnnotatedType object that represents the use of a type to
     * specify the receiver type of the method/constructor represented by this
     * Executable. The receiver type of a method/constructor is available only
     * if the method/constructor declares a formal parameter called 'this'.
     *
     * Returns null if this Executable represents a constructor or instance
     * method that either declares no formal parameter called 'this', or
     * declares a formal parameter called 'this' with no annotations on its
     * type.
     *
     * Returns null if this Executable represents a static method.
     *
538 539 540
     * @return an object representing the receiver type of the
     * method or constructor represented by this Executable
     *
541 542 543 544
     * @since 1.8
     */
    public AnnotatedType getAnnotatedReceiverType() {
        return TypeAnnotationParser.buildAnnotatedType(getTypeAnnotationBytes(),
545 546 547 548 549 550
                sun.misc.SharedSecrets.getJavaLangAccess().
                        getConstantPool(getDeclaringClass()),
                this,
                getDeclaringClass(),
                getDeclaringClass(),
                TypeAnnotation.TypeAnnotationTarget.METHOD_RECEIVER);
551 552 553 554 555 556 557 558 559 560 561 562
    }

    /**
     * Returns an array of AnnotatedType objects that represent the use of
     * types to specify formal parameter types of the method/constructor
     * represented by this Executable. The order of the objects in the array
     * corresponds to the order of the formal parameter types in the
     * declaration of the method/constructor.
     *
     * Returns an array of length 0 if the method/constructor declares no
     * parameters.
     *
563 564 565
     * @return an array of objects representing the types of the
     * formal parameters of this method or constructor
     *
566 567 568
     * @since 1.8
     */
    public AnnotatedType[] getAnnotatedParameterTypes() {
569 570 571 572 573 574 575
        return TypeAnnotationParser.buildAnnotatedTypes(getTypeAnnotationBytes(),
                sun.misc.SharedSecrets.getJavaLangAccess().
                        getConstantPool(getDeclaringClass()),
                this,
                getDeclaringClass(),
                getParameterTypes(),
                TypeAnnotation.TypeAnnotationTarget.METHOD_FORMAL_PARAMETER);
576 577 578 579 580 581 582 583 584 585 586 587
    }

    /**
     * Returns an array of AnnotatedType objects that represent the use of
     * types to specify the declared exceptions of the method/constructor
     * represented by this Executable. The order of the objects in the array
     * corresponds to the order of the exception types in the declaration of
     * the method/constructor.
     *
     * Returns an array of length 0 if the method/constructor declares no
     * exceptions.
     *
588 589 590
     * @return an array of objects representing the declared
     * exceptions of this method or constructor
     *
591 592 593 594
     * @since 1.8
     */
    public AnnotatedType[] getAnnotatedExceptionTypes() {
        return TypeAnnotationParser.buildAnnotatedTypes(getTypeAnnotationBytes(),
595 596 597 598 599 600
                sun.misc.SharedSecrets.getJavaLangAccess().
                        getConstantPool(getDeclaringClass()),
                this,
                getDeclaringClass(),
                getGenericExceptionTypes(),
                TypeAnnotation.TypeAnnotationTarget.THROWS);
601 602
    }

603
}