Package de.hybris.bootstrap.codegenerator

Class MethodWriter

java.lang.Object

de.hybris.bootstrap.codegenerator.AbstractImportProvider

de.hybris.bootstrap.codegenerator.MethodWriter

All Implemented Interfaces:

CodeWriter

Direct Known Subclasses:

AbstractAttributeMethodWriter, AlternativeModelGetterWriter, AlternativeModelSetterWriter, AttributeMethodDelegate, ModelConstructorWriter, ModelGetterWriter, ModelSetterWriter

public class MethodWriter
extends AbstractImportProvider

Field Summary

Fields

Modifier and Type	Field	Description
static int	ABSTRACT
static int	FINAL
static int	STATIC
static int	SYNCHRONIZED

Constructor Summary

Constructors

Constructor	Description
MethodWriter(Visibility visibility, java.lang.String returnType, java.lang.String name)
MethodWriter(java.lang.String name)
MethodWriter(java.lang.String returnType, java.lang.String name)

Method Summary

Modifier and Type	Method	Description
void	addAnnotation(java.lang.String anno)
void	addComment(java.lang.String comment)	Adds to the method a single comment line above the java doc for additional comments for the developer.
void	addDeprecatedAnnotation(java.lang.String deprecatedSince)
void	addParameter(java.lang.String type, java.lang.String name)
void	addThrownException(java.lang.String exceptionType)
protected java.lang.String	analyzeAndStripReturnType(java.lang.String original)
protected java.lang.String	assembleSignature()
protected java.lang.String	assembleThrowsClause()
static java.util.Set<java.lang.String>	extractClassNames(java.lang.String expression)
java.util.Set<java.lang.String>	getAnnotations()
CodeWriter	getContent()
java.lang.String	getJavadoc()	Gets the javadoc for the method.
int	getModifiers()
java.lang.String	getName()
java.lang.String	getParameterType(java.lang.String name)
java.util.Set<java.lang.String>	getRequiredImports()
java.lang.String	getReturnType()
java.util.Map<java.lang.String,java.lang.String>	getSignature()
java.util.Set<java.lang.String>	getThrownExceptions()
Visibility	getVisibility()
boolean	isAbstract()
boolean	isConstructor()
static java.lang.String	modifiersToString(int modifiers)
void	setAbstract(boolean isAbstract)
void	setConstructor(boolean isConstructor)
void	setContent(CodeWriter content)
void	setContentPlain(java.lang.String plainText)
void	setJavadoc(java.lang.String javadoc)	Sets the javadoc for the method.
void	setModifiers(int modifiers)
void	setReturnType(java.lang.String returnType)
void	setVisibility(Visibility visibility)
static java.lang.String	stripPackageName(java.lang.String className)
void	write(JavaFile file)
protected void	writeContent(JavaFile file)
static void	writeTextToFile(JavaFile file, java.lang.String plainText)

Methods inherited from class de.hybris.bootstrap.codegenerator.AbstractImportProvider

addRequiredImport

Methods inherited from class java.lang.Object

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

Field Detail

FINAL

public static final int FINAL

See Also:

Constant Field Values

STATIC

public static final int STATIC

See Also:

Constant Field Values

SYNCHRONIZED

public static final int SYNCHRONIZED

See Also:

Constant Field Values

ABSTRACT

public static final int ABSTRACT

See Also:

Constant Field Values

Constructor Detail

MethodWriter

public MethodWriter(java.lang.String name)

MethodWriter

public MethodWriter(java.lang.String returnType,
                    java.lang.String name)

MethodWriter

public MethodWriter(Visibility visibility,
                    java.lang.String returnType,
                    java.lang.String name)

Method Detail

write

public void write(JavaFile file)

modifiersToString

public static java.lang.String modifiersToString(int modifiers)

writeContent

protected void writeContent(JavaFile file)

addParameter

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

getSignature

public java.util.Map<java.lang.String,java.lang.String> getSignature()

getParameterType

public java.lang.String getParameterType(java.lang.String name)

assembleSignature

protected java.lang.String assembleSignature()

assembleThrowsClause

protected java.lang.String assembleThrowsClause()

getVisibility

public Visibility getVisibility()

Returns:

the visibility

setVisibility

public void setVisibility(Visibility visibility)

Parameters:

visibility - the visibility to set

getName

public java.lang.String getName()

Returns:

the name

getContent

public CodeWriter getContent()

Returns:

the content

setContent

public void setContent(CodeWriter content)

Parameters:

content - the content to set

setContentPlain

public void setContentPlain(java.lang.String plainText)

writeTextToFile

public static void writeTextToFile(JavaFile file,
                                   java.lang.String plainText)

analyzeAndStripReturnType

protected java.lang.String analyzeAndStripReturnType(java.lang.String original)

extractClassNames

public static java.util.Set<java.lang.String> extractClassNames(java.lang.String expression)

stripPackageName

public static java.lang.String stripPackageName(java.lang.String className)

getReturnType

public java.lang.String getReturnType()

Returns:

the returnType

getRequiredImports

public java.util.Set<java.lang.String> getRequiredImports()

Overrides:

getRequiredImports in class AbstractImportProvider

setReturnType

public void setReturnType(java.lang.String returnType)

Parameters:

returnType - the returnType to set

isAbstract

public boolean isAbstract()

Returns:

the isAbstract

setAbstract

public void setAbstract(boolean isAbstract)

Parameters:

isAbstract - the isAbstract to set

addDeprecatedAnnotation

public void addDeprecatedAnnotation(java.lang.String deprecatedSince)

addAnnotation

public void addAnnotation(java.lang.String anno)

getAnnotations

public java.util.Set<java.lang.String> getAnnotations()

Returns:

the annotations

getModifiers

public int getModifiers()

Returns:

the modifiers

setModifiers

public void setModifiers(int modifiers)

Parameters:

modifiers - the modifiers to set

addThrownException

public void addThrownException(java.lang.String exceptionType)

getThrownExceptions

public java.util.Set<java.lang.String> getThrownExceptions()

Returns:

the thrownExceptions

isConstructor

public boolean isConstructor()

Returns:

the isConstructor

setConstructor

public void setConstructor(boolean isConstructor)

Parameters:

isConstructor - the isConstructor to set

getJavadoc

public java.lang.String getJavadoc()

Gets the javadoc for the method.

Returns:

javadoc as normal string without the comment characters

setJavadoc

public void setJavadoc(java.lang.String javadoc)

Sets the javadoc for the method.

Parameters:

javadoc - the new javadoc string for the method. Note: Comment characters should be left out.

addComment

public void addComment(java.lang.String comment)

Adds to the method a single comment line above the java doc for additional comments for the developer. Please: Do not use \n or \r. Currently used for model constructors to show where the constructor was defined

Parameters:

comment - the comment