xapi.dev.source

Class FieldBuffer

java.lang.Object

xapi.dev.source.CharBuffer

xapi.dev.source.PrintBuffer

xapi.dev.source.MemberBuffer<FieldBuffer>

xapi.dev.source.FieldBuffer

public class FieldBuffer
extends MemberBuffer<FieldBuffer>

A field buffer is used to add a field to a generated class. The field definition itself is exported during .toString(), but this buffer also exposes functionality to auto-generate getter, setter, adder, remover and clear methods. The current implementation translates arrays in return types into ArrayList that returns .toArray() copies of elements. This allows you to implement a varargs setter (which clears before add), and varargs adders and removers.

Author:

"James X. Nelson (james@wetheinter.net)"

Nested Class Summary

Nested classes/interfaces inherited from class xapi.dev.source.CharBuffer

CharBuffer.CharBufferStack

Field Summary

Fields inherited from class xapi.dev.source.MemberBuffer

annotations, generics, javaDoc, modifier, origIndent

Fields inherited from class xapi.dev.source.PrintBuffer

indented

Fields inherited from class xapi.dev.source.CharBuffer

indent

Constructor Summary

Constructors

Constructor and Description
FieldBuffer(ClassBuffer enclosingClass, String type, String name)
FieldBuffer(ClassBuffer enclosingClass, String type, String name, String indent)

Method Summary

Modifier and Type	Method and Description
MethodBuffer	addAdder()
MethodBuffer	addClearer()
MethodBuffer	addGetter(int modifiers)
String	addImport(Class<?> cls)
String	addImport(String cls)
String	addImportStatic(Class<?> cls, String name)
String	addImportStatic(String cls)
MethodBuffer	addSetter(int modifier)
protected String	fluentReturnType()
protected String	fluentReturnValue()
PrintBuffer	getInitializer()
String	getName()
String	getSimpleType()
protected String	getterName()
protected MethodBuffer	initAdder()
protected MethodBuffer	initClearer()
protected JavaVisitor.TypeData	initGenerator(JavaVisitor.TypeData originalType)
protected MethodBuffer	initGetter()
protected MethodBuffer	initRemover()
protected MethodBuffer	initSetter()
boolean	isFluent()
FieldBuffer	remover()
FieldBuffer	setExactName(boolean exact)
FieldBuffer	setFluent(boolean fluent)
FieldBuffer	setInitializer(String initializer)
protected String	setterName()
String	toString()

Methods inherited from class xapi.dev.source.MemberBuffer

addAnnotation, addAnnotation, addGenerics, addImports, addImports, addNamedTypes, addNamedTypes, addTypes, addTypes, append, append, append, append, append, append, append, append, append, append, append, append, createJavadoc, indent, indentln, indentln, indentln, indentln, isAbstract, isFinal, isStatic, makeAbstract, makeConcrete, makeFinal, makePackageProtected, makePrivate, makeProtected, makePublic, makeStatic, outdent, print, println, println, println, println, println, setJavadoc, setModifier

Methods inherited from class xapi.dev.source.PrintBuffer

clearIndent, footer, header, isEmpty, isNotEmpty, join, printBefore, setNotIndent

Methods inherited from class xapi.dev.source.CharBuffer

addToBeginning, addToEnd, clear, newChild, newChild, onAppend, printAfter

Methods inherited from class java.lang.Object

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

Constructor Detail

FieldBuffer

public FieldBuffer(ClassBuffer enclosingClass,
                   String type,
                   String name)

FieldBuffer

public FieldBuffer(ClassBuffer enclosingClass,
                   String type,
                   String name,
                   String indent)

Method Detail

addAdder

public MethodBuffer addAdder()

addClearer

public MethodBuffer addClearer()

addGetter

public MethodBuffer addGetter(int modifiers)

addImport

public String addImport(Class<?> cls)

Specified by:

addImport in class MemberBuffer<FieldBuffer>

addImport

public String addImport(String cls)

Specified by:

addImport in class MemberBuffer<FieldBuffer>

addImportStatic

public String addImportStatic(Class<?> cls,
                              String name)

Specified by:

addImportStatic in class MemberBuffer<FieldBuffer>

addImportStatic

public String addImportStatic(String cls)

Specified by:

addImportStatic in class MemberBuffer<FieldBuffer>

addSetter

public MethodBuffer addSetter(int modifier)

getInitializer

public PrintBuffer getInitializer()

getName

public String getName()

getSimpleType

public String getSimpleType()

isFluent

public boolean isFluent()

remover

public FieldBuffer remover()

setExactName

public FieldBuffer setExactName(boolean exact)

setFluent

public FieldBuffer setFluent(boolean fluent)

setInitializer

public FieldBuffer setInitializer(String initializer)

toString

public String toString()

Overrides:

toString in class PrintBuffer

fluentReturnType

protected String fluentReturnType()

fluentReturnValue

protected String fluentReturnValue()

getterName

protected String getterName()

initAdder

protected MethodBuffer initAdder()

initClearer

protected MethodBuffer initClearer()

initGenerator

protected JavaVisitor.TypeData initGenerator(JavaVisitor.TypeData originalType)

initGetter

protected MethodBuffer initGetter()

initRemover

protected MethodBuffer initRemover()

initSetter

protected MethodBuffer initSetter()

setterName

protected String setterName()