|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.torque.generator.outlet.OutletImpl org.apache.torque.generator.outlet.java.OutletWithoutMergepoints org.apache.torque.generator.outlet.java.StringInputOutlet org.apache.torque.generator.outlet.java.CamelbackOutlet
public class CamelbackOutlet
Transform a String to its camelback version. This is typically useful when creating java class or attribute names. The name can be truncated before/after special characters, other special characters can be removed, and still other characters can be removed plus the next character is transformed into upper case. If wrapReservedJavaWords is set to true, the result will be prepended with an underscore if the result of the transwormation would be a reserved word within the java syntax (e.g. int, for etc...)
Constructor Summary | |
---|---|
CamelbackOutlet(QualifiedName qualifiedName)
Constructor. |
Method Summary | |
---|---|
OutletResult |
execute(ControllerState controllerState)
Processes the input according to the camelback rules. |
void |
setDefaultLowerCase(boolean defaultLowerCase)
Sets whether all characters in the processed String should be made lower Case by default (i.e if none of the camelback rules is applicable). |
void |
setFirstCharUppercase(boolean firstCharUppercase)
Sets whether the first character should always be upper case. |
void |
setIgnorePartAfter(String ignorePartAfter)
Sets the separation chars which define the suffix to be removed. |
void |
setIgnorePartBefore(String ignorePartBefore)
Sets the separation characters which define the prefix to be removed. |
void |
setRemoveWithoutUppercase(String removeWithoutUppercase)
Sets which characters are removed from the processed String. |
void |
setRemoveWithUppercase(String removeWithUppercase)
Sets the characters which are removed from the processed String and cause the following character to be converted to upper case. |
void |
setReservedJavaWordsPrefix(String prefix)
Sets the prefix which is prepended to reserved java words. |
void |
setReservedJavaWordsSuffix(String suffix)
Sets the suffix which is prepended to reserved java words. |
void |
setWrapReservedJavaWords(boolean wrapReservedJavaWords)
Sets whether reserved java words (as output of the camelbacker) are wrapped (prepended or appended). |
Methods inherited from class org.apache.torque.generator.outlet.java.StringInputOutlet |
---|
getInput, setInputOption, setInputSourceElement, setInputValue, setInputVariable, setSourceElementAttribute |
Methods inherited from class org.apache.torque.generator.outlet.java.OutletWithoutMergepoints |
---|
addMergepointMapping, getMergepointMapping |
Methods inherited from class org.apache.torque.generator.outlet.OutletImpl |
---|
afterExecute, beforeExecute, getInputElementName, getMergepointMappings, getName, getVariable, mergepoint, setInputElementName, setMergepointMapping, setVariable, setVariable, toString |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public CamelbackOutlet(QualifiedName qualifiedName)
qualifiedName
- the unique name of the outlet, not null.Method Detail |
---|
public void setRemoveWithoutUppercase(String removeWithoutUppercase)
removeWithoutUppercase
- a String containing all characters
which are simply removed from the input String.public void setRemoveWithUppercase(String removeWithUppercase)
removeWithUppercase
- a String containing all characters which are
removed from the input String and which cause the following
character to be converted to upper case.public void setDefaultLowerCase(boolean defaultLowerCase)
defaultLowerCase
- true if all characters are converted to lower
case by default, false if not.public void setIgnorePartBefore(String ignorePartBefore)
ignorePartBefore
- the separation chars which define the suffix
to be removed.public void setIgnorePartAfter(String ignorePartAfter)
ignorePartAfter
- the separation chars for removing the tail.public void setFirstCharUppercase(boolean firstCharUppercase)
firstCharUppercase
- true if the first character should always
be converted to upper case, false if not.public void setWrapReservedJavaWords(boolean wrapReservedJavaWords)
wrapReservedJavaWords
- true if reserved java words should be
wrapped, false if not.public void setReservedJavaWordsPrefix(String prefix)
prefix
- the new prefix, not null.public void setReservedJavaWordsSuffix(String suffix)
suffix
- the new suffix, not null.public OutletResult execute(ControllerState controllerState) throws GeneratorException
execute
in interface Outlet
execute
in class OutletImpl
controllerState
- the current state of the controller, not null.
GeneratorException
- in processing fails.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |