|
Cantaloop CGimlet - API Documentation, Version: 0.2.0, Date: 2002-05-13 21:30 CEST | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Interface that defines helper methods for generating common expression and statements in a programming language independent way.
Method Summary | |
java.lang.String |
callReturn(java.lang.String expr)
Generates a return statement that returns expr . |
java.lang.String |
callSet(java.lang.String var,
java.lang.String property,
java.lang.String value)
Generate a statement for calling a set method. |
java.lang.String |
caseConcat(java.lang.String s1,
java.lang.String s2)
Concats s1 and s2 and makes sure that the first letter of s2 is an upper case letter. |
java.lang.String |
caseConcat(java.lang.String s1,
java.lang.String s2,
java.lang.String s3)
Concats s1, s2 and s3 and makes sure that the first letter of s2 and s3 is an upper case letter. |
java.lang.String |
caseConcat(java.lang.String s1,
java.lang.String s2,
java.lang.String s3,
java.lang.String s4)
Concats s1, s2, s3 and s4 and makes sure that the first letter of s2, s3 and s4 is an upper case letter. |
MethodTemplate |
getter(FieldTemplate field)
Factory method that returns a template for a get-method. |
MethodTemplate |
getter(java.lang.String externalName,
FieldTemplate field)
Factory method that returns a template for a get-method. |
java.lang.String |
invoke(java.lang.String methodName)
Returns a statement that invokes the method named methodName . |
java.lang.String |
invoke(java.lang.String methodName,
java.lang.String param1)
Returns a statement that invokes the method named methodName
with the given parameter. |
java.lang.String |
invoke(java.lang.String methodName,
java.lang.String[] params)
Returns a statement that invokes the method named methodName
with the given parameters. |
java.lang.String |
invoke(java.lang.String methodName,
java.lang.String param1,
java.lang.String param2)
Returns a statement that invokes the method named methodName
with param1, param2 as parameter. |
java.lang.String |
invokeExpr(java.lang.String methodName)
Returns a expression that invokes the method named methodName . |
java.lang.String |
invokeExpr(java.lang.String methodName,
java.lang.String param1)
Returns a expression that invokes the method named methodName
with param1 as parameter. |
java.lang.String |
invokeExpr(java.lang.String methodName,
java.lang.String[] params)
Returns a expression that invokes the method named methodName
with the given parameters. |
java.lang.String |
invokeExpr(java.lang.String methodName,
java.lang.String param1,
java.lang.String param2)
Returns a expression that invokes the method named methodName
with param1, param2 as parameter. |
java.lang.String |
invokeOn(java.lang.String varName,
java.lang.String methodName)
Returns a statement that invokes the method named methodName . |
java.lang.String |
invokeOn(java.lang.String varName,
java.lang.String methodName,
java.lang.String param1)
Returns a statement that invokes the method named methodName
with the given parameter. |
java.lang.String |
invokeOn(java.lang.String varName,
java.lang.String methodName,
java.lang.String[] params)
Returns a statement that invokes the method named methodName
with the given parameters. |
java.lang.String |
invokeOn(java.lang.String varName,
java.lang.String methodName,
java.lang.String param1,
java.lang.String param2)
Returns a statement that invokes the method named methodName
with param1, param2 as parameter. |
java.lang.String |
invokeOnExpr(java.lang.String varName,
java.lang.String methodName)
Returns a expression that invokes the method named methodName . |
java.lang.String |
invokeOnExpr(java.lang.String varName,
java.lang.String methodName,
java.lang.String param1)
Returns a expression that invokes the method named methodName
with param1 as parameter. |
java.lang.String |
invokeOnExpr(java.lang.String varName,
java.lang.String methodName,
java.lang.String[] params)
Returns a expression that invokes the method named methodName
with the given parameters. |
java.lang.String |
invokeOnExpr(java.lang.String varName,
java.lang.String methodName,
java.lang.String param1,
java.lang.String param2)
Returns a expression that invokes the method named methodName
with param1, param2 as parameter. |
java.lang.String |
makeClassName(java.lang.String template,
java.lang.String baseName,
char placeholder)
Create a classname based on a template. |
java.lang.String |
mapPut(java.lang.String key,
java.lang.String value)
Shorthand for: mapPut("map", key, value) . |
java.lang.String |
mapPut(java.lang.String mapName,
java.lang.String key,
java.lang.String value)
Returns a statement that invokes the put method on the
map named mapName with the given key and value. |
java.lang.String |
mapStrPut(java.lang.String key,
java.lang.String value)
Shorthand for: mapStrPut("map", key, value) . |
java.lang.String |
mapStrPut(java.lang.String mapName,
java.lang.String key,
java.lang.String value)
Same as mapPut except that key will be quoted. |
java.lang.String |
newInstance(Type type,
java.lang.String name)
Shorthand for newInstance(type, name, type); . |
java.lang.String |
newInstance(Type interfaceType,
java.lang.String name,
Type implType)
Creates a statement that icreates a instance of implType
and stores that instance in the variable name . |
java.lang.String |
nonfinalToFinalIdentifier(java.lang.String s)
Convert a (valid) identifier to a final identifier. |
java.lang.String |
quote(java.lang.String s)
|
MethodTemplate |
setter(FieldTemplate field)
Factory method that returns a template for a set-method. |
MethodTemplate |
setter(java.lang.String externalName,
FieldTemplate field)
Factory method that returns a template for a set-method. |
java.lang.String |
sprintf(java.lang.String str,
java.lang.String arg1)
Shorthand for sprintf(str, new String[]{arg1}) . |
java.lang.String |
sprintf(java.lang.String str,
java.lang.String[] args)
This method acts like the sprintf routine in C. |
java.lang.String |
sprintf(java.lang.String str,
java.lang.String arg1,
java.lang.String arg2)
Shorthand for sprintf(str, new String[]{arg1,arg2}) . |
java.lang.String |
sprintf(java.lang.String str,
java.lang.String arg1,
java.lang.String arg2,
java.lang.String arg3)
Shorthand for sprintf(str, new String[]{arg1,arg2,arg3}) . |
boolean |
stringToBoolean(java.lang.String s,
boolean def)
Converts a String into a boolean.
The "boolean value" of a string is defined as following:"yes".equals(s) || "true".equals(s) || "on".equals(s) .
If s == null the value of def is
returned. |
java.lang.String |
toFinalIdentifier(java.lang.String s)
Convert s into a identifier which can be used
for final fields etc. |
java.lang.String |
toIdentifier(java.lang.String s)
Shorthand for toIdentifier(s, false); |
java.lang.String |
toIdentifier(java.lang.String s,
boolean capitalize)
Convert s into an indentifier.
|
Method Detail |
public boolean stringToBoolean(java.lang.String s, boolean def)
Converts a String
into a boolean.
The "boolean value" of a string is defined as following:
"yes".equals(s) || "true".equals(s) || "on".equals(s)
.
If s == null
the value of def
is
returned.
s
- a String
valuedef
- the value to return if s == null
boolean
valuepublic java.lang.String newInstance(Type type, java.lang.String name)
newInstance(type, name, type);
.public java.lang.String newInstance(Type interfaceType, java.lang.String name, Type implType)
implType
and stores that instance in the variable name
. The
type of this variable is determined by the interfaceType
parameter.public java.lang.String callSet(java.lang.String var, java.lang.String property, java.lang.String value)
var
- the name of the variable on which to invoke
the methodproperty
- the name of the property that should be set.value
- the value to which the property should be set to.String
valuepublic java.lang.String toIdentifier(java.lang.String s)
toIdentifier(s, false);
public java.lang.String toIdentifier(java.lang.String s, boolean capitalize)
s
into an indentifier.
Whitespace characters and '-' are treated as word bounderies
and converted accordingly to the coding conventions of
the programming language.s
- the string to convert.capitalize
- specify if the first letter should be
capitalized or not.String
valueCodeGenerationException
- if s
cannot be converted
properlypublic java.lang.String toFinalIdentifier(java.lang.String s)
s
into a identifier which can be used
for final fields etc.public java.lang.String nonfinalToFinalIdentifier(java.lang.String s)
public java.lang.String makeClassName(java.lang.String template, java.lang.String baseName, char placeholder)
template
- a String
valuebaseName
- a String
valueplaceholder
- the caracter which should be treated as the placeholderString
valuepublic java.lang.String mapPut(java.lang.String mapName, java.lang.String key, java.lang.String value)
put
method on the
map named mapName
with the given key and value.public java.lang.String mapPut(java.lang.String key, java.lang.String value)
mapPut("map", key, value)
.public java.lang.String mapStrPut(java.lang.String mapName, java.lang.String key, java.lang.String value)
mapPut
except that key will be quoted.public java.lang.String mapStrPut(java.lang.String key, java.lang.String value)
mapStrPut("map", key, value)
.public java.lang.String quote(java.lang.String s)
public java.lang.String invokeExpr(java.lang.String methodName, java.lang.String param1)
methodName
with param1
as parameter.public java.lang.String invokeExpr(java.lang.String methodName, java.lang.String param1, java.lang.String param2)
methodName
with param1, param2
as parameter.public java.lang.String invokeExpr(java.lang.String methodName)
methodName
.public java.lang.String invokeExpr(java.lang.String methodName, java.lang.String[] params)
methodName
with the given parameters.public java.lang.String invoke(java.lang.String methodName, java.lang.String param1)
methodName
with the given parameter.public java.lang.String invoke(java.lang.String methodName, java.lang.String param1, java.lang.String param2)
methodName
with param1, param2
as parameter.public java.lang.String invoke(java.lang.String methodName)
methodName
.public java.lang.String invoke(java.lang.String methodName, java.lang.String[] params)
methodName
with the given parameters.public java.lang.String invokeOnExpr(java.lang.String varName, java.lang.String methodName, java.lang.String param1)
methodName
with param1
as parameter.public java.lang.String invokeOnExpr(java.lang.String varName, java.lang.String methodName, java.lang.String param1, java.lang.String param2)
methodName
with param1, param2
as parameter.public java.lang.String invokeOnExpr(java.lang.String varName, java.lang.String methodName)
methodName
.public java.lang.String invokeOnExpr(java.lang.String varName, java.lang.String methodName, java.lang.String[] params)
methodName
with the given parameters.public java.lang.String invokeOn(java.lang.String varName, java.lang.String methodName, java.lang.String param1)
methodName
with the given parameter.public java.lang.String invokeOn(java.lang.String varName, java.lang.String methodName, java.lang.String param1, java.lang.String param2)
methodName
with param1, param2
as parameter.public java.lang.String invokeOn(java.lang.String varName, java.lang.String methodName)
methodName
.public java.lang.String invokeOn(java.lang.String varName, java.lang.String methodName, java.lang.String[] params)
methodName
with the given parameters.public java.lang.String sprintf(java.lang.String str, java.lang.String[] args)
sprintf
routine in C. It
replaces the the n-th occurence of either %s or %q in
str
with the n-th element of args. If
%s is used, the string argument will be inserted as is. If %q is
used, the quote(java.lang.String)
method will be used to quote the
inserted string.
public java.lang.String sprintf(java.lang.String str, java.lang.String arg1)
sprintf(str, new String[]{arg1})
.public java.lang.String sprintf(java.lang.String str, java.lang.String arg1, java.lang.String arg2)
sprintf(str, new String[]{arg1,arg2})
.public java.lang.String sprintf(java.lang.String str, java.lang.String arg1, java.lang.String arg2, java.lang.String arg3)
sprintf(str, new String[]{arg1,arg2,arg3})
.public java.lang.String caseConcat(java.lang.String s1, java.lang.String s2)
public java.lang.String caseConcat(java.lang.String s1, java.lang.String s2, java.lang.String s3)
public java.lang.String caseConcat(java.lang.String s1, java.lang.String s2, java.lang.String s3, java.lang.String s4)
public java.lang.String callReturn(java.lang.String expr)
expr
.public MethodTemplate setter(FieldTemplate field)
field
- the field to set.public MethodTemplate setter(java.lang.String externalName, FieldTemplate field)
externalName
- the name that is used outside the class
for this propertyfield
- the field that should be set.MethodTemplate
valuepublic MethodTemplate getter(FieldTemplate field)
field
- the field to get.public MethodTemplate getter(java.lang.String externalName, FieldTemplate field)
externalName
- the name that is used outside the class
for this propertyfield
- the field whose value should be retrieved.MethodTemplate
value
|
Copyright 2001, 2002 Stefan Heimann, David Leuschner. All rights reserved. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |