A B C F G I J M N O P S T

A

addBlockTag(BlockTagSource) - Method in class ca.quine.jcommons.sourcegen.JavaDocCommentSource
 
addField(FieldSource) - Method in class ca.quine.jcommons.sourcegen.ClassSource
 
addMethod(MethodSource) - Method in class ca.quine.jcommons.sourcegen.ClassSource
 
addParameter(Parameter) - Method in class ca.quine.jcommons.sourcegen.MethodSource
 
addProperty(String, String) - Method in class ca.quine.jcommons.sourcegen.ClassSource
Create a new private field of type type with name name and create and accessor and mutator method for it.
addSpaceToLastEntry(ArrayList) - Static method in class ca.quine.jcommons.sourcegen.FormattingUtils
 
addSpaceToLastEntryIfNotThere(ArrayList) - Static method in class ca.quine.jcommons.sourcegen.FormattingUtils
 
AllTests - class ca.quine.jcommons.sourcegen.test.AllTests.
 
AllTests() - Constructor for class ca.quine.jcommons.sourcegen.test.AllTests
 

B

BlockTagSource - class ca.quine.jcommons.sourcegen.BlockTagSource.
Represents any JavaDoc block tag that has a name and associated text, but no second column.
BlockTagSource(String) - Constructor for class ca.quine.jcommons.sourcegen.BlockTagSource
 

C

C_STYLE - Static variable in class ca.quine.jcommons.sourcegen.CommentSource
 
ca.quine.jcommons.sourcegen - package ca.quine.jcommons.sourcegen
 
ca.quine.jcommons.sourcegen.test - package ca.quine.jcommons.sourcegen.test
 
ClassSource - class ca.quine.jcommons.sourcegen.ClassSource.
 
ClassSource(boolean, String) - Constructor for class ca.quine.jcommons.sourcegen.ClassSource
Constructs a new ClassSource object (which represents a class).
ClassSourceTest - class ca.quine.jcommons.sourcegen.test.ClassSourceTest.
 
ClassSourceTest() - Constructor for class ca.quine.jcommons.sourcegen.test.ClassSourceTest
 
CommentSource - class ca.quine.jcommons.sourcegen.CommentSource.
 
CommentSource(int, String) - Constructor for class ca.quine.jcommons.sourcegen.CommentSource
 
CommentSource(String) - Constructor for class ca.quine.jcommons.sourcegen.CommentSource
 
CommentSourceTest - class ca.quine.jcommons.sourcegen.test.CommentSourceTest.
 
CommentSourceTest() - Constructor for class ca.quine.jcommons.sourcegen.test.CommentSourceTest
 

F

FieldSource - class ca.quine.jcommons.sourcegen.FieldSource.
 
FieldSource(String, String) - Constructor for class ca.quine.jcommons.sourcegen.FieldSource
 
FieldSourceTest - class ca.quine.jcommons.sourcegen.test.FieldSourceTest.
 
FieldSourceTest() - Constructor for class ca.quine.jcommons.sourcegen.test.FieldSourceTest
 
formatCodeLine(FormattingRules, String) - Static method in class ca.quine.jcommons.sourcegen.FormattingUtils
If the given FormattingRules use spaces for indenting, convert any tabs at the beginning of the line into the appropriate number of spaces.
formatList(FormattingRules, ArrayList, int, int) - Static method in class ca.quine.jcommons.sourcegen.FormattingUtils
Take the ArrayList of Strings (must contain at least 1 String) and format them onto lines as defined by the given rules.
formatList(FormattingRules, ArrayList, int, String) - Static method in class ca.quine.jcommons.sourcegen.FormattingUtils
Take the ArrayList of Strings (must contain at least 1 String and each String must contain appropriate trailing spacing) and format them onto lines as defined by the given rules with the given prefix on each line.
FormattingRules - class ca.quine.jcommons.sourcegen.FormattingRules.
Holds information about the indenting and other formatting of generated source code, and provides helper methods for getting the length of source lines given the current settings.
FormattingRules() - Constructor for class ca.quine.jcommons.sourcegen.FormattingRules
 
FormattingRules(boolean, int) - Constructor for class ca.quine.jcommons.sourcegen.FormattingRules
 
FormattingRulesTest - class ca.quine.jcommons.sourcegen.test.FormattingRulesTest.
 
FormattingRulesTest() - Constructor for class ca.quine.jcommons.sourcegen.test.FormattingRulesTest
 
FormattingUtils - class ca.quine.jcommons.sourcegen.FormattingUtils.
 
FormattingUtilsTest - class ca.quine.jcommons.sourcegen.test.FormattingUtilsTest.
 
FormattingUtilsTest() - Constructor for class ca.quine.jcommons.sourcegen.test.FormattingUtilsTest
 

G

getCodeLines() - Method in class ca.quine.jcommons.sourcegen.MethodSource
 
getComment() - Method in class ca.quine.jcommons.sourcegen.MethodSource
 
getComment() - Method in class ca.quine.jcommons.sourcegen.FieldSource
 
getComment() - Method in class ca.quine.jcommons.sourcegen.ClassSource
 
getExceptions() - Method in class ca.quine.jcommons.sourcegen.MethodSource
 
getFieldIterator() - Method in class ca.quine.jcommons.sourcegen.ClassSource
Returns an Iterator of FieldSource objects.
getFirstColumn() - Method in class ca.quine.jcommons.sourcegen.BlockTagSource
 
getImports() - Method in class ca.quine.jcommons.sourcegen.JavaSourceFile
 
getIndent() - Method in class ca.quine.jcommons.sourcegen.FormattingRules
Returns a String containing a number of spaces or a tab representing one indent level based on the current indent settings.
getIndentLevel() - Method in class ca.quine.jcommons.sourcegen.CommentSource
 
getIndentSize() - Method in class ca.quine.jcommons.sourcegen.FormattingRules
 
getLength(int, String) - Method in class ca.quine.jcommons.sourcegen.FormattingRules
Calculates the length in characters of the input String after the given number of indents is applied.
getLength(String) - Method in class ca.quine.jcommons.sourcegen.FormattingRules
Using the indent size for each tab, figure out the length in characters of the input String.
getLineLength() - Method in class ca.quine.jcommons.sourcegen.FormattingRules
 
getLocalName() - Method in class ca.quine.jcommons.sourcegen.Parameter
 
getMethodIndent() - Method in class ca.quine.jcommons.sourcegen.FormattingRules
Returns the number of indents to use for a method (normally 1).
getModifiers() - Method in class ca.quine.jcommons.sourcegen.MethodSource
 
getModifiers() - Method in class ca.quine.jcommons.sourcegen.FieldSource
 
getModifiers() - Method in class ca.quine.jcommons.sourcegen.ClassSource
See the public static finals on Modifier.
getName() - Method in class ca.quine.jcommons.sourcegen.MethodSource
 
getName() - Method in class ca.quine.jcommons.sourcegen.FieldSource
 
getName() - Method in class ca.quine.jcommons.sourcegen.ClassSource
 
getName() - Method in class ca.quine.jcommons.sourcegen.BlockTagSource
 
getPackageName() - Method in class ca.quine.jcommons.sourcegen.JavaSourceFile
 
getParameterIterator() - Method in class ca.quine.jcommons.sourcegen.MethodSource
 
getParent() - Method in class ca.quine.jcommons.sourcegen.BlockTagSource
 
getPrepackageCommentFilename() - Method in class ca.quine.jcommons.sourcegen.JavaSourceFile
 
getPrepackageComments() - Method in class ca.quine.jcommons.sourcegen.JavaSourceFile
 
getPublicClass() - Method in class ca.quine.jcommons.sourcegen.JavaSourceFile
 
getReturnType() - Method in class ca.quine.jcommons.sourcegen.MethodSource
 
getSecondColumn() - Method in class ca.quine.jcommons.sourcegen.SecondColumnBlockTagSource
 
getSecondColumn() - Method in class ca.quine.jcommons.sourcegen.BlockTagSource
 
getStyle() - Method in class ca.quine.jcommons.sourcegen.CommentSource
 
getSuperClass() - Method in class ca.quine.jcommons.sourcegen.ClassSource
 
getText() - Method in class ca.quine.jcommons.sourcegen.CommentSource
 
getText() - Method in class ca.quine.jcommons.sourcegen.BlockTagSource
 
getType() - Method in class ca.quine.jcommons.sourcegen.Parameter
 
getType() - Method in class ca.quine.jcommons.sourcegen.FieldSource
 

I

INDENT_STYLE - Static variable in class ca.quine.jcommons.sourcegen.CommentSource
See Sun's JavaDoc page regarding indent.
indentLevel - Variable in class ca.quine.jcommons.sourcegen.CommentSource
 
isPrimitive() - Method in class ca.quine.jcommons.sourcegen.FieldSource
 
isPublic() - Method in class ca.quine.jcommons.sourcegen.ClassSource
Returns true if and only if this class represents the public class in a Java source file.
isReformat() - Method in class ca.quine.jcommons.sourcegen.CommentSource
 
isStarOnEachLine() - Method in class ca.quine.jcommons.sourcegen.CommentSource
 
isUnixNewLine() - Method in class ca.quine.jcommons.sourcegen.FormattingRules
 
isUseSingleLineCommentIfPossible() - Method in class ca.quine.jcommons.sourcegen.CommentSource
 
isUseSpaces() - Method in class ca.quine.jcommons.sourcegen.FormattingRules
 

J

JAVADOC_STYLE - Static variable in class ca.quine.jcommons.sourcegen.CommentSource
 
JavaDocCommentSource - class ca.quine.jcommons.sourcegen.JavaDocCommentSource.
 
JavaDocCommentSource() - Constructor for class ca.quine.jcommons.sourcegen.JavaDocCommentSource
 
JavaDocCommentSource(int) - Constructor for class ca.quine.jcommons.sourcegen.JavaDocCommentSource
 
JavaDocCommentSourceTest - class ca.quine.jcommons.sourcegen.test.JavaDocCommentSourceTest.
 
JavaDocCommentSourceTest() - Constructor for class ca.quine.jcommons.sourcegen.test.JavaDocCommentSourceTest
 
JavaSourceFile - class ca.quine.jcommons.sourcegen.JavaSourceFile.
Holds data related to and can output a Java source file.
JavaSourceFile(String) - Constructor for class ca.quine.jcommons.sourcegen.JavaSourceFile
 
JavaSourceFileTest - class ca.quine.jcommons.sourcegen.test.JavaSourceFileTest.
 
JavaSourceFileTest() - Constructor for class ca.quine.jcommons.sourcegen.test.JavaSourceFileTest
 

M

main(String[]) - Static method in class ca.quine.jcommons.sourcegen.test.SourceGenExample
 
makeCommaSeparatedList(String, ArrayList, String, boolean) - Static method in class ca.quine.jcommons.sourcegen.FormattingUtils
Makes a comma separated list that can then be used with formatList.
makeFormattableListForSignature(FormattingRules) - Method in class ca.quine.jcommons.sourcegen.MethodSource
Creates an ArrayList of Strings for the method signature, each of which is an indivisible token to be formatted on one or more lines.
methodCodeIndent(StringBuffer) - Method in class ca.quine.jcommons.sourcegen.FormattingRules
Appends an indent to the given buffer for code inside a method with the current indent settings.
methodIndent(StringBuffer) - Method in class ca.quine.jcommons.sourcegen.FormattingRules
Appends a method indent to the given buffer with the current indent settings.
MethodSource - class ca.quine.jcommons.sourcegen.MethodSource.
 
MethodSource(boolean, String, String) - Constructor for class ca.quine.jcommons.sourcegen.MethodSource
 
MethodSourceTest - class ca.quine.jcommons.sourcegen.test.MethodSourceTest.
 
MethodSourceTest() - Constructor for class ca.quine.jcommons.sourcegen.test.MethodSourceTest
 

N

newLine(StringBuffer) - Method in class ca.quine.jcommons.sourcegen.FormattingRules
Appends a new line to the given buffer with the current indent settings.

O

output(FormattingRules, StringBuffer) - Method in class ca.quine.jcommons.sourcegen.MethodSource
 
output(FormattingRules, StringBuffer) - Method in class ca.quine.jcommons.sourcegen.JavaSourceFile
 
output(FormattingRules, StringBuffer) - Method in class ca.quine.jcommons.sourcegen.JavaDocCommentSource
 
output(FormattingRules, StringBuffer) - Method in class ca.quine.jcommons.sourcegen.FieldSource
 
output(FormattingRules, StringBuffer) - Method in class ca.quine.jcommons.sourcegen.CommentSource
 
output(FormattingRules, StringBuffer) - Method in class ca.quine.jcommons.sourcegen.ClassSource
Formats and outputs this class (with the given FormattingRules) into the given StringBuffer.
output(FormattingRules, StringBuffer, int, int) - Method in class ca.quine.jcommons.sourcegen.SecondColumnBlockTagSource
 
output(FormattingRules, StringBuffer, int, int) - Method in class ca.quine.jcommons.sourcegen.BlockTagSource
 
outputLines(FormattingRules, ArrayList, StringBuffer) - Static method in class ca.quine.jcommons.sourcegen.FormattingUtils
Outputs the already formatted and indented lines into the given StringBuffer.
outputProtected(FormattingRules, StringBuffer) - Method in class ca.quine.jcommons.sourcegen.CommentSource
Allow subclasses to take advantage of the text formatting without adding the "style" to the beginning and end of the buffer.
outputText(FormattingRules, StringBuffer, int, StringBuffer) - Method in class ca.quine.jcommons.sourcegen.BlockTagSource
 
outputWithoutReformat(FormattingRules, StringBuffer) - Method in class ca.quine.jcommons.sourcegen.CommentSource
 

P

Parameter - class ca.quine.jcommons.sourcegen.Parameter.
 
Parameter(String, String) - Constructor for class ca.quine.jcommons.sourcegen.Parameter
 

S

SecondColumnBlockTagSource - class ca.quine.jcommons.sourcegen.SecondColumnBlockTagSource.
Represents a JavaDoc block tag that has a name, something in the first column, and associated text.
SecondColumnBlockTagSource(String, String) - Constructor for class ca.quine.jcommons.sourcegen.SecondColumnBlockTagSource
 
setCodeLines(ArrayList) - Method in class ca.quine.jcommons.sourcegen.MethodSource
Sets an ArrayList of lines of code that will become the method body; tabs for internal indenting will be converted to spaces if space indenting is on.
setComment(CommentSource) - Method in class ca.quine.jcommons.sourcegen.MethodSource
 
setComment(CommentSource) - Method in class ca.quine.jcommons.sourcegen.FieldSource
 
setComment(JavaDocCommentSource) - Method in class ca.quine.jcommons.sourcegen.ClassSource
 
setException(String) - Method in class ca.quine.jcommons.sourcegen.MethodSource
 
setExceptions(ArrayList) - Method in class ca.quine.jcommons.sourcegen.MethodSource
 
setImplements(ArrayList) - Method in class ca.quine.jcommons.sourcegen.ClassSource
Sets the given ArrayList of String objects as the interfaces that this class implements.
setImplements(String) - Method in class ca.quine.jcommons.sourcegen.ClassSource
Sets the given interface as the only one this class implements.
setImports(ArrayList) - Method in class ca.quine.jcommons.sourcegen.JavaSourceFile
 
setIndentLevel(int) - Method in class ca.quine.jcommons.sourcegen.CommentSource
 
setIndentSize(int) - Method in class ca.quine.jcommons.sourcegen.FormattingRules
 
setLineLength(int) - Method in class ca.quine.jcommons.sourcegen.FormattingRules
 
setModifiers(int) - Method in class ca.quine.jcommons.sourcegen.MethodSource
 
setModifiers(int) - Method in class ca.quine.jcommons.sourcegen.FieldSource
 
setModifiers(int) - Method in class ca.quine.jcommons.sourcegen.ClassSource
See the public static finals on Modifier.
setName(String) - Method in class ca.quine.jcommons.sourcegen.FieldSource
 
setName(String) - Method in class ca.quine.jcommons.sourcegen.BlockTagSource
 
setPackageName(String) - Method in class ca.quine.jcommons.sourcegen.JavaSourceFile
 
setParent(JavaDocCommentSource) - Method in class ca.quine.jcommons.sourcegen.BlockTagSource
 
setPrepackageCommentFilename(String) - Method in class ca.quine.jcommons.sourcegen.JavaSourceFile
Sets a file to be output as the comments before the package declaration.
setPrepackageComments(String) - Method in class ca.quine.jcommons.sourcegen.JavaSourceFile
Sets a String to be output as the comments before the package declaration.
setPublicClass(ClassSource) - Method in class ca.quine.jcommons.sourcegen.JavaSourceFile
 
setReformat(boolean) - Method in class ca.quine.jcommons.sourcegen.CommentSource
 
setStarOnEachLine(boolean) - Method in class ca.quine.jcommons.sourcegen.CommentSource
 
setStyle(String) - Method in class ca.quine.jcommons.sourcegen.CommentSource
 
setSuperClass(String) - Method in class ca.quine.jcommons.sourcegen.ClassSource
 
setText(String) - Method in class ca.quine.jcommons.sourcegen.CommentSource
 
setText(String) - Method in class ca.quine.jcommons.sourcegen.BlockTagSource
 
setType(String) - Method in class ca.quine.jcommons.sourcegen.FieldSource
 
setUnixNewLine(boolean) - Method in class ca.quine.jcommons.sourcegen.FormattingRules
 
setUseSingleLineCommentIfPossible(boolean) - Method in class ca.quine.jcommons.sourcegen.CommentSource
If JavaDoc style is used, this field will be ignored.
setUseSpaces(boolean) - Method in class ca.quine.jcommons.sourcegen.FormattingRules
 
SourceGenExample - class ca.quine.jcommons.sourcegen.test.SourceGenExample.
This class illustrates the basic usage of SourceGen.
SourceGenExample() - Constructor for class ca.quine.jcommons.sourcegen.test.SourceGenExample
 
style - Variable in class ca.quine.jcommons.sourcegen.CommentSource
 
suite() - Static method in class ca.quine.jcommons.sourcegen.test.AllTests
 

T

testBothColumns() - Method in class ca.quine.jcommons.sourcegen.test.JavaDocCommentSourceTest
 
testCppStyleComment() - Method in class ca.quine.jcommons.sourcegen.test.FieldSourceTest
 
testCStyleComment() - Method in class ca.quine.jcommons.sourcegen.test.FieldSourceTest
 
testFormatListBigItems() - Method in class ca.quine.jcommons.sourcegen.test.FormattingUtilsTest
 
testFormatListSmallItemsFirst() - Method in class ca.quine.jcommons.sourcegen.test.FormattingUtilsTest
 
testGetLength() - Method in class ca.quine.jcommons.sourcegen.test.FormattingRulesTest
 
testImplements() - Method in class ca.quine.jcommons.sourcegen.test.ClassSourceTest
 
testJavaDocWithReformat() - Method in class ca.quine.jcommons.sourcegen.test.ClassSourceTest
 
testMakeCommaSeparatedList0Items() - Method in class ca.quine.jcommons.sourcegen.test.FormattingUtilsTest
 
testMakeCommaSeparatedList0ItemsNoPrefix() - Method in class ca.quine.jcommons.sourcegen.test.FormattingUtilsTest
 
testMakeCommaSeparatedList1Item() - Method in class ca.quine.jcommons.sourcegen.test.FormattingUtilsTest
 
testMakeCommaSeparatedList2Items() - Method in class ca.quine.jcommons.sourcegen.test.FormattingUtilsTest
 
testMakeCommaSeparatedList5Items() - Method in class ca.quine.jcommons.sourcegen.test.FormattingUtilsTest
 
testMakeFormattableListForSignature0Args() - Method in class ca.quine.jcommons.sourcegen.test.MethodSourceTest
 
testMakeFormattableListForSignature0ArgsException() - Method in class ca.quine.jcommons.sourcegen.test.MethodSourceTest
 
testMakeFormattableListForSignature1Arg() - Method in class ca.quine.jcommons.sourcegen.test.MethodSourceTest
 
testMakeFormattableListForSignature1Arg2Exceptions() - Method in class ca.quine.jcommons.sourcegen.test.MethodSourceTest
 
testMakeFormattableListForSignature1ArgException() - Method in class ca.quine.jcommons.sourcegen.test.MethodSourceTest
 
testMakeFormattableListForSignature2Args() - Method in class ca.quine.jcommons.sourcegen.test.MethodSourceTest
 
testMakeFormattableListForSignature2Args2Exceptions() - Method in class ca.quine.jcommons.sourcegen.test.MethodSourceTest
 
testMakeFormattableListForSignature3Args() - Method in class ca.quine.jcommons.sourcegen.test.MethodSourceTest
 
testMethodCodeLinesSpaceConversion() - Method in class ca.quine.jcommons.sourcegen.test.MethodSourceTest
Ensure tabs in code lines are correctly turned into the correct number of spaces if space indenting has been turned on.
testMethodDeclOneParam() - Method in class ca.quine.jcommons.sourcegen.test.MethodSourceTest
 
testMethodDeclOnTwoLines() - Method in class ca.quine.jcommons.sourcegen.test.MethodSourceTest
 
testMethodDeclOnTwoLinesWithThrows() - Method in class ca.quine.jcommons.sourcegen.test.MethodSourceTest
 
testMethodNoParamNoExceptions() - Method in class ca.quine.jcommons.sourcegen.test.MethodSourceTest
 
testMethodNoParams() - Method in class ca.quine.jcommons.sourcegen.test.MethodSourceTest
 
testMethodWithExceptions() - Method in class ca.quine.jcommons.sourcegen.test.MethodSourceTest
 
testMultilineComment() - Method in class ca.quine.jcommons.sourcegen.test.CommentSourceTest
 
testMultilineCommentWithHtmlParagraphBreak() - Method in class ca.quine.jcommons.sourcegen.test.CommentSourceTest
 
testMultilineCommentWithParagraphBreaks() - Method in class ca.quine.jcommons.sourcegen.test.CommentSourceTest
 
testMultipleFieldsAndMethodsWithComments() - Method in class ca.quine.jcommons.sourcegen.test.ClassSourceTest
 
testMultipleFieldsWithComments() - Method in class ca.quine.jcommons.sourcegen.test.ClassSourceTest
 
testMultipleImplements() - Method in class ca.quine.jcommons.sourcegen.test.ClassSourceTest
 
testPrepackageCommentString() - Method in class ca.quine.jcommons.sourcegen.test.JavaSourceFileTest
 
testPrepackageFile() - Method in class ca.quine.jcommons.sourcegen.test.JavaSourceFileTest
 
testSingleColumn() - Method in class ca.quine.jcommons.sourcegen.test.JavaDocCommentSourceTest
 
testSpaceHandling() - Method in class ca.quine.jcommons.sourcegen.test.FormattingRulesTest
 
testSuperClass() - Method in class ca.quine.jcommons.sourcegen.test.ClassSourceTest
 
text - Variable in class ca.quine.jcommons.sourcegen.CommentSource
 
tokenize(String) - Static method in class ca.quine.jcommons.sourcegen.FormattingUtils
 
trimRight(String) - Static method in class ca.quine.jcommons.sourcegen.FormattingUtils
 

A B C F G I J M N O P S T