• file
• revisions
• annotate
• diff
• comparison
• raw

src/share/classes/com/sun/javadoc/ExecutableMemberDoc.java@2eb010b6cb22 (annotated)

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

Thu, 31 Aug 2017 15:17:03 +0800

author

aoqi

date

Thu, 31 Aug 2017 15:17:03 +0800

changeset 2525

2eb010b6cb22

parent 1691

f10cffab99b4

parent 0

959103a6100f

permissions

-rw-r--r--

merge

aoqi@0	1	/*
aoqi@0	2	* Copyright (c) 1998, 2013, Oracle and/or its affiliates. All rights reserved.
aoqi@0	3	* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0	4	*
aoqi@0	5	* This code is free software; you can redistribute it and/or modify it
aoqi@0	6	* under the terms of the GNU General Public License version 2 only, as
aoqi@0	7	* published by the Free Software Foundation. Oracle designates this
aoqi@0	8	* particular file as subject to the "Classpath" exception as provided
aoqi@0	9	* by Oracle in the LICENSE file that accompanied this code.
aoqi@0	10	*
aoqi@0	11	* This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0	12	* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0	13	* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
aoqi@0	14	* version 2 for more details (a copy is included in the LICENSE file that
aoqi@0	15	* accompanied this code).
aoqi@0	16	*
aoqi@0	17	* You should have received a copy of the GNU General Public License version
aoqi@0	18	* 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0	19	* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0	20	*
aoqi@0	21	* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0	22	* or visit www.oracle.com if you need additional information or have any
aoqi@0	23	* questions.
aoqi@0	24	*/
aoqi@0	25
aoqi@0	26	package com.sun.javadoc;
aoqi@0	27
aoqi@0	28	/**
aoqi@0	29	* Represents a method or constructor of a java class.
aoqi@0	30	*
aoqi@0	31	* @since 1.2
aoqi@0	32	* @author Robert Field
aoqi@0	33	*/
aoqi@0	34	public interface ExecutableMemberDoc extends MemberDoc {
aoqi@0	35
aoqi@0	36	/**
aoqi@0	37	* Return exceptions this method or constructor throws.
aoqi@0	38	* If the type of the exception is a type variable, return the
aoqi@0	39	* <code>ClassDoc</code> of its erasure.
aoqi@0	40	*
aoqi@0	41	* <p> <i>The <code>thrownExceptions</code> method cannot
aoqi@0	42	* accommodate certain generic type constructs. The
aoqi@0	43	* <code>thrownExceptionTypes</code> method should be used
aoqi@0	44	* instead.</i>
aoqi@0	45	*
aoqi@0	46	* @return an array of ClassDoc[] representing the exceptions
aoqi@0	47	* thrown by this method.
aoqi@0	48	* @see #thrownExceptionTypes
aoqi@0	49	*/
aoqi@0	50	ClassDoc[] thrownExceptions();
aoqi@0	51
aoqi@0	52	/**
aoqi@0	53	* Return exceptions this method or constructor throws.
aoqi@0	54	*
aoqi@0	55	* @return an array representing the exceptions thrown by this method.
aoqi@0	56	* Each array element is either a <code>ClassDoc</code> or a
aoqi@0	57	* <code>TypeVariable</code>.
aoqi@0	58	* @since 1.5
aoqi@0	59	*/
aoqi@0	60	Type[] thrownExceptionTypes();
aoqi@0	61
aoqi@0	62	/**
aoqi@0	63	* Return true if this method is native
aoqi@0	64	*/
aoqi@0	65	boolean isNative();
aoqi@0	66
aoqi@0	67	/**
aoqi@0	68	* Return true if this method is synchronized
aoqi@0	69	*/
aoqi@0	70	boolean isSynchronized();
aoqi@0	71
aoqi@0	72	/**
aoqi@0	73	* Return true if this method was declared to take a variable number
aoqi@0	74	* of arguments.
aoqi@0	75	*
aoqi@0	76	* @since 1.5
aoqi@0	77	*/
aoqi@0	78	public boolean isVarArgs();
aoqi@0	79
aoqi@0	80	/**
aoqi@0	81	* Get argument information.
aoqi@0	82	*
aoqi@0	83	* @see Parameter
aoqi@0	84	*
aoqi@0	85	* @return an array of Parameter, one element per argument
aoqi@0	86	* in the order the arguments are present.
aoqi@0	87	*/
aoqi@0	88	Parameter[] parameters();
aoqi@0	89
aoqi@0	90	/**
aoqi@0	91	* Get the receiver type of this executable element.
aoqi@0	92	*
aoqi@0	93	* @return the receiver type of this executable element.
aoqi@0	94	* @since 1.8
aoqi@0	95	*/
aoqi@0	96	Type receiverType();
aoqi@0	97
aoqi@0	98	/**
aoqi@0	99	* Return the throws tags in this method.
aoqi@0	100	*
aoqi@0	101	* @return an array of ThrowTag containing all <code>&#64;exception</code>
aoqi@0	102	* and <code>&#64;throws</code> tags.
aoqi@0	103	*/
aoqi@0	104	ThrowsTag[] throwsTags();
aoqi@0	105
aoqi@0	106	/**
aoqi@0	107	* Return the param tags in this method, excluding the type
aoqi@0	108	* parameter tags.
aoqi@0	109	*
aoqi@0	110	* @return an array of ParamTag containing all <code>&#64;param</code> tags
aoqi@0	111	* corresponding to the parameters of this method.
aoqi@0	112	*/
aoqi@0	113	ParamTag[] paramTags();
aoqi@0	114
aoqi@0	115	/**
aoqi@0	116	* Return the type parameter tags in this method.
aoqi@0	117	*
aoqi@0	118	* @return an array of ParamTag containing all <code>&#64;param</code> tags
aoqi@0	119	* corresponding to the type parameters of this method.
aoqi@0	120	* @since 1.5
aoqi@0	121	*/
aoqi@0	122	ParamTag[] typeParamTags();
aoqi@0	123
aoqi@0	124	/**
aoqi@0	125	* Get the signature. It is the parameter list, type is qualified.
aoqi@0	126	* For instance, for a method <code>mymethod(String x, int y)</code>,
aoqi@0	127	* it will return <code>(java.lang.String,int)</code>.
aoqi@0	128	*/
aoqi@0	129	String signature();
aoqi@0	130
aoqi@0	131	/**
aoqi@0	132	* get flat signature. all types are not qualified.
aoqi@0	133	* return a String, which is the flat signiture of this member.
aoqi@0	134	* It is the parameter list, type is not qualified.
aoqi@0	135	* For instance, for a method <code>mymethod(String x, int y)</code>,
aoqi@0	136	* it will return <code>(String, int)</code>.
aoqi@0	137	*/
aoqi@0	138	String flatSignature();
aoqi@0	139
aoqi@0	140	/**
aoqi@0	141	* Return the formal type parameters of this method or constructor.
aoqi@0	142	* Return an empty array if this method or constructor is not generic.
aoqi@0	143	*
aoqi@0	144	* @return the formal type parameters of this method or constructor.
aoqi@0	145	* @since 1.5
aoqi@0	146	*/
aoqi@0	147	TypeVariable[] typeParameters();
aoqi@0	148	}