jdk8-mips64-public/langtools: src/share/classes/com/sun/javadoc/ExecutableMemberDoc.java@998b10c43157 (annotated)

src/share/classes/com/sun/javadoc/ExecutableMemberDoc.java@998b10c43157 (annotated)

src/share/classes/com/sun/javadoc/ExecutableMemberDoc.java

Tue, 24 Dec 2013 09:17:37 -0800

author: ksrini
date: Tue, 24 Dec 2013 09:17:37 -0800
changeset 2227: 998b10c43157
parent 1691: f10cffab99b4
child 2525: 2eb010b6cb22
permissions: -rw-r--r--

8029230: Update copyright year to match last edit in jdk8 langtools repository for 2013
Reviewed-by: ksrini
Contributed-by: steve.sides@oracle.com

 /*
  * Copyright (c) 1998, 2013, Oracle and/or its affiliates. All rights reserved.
  * 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 com.sun.javadoc;
 /**
  * Represents a method or constructor of a java class.
  *
  * @since 1.2
  * @author Robert Field
  */
 public interface ExecutableMemberDoc extends MemberDoc {
     /**
      * Return exceptions this method or constructor throws.
      * If the type of the exception is a type variable, return the
      * <code>ClassDoc</code> of its erasure.
      *
      * <p> <i>The <code>thrownExceptions</code> method cannot
      * accommodate certain generic type constructs.  The
      * <code>thrownExceptionTypes</code> method should be used
      * instead.</i>
      *
      * @return an array of ClassDoc[] representing the exceptions
      *         thrown by this method.
      * @see #thrownExceptionTypes
      */
     ClassDoc[] thrownExceptions();
     /**
      * Return exceptions this method or constructor throws.
      *
      * @return an array representing the exceptions thrown by this method.
      *         Each array element is either a <code>ClassDoc</code> or a
      *         <code>TypeVariable</code>.
      * @since 1.5
      */
     Type[] thrownExceptionTypes();
     /**
      * Return true if this method is native
      */
     boolean isNative();
     /**
      * Return true if this method is synchronized
      */
     boolean isSynchronized();
     /**
      * Return true if this method was declared to take a variable number
      * of arguments.
      *
      * @since 1.5
      */
     public boolean isVarArgs();
     /**
      * Get argument information.
      *
      * @see Parameter
      *
      * @return an array of Parameter, one element per argument
      * in the order the arguments are present.
      */
     Parameter[] parameters();
     /**
      * Get the receiver type of this executable element.
      *
      * @return the receiver type of this executable element.
      * @since 1.8
      */
     Type receiverType();
     /**
      * Return the throws tags in this method.
      *
      * @return an array of ThrowTag containing all <code>&#64;exception</code>
      * and <code>&#64;throws</code> tags.
      */
     ThrowsTag[] throwsTags();
     /**
      * Return the param tags in this method, excluding the type
      * parameter tags.
      *
      * @return an array of ParamTag containing all <code>&#64;param</code> tags
      * corresponding to the parameters of this method.
      */
     ParamTag[] paramTags();
     /**
      * Return the type parameter tags in this method.
      *
      * @return an array of ParamTag containing all <code>&#64;param</code> tags
      * corresponding to the type parameters of this method.
      * @since 1.5
      */
     ParamTag[] typeParamTags();
     /**
      * Get the signature. It is the parameter list, type is qualified.
      *      For instance, for a method <code>mymethod(String x, int y)</code>,
      *      it will return <code>(java.lang.String,int)</code>.
      */
     String signature();
     /**
      * get flat signature.  all types are not qualified.
      *      return a String, which is the flat signiture of this member.
      *      It is the parameter list, type is not qualified.
      *      For instance, for a method <code>mymethod(String x, int y)</code>,
      *      it will return <code>(String, int)</code>.
      */
     String flatSignature();
     /**
      * Return the formal type parameters of this method or constructor.
      * Return an empty array if this method or constructor is not generic.
      *
      * @return the formal type parameters of this method or constructor.
      * @since 1.5
      */
     TypeVariable[] typeParameters();
 }

Mercurial > jdk8-mips64-public > langtools / annotate

src/share/classes/com/sun/javadoc/ExecutableMemberDoc.java@998b10c43157 (annotated)

src/share/classes/com/sun/javadoc/ExecutableMemberDoc.java