Package org.eclipse.persistence.internal.codegen

Class MethodDefinition

java.lang.Object

org.eclipse.persistence.internal.codegen.CodeDefinition

org.eclipse.persistence.internal.codegen.MethodDefinition

Direct Known Subclasses:

NonreflectiveMethodDefinition, ReflectiveMethodDefinition

public abstract class MethodDefinition
extends CodeDefinition

INTERNAL:

Purpose: Model a method for code generation purposes.

Since:

TopLink 3.0

Author:

James Sutherland

Field Summary

Fields

Modifier and Type	Field	Description
protected java.util.Vector	argumentNames
protected java.util.Vector	exceptions
protected boolean	isAbstract
protected boolean	isConstructor
protected java.util.Vector	lines
protected java.lang.String	returnType
protected java.lang.StringBuffer	storedBuffer

Fields inherited from class org.eclipse.persistence.internal.codegen.CodeDefinition

accessLevel, comment, JAVA_LANG_PACKAGE_NAME, JAVA_UTIL_PACKAGE_NAME, name, TOPLINK_INDIRECTION_PACKAGE_NAME

Constructor Summary

Constructors

Constructor	Description
MethodDefinition()

Method Summary

Modifier and Type	Method	Description
void	addException(java.lang.String exceptionTypeName)
void	addLine(java.lang.String line)
void	addToBuffer(java.lang.String partOfLine)	This method can be used to store a string that will be prepended to the very next line of code entered
protected void	adjustTypeNames(java.util.Map typeNameMap)
java.util.Iterator	argumentNames()
int	argumentNamesSize()
protected abstract boolean	argumentsEqual(MethodDefinition methodDefinition)
boolean	equals(java.lang.Object object)
protected boolean	exceptionsEqual(MethodDefinition methodDefinition)
java.lang.String	getArgumentName(int index)
protected java.util.Vector	getArgumentNames()
protected abstract java.util.Vector	getArgumentTypeNames()
protected abstract java.util.Vector	getArgumentTypes()
protected java.util.Vector	getExceptions()
java.util.Vector	getLines()
java.lang.String	getReturnType()
int	hashCode()
boolean	isAbstract()
boolean	isConstructor()
protected void	putTypeNamesInMap(java.util.Map typeNameMap)	Used for calculating imports.
protected void	replaceException(java.lang.String oldExceptionName, java.lang.String newExceptionName)
protected void	replaceLine(java.lang.String oldLine, java.lang.String newLine)
void	setIsAbstract(boolean isAbstract)
void	setIsConstructor(boolean isConstructor)
void	setReturnType(java.lang.String returnType)
protected abstract void	writeArguments(CodeGenerator generator)
void	writeBody(CodeGenerator generator)	Write the code out to the generator's stream.
protected void	writeThrowsClause(CodeGenerator generator)

Methods inherited from class org.eclipse.persistence.internal.codegen.CodeDefinition

adjustTypeName, getAccessLevel, getComment, getName, parseForTypeNames, putTypeNameInMap, setAccessLevel, setComment, setName, toString, write

Methods inherited from class java.lang.Object

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

Field Detail

isAbstract

protected boolean isAbstract

isConstructor

protected boolean isConstructor

returnType

protected java.lang.String returnType

argumentNames

protected java.util.Vector argumentNames

lines

protected java.util.Vector lines

exceptions

protected java.util.Vector exceptions

storedBuffer

protected java.lang.StringBuffer storedBuffer

Constructor Detail

MethodDefinition

public MethodDefinition()

Method Detail

addException

public void addException(java.lang.String exceptionTypeName)

addLine

public void addLine(java.lang.String line)

addToBuffer

public void addToBuffer(java.lang.String partOfLine)

This method can be used to store a string that will be prepended to the very next line of code entered

adjustTypeNames

protected void adjustTypeNames(java.util.Map typeNameMap)

argumentsEqual

protected abstract boolean argumentsEqual(MethodDefinition methodDefinition)

equals

public boolean equals(java.lang.Object object)

Overrides:

equals in class java.lang.Object

exceptionsEqual

protected boolean exceptionsEqual(MethodDefinition methodDefinition)

getArgumentNames

protected java.util.Vector getArgumentNames()

getArgumentName

public java.lang.String getArgumentName(int index)

argumentNames

public java.util.Iterator argumentNames()

argumentNamesSize

public int argumentNamesSize()

getArgumentTypeNames

protected abstract java.util.Vector getArgumentTypeNames()

getArgumentTypes

protected abstract java.util.Vector getArgumentTypes()

getLines

public java.util.Vector getLines()

getExceptions

protected java.util.Vector getExceptions()

getReturnType

public java.lang.String getReturnType()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

isAbstract

public boolean isAbstract()

isConstructor

public boolean isConstructor()

putTypeNamesInMap

protected void putTypeNamesInMap(java.util.Map typeNameMap)

Used for calculating imports. @see org.eclipse.persistence.internal.codegen.ClassDefinition#calculateImports()

replaceException

protected void replaceException(java.lang.String oldExceptionName,
                                java.lang.String newExceptionName)

replaceLine

protected void replaceLine(java.lang.String oldLine,
                           java.lang.String newLine)

setIsAbstract

public void setIsAbstract(boolean isAbstract)

setIsConstructor

public void setIsConstructor(boolean isConstructor)

setReturnType

public void setReturnType(java.lang.String returnType)

writeBody

public void writeBody(CodeGenerator generator)

Write the code out to the generator's stream.

Specified by:

writeBody in class CodeDefinition

writeArguments

protected abstract void writeArguments(CodeGenerator generator)

writeThrowsClause

protected void writeThrowsClause(CodeGenerator generator)