org.codehaus.janino

Class Java.FunctionDeclarator

java.lang.Object

org.codehaus.janino.Java.Located

org.codehaus.janino.Java.AbstractTypeBodyDeclaration

org.codehaus.janino.Java.FunctionDeclarator

All Implemented Interfaces:

Java.DocCommentable, Java.Locatable, Java.Scope, Java.TypeBodyDeclaration

Direct Known Subclasses:

Java.ConstructorDeclarator, Java.MethodDeclarator

Enclosing class:

Java

public abstract static class Java.FunctionDeclarator
extends Java.AbstractTypeBodyDeclaration
implements Java.DocCommentable

Abstract base class for Java.ConstructorDeclarator and Java.MethodDeclarator.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Java.FunctionDeclarator.FormalParameter

Field Summary

Fields

Modifier and Type	Field and Description
Java.FunctionDeclarator.FormalParameter[]	formalParameters
Map	localVariables
short	modifiers
String	name
List	optionalStatements
Java.Type[]	thrownExceptions
Java.Type	type

Fields inherited from class org.codehaus.janino.Java.AbstractTypeBodyDeclaration

statiC

Fields inherited from class org.codehaus.janino.Java.Located

NOWHERE

Constructor Summary

Constructors

Constructor and Description
Java.FunctionDeclarator(Location location, String optionalDocComment, short modifiers, Java.Type type, String name, Java.FunctionDeclarator.FormalParameter[] formalParameters, Java.Type[] thrownExceptions, List optionalStatements)

Method Summary

Methods

Modifier and Type	Method and Description
String	getDocComment() Returns the doc comment of the object or null.
Java.Scope	getEnclosingScope()
boolean	hasDeprecatedDocTag() Returns true if the object has a doc comment and the @deprecated tag appears in the doc comment.

Methods inherited from class org.codehaus.janino.Java.AbstractTypeBodyDeclaration

getDeclaringType, isStatic, setDeclaringType, setEnclosingScope

Methods inherited from class org.codehaus.janino.Java.Located

getLocation, throwCompileException

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.codehaus.janino.Java.TypeBodyDeclaration

accept

Methods inherited from interface org.codehaus.janino.Java.Locatable

getLocation, throwCompileException

Field Detail

modifiers

public final short modifiers

type

public final Java.Type type

name

public final String name

formalParameters

public final Java.FunctionDeclarator.FormalParameter[] formalParameters

thrownExceptions

public final Java.Type[] thrownExceptions

optionalStatements

public final List optionalStatements

localVariables

public Map localVariables

Constructor Detail

Java.FunctionDeclarator

public Java.FunctionDeclarator(Location location,
                       String optionalDocComment,
                       short modifiers,
                       Java.Type type,
                       String name,
                       Java.FunctionDeclarator.FormalParameter[] formalParameters,
                       Java.Type[] thrownExceptions,
                       List optionalStatements)

Method Detail

getEnclosingScope

public Java.Scope getEnclosingScope()

Specified by:

getEnclosingScope in interface Java.Scope

Overrides:

getEnclosingScope in class Java.AbstractTypeBodyDeclaration

getDocComment

public String getDocComment()

Description copied from interface: Java.DocCommentable

Returns the doc comment of the object or null.

Specified by:

getDocComment in interface Java.DocCommentable

hasDeprecatedDocTag

public boolean hasDeprecatedDocTag()

Description copied from interface: Java.DocCommentable

Returns true if the object has a doc comment and the @deprecated tag appears in the doc comment.

Specified by:

hasDeprecatedDocTag in interface Java.DocCommentable