oracle.jdeveloper.engine

Class MethodInfo

java.lang.Object

oracle.jdeveloper.engine.FieldInfo

oracle.jdeveloper.engine.MethodInfo

All Implemented Interfaces:

java.lang.Comparable, Copyable, JavaInfo

public class MethodInfo
extends FieldInfo
implements java.lang.Comparable

Field Summary

Fields

Modifier and Type	Field and Description
java.util.List	parameters List of ArrayLists holding type, name pairs for each parameter
java.util.Set	thrown List of types for each exception declared to be thrown
java.util.List<java.lang.String>	typeParameters List of Type Parameters (as String) defined in method signature

Fields inherited from class oracle.jdeveloper.engine.FieldInfo

accessorModifiers, declaringClassName, modifiers, name, type, typeSignature

Fields inherited from interface oracle.jdeveloper.engine.JavaInfo

DEFAULT_MODIFIERS, DUPLICATE_PARAM_NAME, DUPLICATE_THROW_CLAUSE, GENERIC_SETTINGS_ERROR, INVALID_DIMENSION, INVALID_IDENTIFIER, INVALID_IDENTIFIER_NULL, INVALID_MODIFIERS, INVALID_PARAM_IDENTIFIER, INVALID_PARAM_IDENTIFIER_NULL, INVALID_PARAM_TYPE_NULL, INVALID_THROW_TYPE_NULL, INVALID_TYPE_NULL, PARAM_TYPE_NOT_FOUND, PRIMITIVE_FIELD_TYPES, PRIMITIVE_METHOD_TYPES, THROW_TYPE_NOT_FOUND, TYPE_NOT_FOUND, VALID

Constructor Summary

Constructors

Constructor and Description
MethodInfo() Default Constructor -------------------------------------------------------------------------
MethodInfo(JavaMethod javaMethod) Initialize from JavaMethod -------------------------------------------------------------------------
MethodInfo(MethodInfo mi) Copy Constructor -------------------------------------------------------------------------
MethodInfo(SourceMethod srcMethod)
MethodInfo(java.lang.String returnType, java.lang.String name, int modifiers)

Method Summary

Modifier and Type	Method and Description
void	addException(java.lang.String exception)
void	addParameter(java.lang.String type, java.lang.String name)
int	compareTo(java.lang.Object o)
java.lang.Object	copyTo(java.lang.Object target) Copyable interface -------------------------------------------------------------------------
protected void	copyToImpl(MethodInfo copy)
SourceMethod	createSourceConstructor(SourceFile srcFile, boolean addDefaultImpl) Helper method for creating a new SourceMethod from a MethodInfo.
SourceMethod	createSourceConstructor(SourceFile srcFile, SourceBlock srcBlock) Helper method for creating a new SourceMethod from a MethodInfo.
SourceMethod	createSourceConstructor(SourceFile srcFile, java.lang.String stmt) Helper method for creating a new SourceMethod from a MethodInfo.
SourceMethod	createSourceConstructor(SourceFile srcFile, java.lang.String[] stmts) Helper method for creating a new SourceMethod from a MethodInfo.
SourceMethod	createSourceMethod(SourceFile srcFile, boolean addDefaultImpl) Helper method for creating a new SourceMethod from a MethodInfo.
SourceMethod	createSourceMethod(SourceFile srcFile, SourceBlock srcBlock) Helper method for creating a new SourceMethod from a MethodInfo.
SourceMethod	createSourceMethod(SourceFile srcFile, java.lang.String stmt) Helper method for creating a new SourceMethod from a MethodInfo.
SourceMethod	createSourceMethod(SourceFile srcFile, java.lang.String[] stmts) Helper method for creating a new SourceMethod from a MethodInfo.
boolean	equals(java.lang.Object o)
protected boolean	equalsImpl(MethodInfo methodInfo)
FieldInfo	getField()
java.util.Collection	getJavaMethodAnnotations()
boolean	isGetter()
boolean	isSetter()
void	removeException(java.lang.String exception)
java.lang.String	render()
java.lang.String	toString()
int	validate() Validate the settings of the MethodInfo.

Methods inherited from class oracle.jdeveloper.engine.FieldInfo

copyToImpl, createLocalVariable, createLocalVariable, createLocalVariableDeclaration, createLocalVariableDeclaration, createSourceFieldDecl, createSourceFieldDecl, equalsImpl, getJavaFieldAnnotations, getJavaFieldAnnotations, getName, hashCode, makeGetter, makeGetter, makeSetter, makeSetter, setJavaFieldAnnotations

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

parameters

public java.util.List parameters

List of ArrayLists holding type, name pairs for each parameter

thrown

public java.util.Set thrown

List of types for each exception declared to be thrown

typeParameters

public java.util.List<java.lang.String> typeParameters

List of Type Parameters (as String) defined in method signature

Constructor Detail

MethodInfo

public MethodInfo()

Default Constructor -------------------------------------------------------------------------

MethodInfo

public MethodInfo(java.lang.String returnType,
                  java.lang.String name,
                  int modifiers)

MethodInfo

public MethodInfo(JavaMethod javaMethod)

Initialize from JavaMethod -------------------------------------------------------------------------

MethodInfo

public MethodInfo(SourceMethod srcMethod)

MethodInfo

public MethodInfo(MethodInfo mi)

Copy Constructor -------------------------------------------------------------------------

Method Detail

copyTo

public java.lang.Object copyTo(java.lang.Object target)

Copyable interface -------------------------------------------------------------------------

Specified by:

copyTo in interface Copyable

Overrides:

copyTo in class FieldInfo

Parameters:

target - The target object to which the state of this object should be copied. If target is null, then the copyTo method will return a new instance of this class.

Returns:

The object to which the state of this object was copied. If the target was non-null, then the return value is the same as the target object that was passed in; otherwise, the return value is a new instance of this class.

copyToImpl

protected final void copyToImpl(MethodInfo copy)

isGetter

public boolean isGetter()

isSetter

public boolean isSetter()

getField

public FieldInfo getField()

getJavaMethodAnnotations

public java.util.Collection getJavaMethodAnnotations()

validate

public int validate()

Validate the settings of the MethodInfo.

Overrides:

validate in class FieldInfo

Returns:

A code indicating success or failure. -------------------------------------------------------------------------

addParameter

public void addParameter(java.lang.String type,
                         java.lang.String name)

addException

public void addException(java.lang.String exception)

removeException

public void removeException(java.lang.String exception)

render

public java.lang.String render()

Overrides:

render in class FieldInfo

compareTo

public int compareTo(java.lang.Object o)

Specified by:

compareTo in interface java.lang.Comparable

Overrides:

compareTo in class FieldInfo

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class FieldInfo

equalsImpl

protected final boolean equalsImpl(MethodInfo methodInfo)

toString

public java.lang.String toString()

Overrides:

toString in class FieldInfo

createSourceConstructor

public SourceMethod createSourceConstructor(SourceFile srcFile,
                                            boolean addDefaultImpl)

Helper method for creating a new SourceMethod from a MethodInfo. Note that the method is created in an orphaned state, and not added to the SourceClass. All necessary imports will be added to the source file. The last param determines the method body code to assign.

Parameters:

srcFile - the SourceFile containing the target (primary) class

addDefaultImpl - if true, adds a default method implementation

Returns:

new SourceMethod representing the specified MethodInfo

createSourceConstructor

public SourceMethod createSourceConstructor(SourceFile srcFile,
                                            java.lang.String stmt)

Helper method for creating a new SourceMethod from a MethodInfo. Note that the method is created in an orphaned state, and not added to the SourceClass. All necessary imports will be added to the source file. The last param determines the method body code to assign.

Parameters:

srcFile - the SourceFile containing the target (primary) class

stmt - String single line text statement to add to the method body

Returns:

new SourceMethod representing the specified MethodInfo

createSourceConstructor

public SourceMethod createSourceConstructor(SourceFile srcFile,
                                            java.lang.String[] stmts)

Helper method for creating a new SourceMethod from a MethodInfo. Note that the method is created in an orphaned state, and not added to the SourceClass. All necessary imports will be added to the source file. The last param determines the method body code to assign.

Parameters:

srcFile - the SourceFile containing the target (primary) class

stmts - String [] multiple text statements to add to the method body

Returns:

new SourceMethod representing the specified MethodInfo

createSourceConstructor

public SourceMethod createSourceConstructor(SourceFile srcFile,
                                            SourceBlock srcBlock)

Helper method for creating a new SourceMethod from a MethodInfo. Note that the method is created in an orphaned state, and not added to the SourceClass. All necessary imports will be added to the source file. The last param determines the method body code to assign.

Parameters:

srcFile - the SourceFile containing the target (primary) class

srcBlock - SourceBlock pre-build SourceBlock to assign as the method body

Returns:

new SourceMethod representing the specified MethodInfo

createSourceMethod

public SourceMethod createSourceMethod(SourceFile srcFile,
                                       boolean addDefaultImpl)

Helper method for creating a new SourceMethod from a MethodInfo. Note that the method is created in an orphaned state, and not added to the SourceClass. All necessary imports will be added to the source file. The last param determines the method body code to assign.

Parameters:

srcFile - the SourceFile containing the target (primary) class

addDefaultImpl - if true, adds a default method implementation

Returns:

new SourceMethod representing the specified MethodInfo

createSourceMethod

public SourceMethod createSourceMethod(SourceFile srcFile,
                                       java.lang.String stmt)

Helper method for creating a new SourceMethod from a MethodInfo. Note that the method is created in an orphaned state, and not added to the SourceClass. All necessary imports will be added to the source file. The last param determines the method body code to assign.

Parameters:

srcFile - the SourceFile containing the target (primary) class

stmt - String single line text statement to add to the method body

Returns:

new SourceMethod representing the specified MethodInfo

createSourceMethod

public SourceMethod createSourceMethod(SourceFile srcFile,
                                       java.lang.String[] stmts)

Helper method for creating a new SourceMethod from a MethodInfo. Note that the method is created in an orphaned state, and not added to the SourceClass. All necessary imports will be added to the source file. The last param determines the method body code to assign.

Parameters:

srcFile - the SourceFile containing the target (primary) class

stmts - String [] multiple text statements to add to the method body

Returns:

new SourceMethod representing the specified MethodInfo

createSourceMethod

public SourceMethod createSourceMethod(SourceFile srcFile,
                                       SourceBlock srcBlock)

Helper method for creating a new SourceMethod from a MethodInfo. Note that the method is created in an orphaned state, and not added to the SourceClass. All necessary imports will be added to the source file. The last param determines the method body code to assign.

Parameters:

srcFile - the SourceFile containing the target (primary) class

srcBlock - SourceBlock pre-build SourceBlock to assign as the method body

Returns:

new SourceMethod representing the specified MethodInfo