Cantaloop CGimlet - API Documentation, Version: 0.2.0, Date: 2002-05-13 21:30 CEST

org.cantaloop.cgimlet.lang.java
Class JMethodTemplate

java.lang.Object
  |
  +--org.cantaloop.cgimlet.lang.java.AbstractTemplate
        |
        +--org.cantaloop.cgimlet.lang.java.JConstructorTemplate
              |
              +--org.cantaloop.cgimlet.lang.java.JMethodTemplate
All Implemented Interfaces:
ConstructorTemplate, MethodTemplate, Template

public class JMethodTemplate
extends JConstructorTemplate
implements MethodTemplate

Version:
0.2.0 ($Revision: 1.4 $)
Author:
David Leuschner, Stefan Heimann

Field Summary
protected  Type m_returnType
           
 
Fields inherited from class org.cantaloop.cgimlet.lang.java.JConstructorTemplate
m_body, m_helperMethods, m_params
 
Fields inherited from class org.cantaloop.cgimlet.lang.java.AbstractTemplate
DESCR, m_modifier, m_name, UTILS
 
Constructor Summary
JMethodTemplate(java.lang.String name)
          Creates a new JMethodTemplate instance.
JMethodTemplate(java.lang.String name, Type type1, java.lang.String name1)
           
JMethodTemplate(java.lang.String name, Type type1, java.lang.String name1, Type type2, java.lang.String name2)
           
 
Method Summary
 java.lang.String getCode()
          Returns the code for this template.
protected  java.lang.String getHelperMethodName()
           
 Type getReturnType()
           
 java.lang.String invoke()
          Returns a statement that invokes this method.
 java.lang.String invoke(java.lang.String param1)
          Returns a statement that invokes this method with the given parameter.
 java.lang.String invoke(java.lang.String[] params)
          Returns a statement that invokes this method with the given parameters.
 java.lang.String invoke(java.lang.String param1, java.lang.String param2)
          Returns a statement that invokes this method with param1, param2 as parameter.
 java.lang.String invokeExpr()
          Returns a expression that invokes this method.
 java.lang.String invokeExpr(java.lang.String param1)
          Returns a expression that invokes this method with param1 as parameter.
 java.lang.String invokeExpr(java.lang.String[] params)
          Returns a expression that invokes this method with the given parameters.
 java.lang.String invokeExpr(java.lang.String param1, java.lang.String param2)
          Returns a expression that invokes this method with param1, param2 as parameter.
 java.lang.String invokeOn(java.lang.String varName)
          Returns a statement that invokes this method.
 java.lang.String invokeOn(java.lang.String varName, java.lang.String param1)
          Returns a statement that invokes this method with the given parameter.
 java.lang.String invokeOn(java.lang.String varName, java.lang.String[] params)
          Returns a statement that invokes this method with the given parameters.
 java.lang.String invokeOn(java.lang.String varName, java.lang.String param1, java.lang.String param2)
          Returns a statement that invokes this method with param1, param2 as parameter.
 java.lang.String invokeOnExpr(java.lang.String varName)
          Returns a expression that invokes this method.
 java.lang.String invokeOnExpr(java.lang.String varName, java.lang.String param1)
          Returns a expression that invokes this method with param1 as parameter.
 java.lang.String invokeOnExpr(java.lang.String varName, java.lang.String[] params)
          Returns a expression that invokes this method with the given parameters.
 java.lang.String invokeOnExpr(java.lang.String varName, java.lang.String param1, java.lang.String param2)
          Returns a expression that invokes this method with param1, param2 as parameter.
 void setReturnType(Type type)
           
 
Methods inherited from class org.cantaloop.cgimlet.lang.java.JConstructorTemplate
addParameter, append, append, append, append, append, createHelperMethod, getBody, parameterToString, setBody
 
Methods inherited from class org.cantaloop.cgimlet.lang.java.AbstractTemplate
getModifier, getName, setModifier
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.cantaloop.cgimlet.lang.MethodTemplate
getModifier, getName, setModifier
 
Methods inherited from interface org.cantaloop.cgimlet.lang.ConstructorTemplate
addParameter, append, append, append, append, append, createHelperMethod, getBody, parameterToString, setBody
 

Field Detail

m_returnType

protected Type m_returnType
Constructor Detail

JMethodTemplate

public JMethodTemplate(java.lang.String name)
Creates a new JMethodTemplate instance.
Parameters:
name - the name of the method.

JMethodTemplate

public JMethodTemplate(java.lang.String name,
                       Type type1,
                       java.lang.String name1)

JMethodTemplate

public JMethodTemplate(java.lang.String name,
                       Type type1,
                       java.lang.String name1,
                       Type type2,
                       java.lang.String name2)
Method Detail

getHelperMethodName

protected java.lang.String getHelperMethodName()
Overrides:
getHelperMethodName in class JConstructorTemplate

getReturnType

public Type getReturnType()
Specified by:
getReturnType in interface MethodTemplate

setReturnType

public void setReturnType(Type type)
Specified by:
setReturnType in interface MethodTemplate

invokeExpr

public java.lang.String invokeExpr(java.lang.String param1)
Description copied from interface: MethodTemplate
Returns a expression that invokes this method with param1 as parameter.
Specified by:
invokeExpr in interface MethodTemplate

invokeExpr

public java.lang.String invokeExpr(java.lang.String param1,
                                   java.lang.String param2)
Description copied from interface: MethodTemplate
Returns a expression that invokes this method with param1, param2 as parameter.
Specified by:
invokeExpr in interface MethodTemplate

invokeExpr

public java.lang.String invokeExpr()
Description copied from interface: MethodTemplate
Returns a expression that invokes this method.
Specified by:
invokeExpr in interface MethodTemplate

invokeExpr

public java.lang.String invokeExpr(java.lang.String[] params)
Description copied from interface: MethodTemplate
Returns a expression that invokes this method with the given parameters.
Specified by:
invokeExpr in interface MethodTemplate

invoke

public java.lang.String invoke(java.lang.String param1)
Description copied from interface: MethodTemplate
Returns a statement that invokes this method with the given parameter.
Specified by:
invoke in interface MethodTemplate

invoke

public java.lang.String invoke(java.lang.String param1,
                               java.lang.String param2)
Description copied from interface: MethodTemplate
Returns a statement that invokes this method with param1, param2 as parameter.
Specified by:
invoke in interface MethodTemplate

invoke

public java.lang.String invoke()
Description copied from interface: MethodTemplate
Returns a statement that invokes this method.
Specified by:
invoke in interface MethodTemplate

invoke

public java.lang.String invoke(java.lang.String[] params)
Description copied from interface: MethodTemplate
Returns a statement that invokes this method with the given parameters.
Specified by:
invoke in interface MethodTemplate

invokeOnExpr

public java.lang.String invokeOnExpr(java.lang.String varName,
                                     java.lang.String param1)
Description copied from interface: MethodTemplate
Returns a expression that invokes this method with param1 as parameter.
Specified by:
invokeOnExpr in interface MethodTemplate

invokeOnExpr

public java.lang.String invokeOnExpr(java.lang.String varName,
                                     java.lang.String param1,
                                     java.lang.String param2)
Description copied from interface: MethodTemplate
Returns a expression that invokes this method with param1, param2 as parameter.
Specified by:
invokeOnExpr in interface MethodTemplate

invokeOnExpr

public java.lang.String invokeOnExpr(java.lang.String varName)
Description copied from interface: MethodTemplate
Returns a expression that invokes this method.
Specified by:
invokeOnExpr in interface MethodTemplate

invokeOnExpr

public java.lang.String invokeOnExpr(java.lang.String varName,
                                     java.lang.String[] params)
Description copied from interface: MethodTemplate
Returns a expression that invokes this method with the given parameters.
Specified by:
invokeOnExpr in interface MethodTemplate

invokeOn

public java.lang.String invokeOn(java.lang.String varName,
                                 java.lang.String param1)
Description copied from interface: MethodTemplate
Returns a statement that invokes this method with the given parameter.
Specified by:
invokeOn in interface MethodTemplate

invokeOn

public java.lang.String invokeOn(java.lang.String varName,
                                 java.lang.String param1,
                                 java.lang.String param2)
Description copied from interface: MethodTemplate
Returns a statement that invokes this method with param1, param2 as parameter.
Specified by:
invokeOn in interface MethodTemplate

invokeOn

public java.lang.String invokeOn(java.lang.String varName)
Description copied from interface: MethodTemplate
Returns a statement that invokes this method.
Specified by:
invokeOn in interface MethodTemplate

invokeOn

public java.lang.String invokeOn(java.lang.String varName,
                                 java.lang.String[] params)
Description copied from interface: MethodTemplate
Returns a statement that invokes this method with the given parameters.
Specified by:
invokeOn in interface MethodTemplate

getCode

public java.lang.String getCode()
Description copied from interface: Template
Returns the code for this template.
Specified by:
getCode in interface MethodTemplate
Overrides:
getCode in class JConstructorTemplate

Copyright 2001, 2002 Stefan Heimann, David Leuschner. All rights reserved.