Modifier and Type	Class and Description
private static enum	JFormatter.Mode
pack-priv class	JFormatter.ReferenceList Used during the optimization of class imports.

Field Summary

Modifier and Type	Field and Description
private boolean	atBeginningOfLine
private final Map<String, String>	classNameReplacer
pack-priv static final char	CLOSE_TYPE_ARGS Special character token we use to differentiate '>' as an operator and '>' as the end of the type arguments.
private HashMap<String, JFormatter.ReferenceList>	collectedReferences
private HashSet<JClass>	importedClasses set of imported types (including package java types, eventhough we won't generate imports for them)
private int	indentLevel Current number of indentation strings to print
private final String	indentSpace String to be used for each indentation.
private JPackage	javaLang
private char	lastChar
private JFormatter.Mode	mode The current running mode.
private final PrintWriter	pw Stream associated with this JFormatter

Constructor Summary

Access	Constructor and Description
public	JFormatter(PrintWriter PrintWriter to JFormatter to use. s, String Incremental indentation string, similar to tab value. space) Creates a JFormatter.
public	JFormatter(PrintWriter PrintWriter to JFormatter to use. s, String Incremental indentation string, similar to tab value. space, Map<String, String> Class names to replace. classNameReplacer) Creates a JFormatter.
public	JFormatter(PrintWriter s) Creates a formatter with default incremental indentations of four spaces.
public	JFormatter(PrintWriter s, Map<String, String> classNameReplacer) Creates a formatter with default incremental indentations of four spaces and replaces the class names in classNameReplacer.
public	JFormatter(Writer w) Creates a formatter with default incremental indentations of four spaces.

Method Summary

Modifier and Type	Method and Description
public JFormatter	b(JVar the JVar object v) Cause the JVar to generate source for itself
public void	close() Closes this formatter.
public JFormatter	d(JDeclaration the JDeclaration object d) Cause the JDeclaration to generate source for itself
public JFormatter	g(JGenerable the JGenerable object g) Cause the JGenerable object to generate source for iteself
public JFormatter	g(Collection<? extends JGenerable> list) Produces `JGenerable`s separated by ','
public JFormatter	i() Increment the indentation level.
public JFormatter	id(String id) Print an identifier
public boolean	isPrinting() Returns true if we are in the printing mode, where we actually produce text.
private boolean	needSpace(char c1, char c2)
public JFormatter	nl() Print a new line into the stream
public JFormatter	o() Decrement the indentation level.
public JFormatter	p(char the char c) Print a char into the stream
public JFormatter	p(String the String s) Print a String into the stream
private String	renameClassName(String fullName)
public JFormatter	s(JStatement the JStatement object s) Cause the JStatement to generate source for itself
private void	spaceIfNeeded(char c)
private boolean	Returns: true if an import statement should be suppressed, false otherwise supressImport(JClass JType that may or may not have an import clazz, JClass JType that is the current class being processed c) determine if an import statement should be supressed
public JFormatter	t(JType type)
public JFormatter	t(JClass type) Print a type name.
pack-priv void	write(JDefinedClass c) Generates the whole source code out of the specified class.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

atBeginningOfLine	back to summary
private boolean atBeginningOfLine

classNameReplacer	back to summary
private final Map<String, String> classNameReplacer

CLOSE_TYPE_ARGS	back to summary
pack-priv static final char CLOSE_TYPE_ARGS Special character token we use to differentiate '>' as an operator and '>' as the end of the type arguments. The former uses '>' and it requires a preceding whitespace. The latter uses this, and it does not have a preceding whitespace.

collectedReferences	back to summary
private HashMap<String, JFormatter.ReferenceList> collectedReferences

importedClasses	back to summary
private HashSet<JClass> importedClasses set of imported types (including package java types, eventhough we won't generate imports for them)

indentLevel	back to summary
private int indentLevel Current number of indentation strings to print

indentSpace	back to summary
private final String indentSpace String to be used for each indentation. Defaults to four spaces.

javaLang	back to summary
private JPackage javaLang

lastChar	back to summary
private char lastChar

mode	back to summary
private JFormatter.Mode mode The current running mode. Set to PRINTING so that a casual client can use a formatter just like before.

pw	back to summary
private final PrintWriter pw Stream associated with this JFormatter

Constructor Detail

JFormatter	back to summary
public JFormatter(PrintWriter s, String space) Creates a JFormatter. Parameters s:PrintWriter PrintWriter to JFormatter to use. space:String Incremental indentation string, similar to tab value.

JFormatter

back to summary

public JFormatter(PrintWriter s, String space)

Creates a JFormatter.

Parameters

s:PrintWriter: PrintWriter to JFormatter to use.
space:String: Incremental indentation string, similar to tab value.

JFormatter	back to summary
public JFormatter(PrintWriter s, String space, Map<String, String> classNameReplacer) Creates a JFormatter. Parameters s:PrintWriter PrintWriter to JFormatter to use. space:String Incremental indentation string, similar to tab value. classNameReplacer:Map<String, String> Class names to replace.

JFormatter

back to summary

public JFormatter(PrintWriter s, String space, Map<String, String> classNameReplacer)

Creates a JFormatter.

Parameters

s:PrintWriter: PrintWriter to JFormatter to use.
space:String: Incremental indentation string, similar to tab value.
classNameReplacer:Map<String, String>: Class names to replace.

JFormatter	back to summary
public JFormatter(PrintWriter s) Creates a formatter with default incremental indentations of four spaces.

JFormatter	back to summary
public JFormatter(PrintWriter s, Map<String, String> classNameReplacer) Creates a formatter with default incremental indentations of four spaces and replaces the class names in classNameReplacer.

JFormatter	back to summary
public JFormatter(Writer w) Creates a formatter with default incremental indentations of four spaces.

Method Detail

b	back to summary
public JFormatter b(JVar v) Cause the JVar to generate source for itself Parameters v:JVar the JVar object

back to summary

public JFormatter b(JVar v)

Cause the JVar to generate source for itself

Parameters

v:JVar: the JVar object

close	back to summary
public void close() Closes this formatter.

d	back to summary
public JFormatter d(JDeclaration d) Cause the JDeclaration to generate source for itself Parameters d:JDeclaration the JDeclaration object

back to summary

public JFormatter d(JDeclaration d)

Cause the JDeclaration to generate source for itself

Parameters

d:JDeclaration: the JDeclaration object

g	back to summary
public JFormatter g(JGenerable g) Cause the JGenerable object to generate source for iteself Parameters g:JGenerable the JGenerable object

back to summary

public JFormatter g(JGenerable g)

Cause the JGenerable object to generate source for iteself

Parameters

g:JGenerable: the JGenerable object

g	back to summary
public JFormatter g(Collection<? extends JGenerable> list) Produces `JGenerable`s separated by ','

i	back to summary
public JFormatter i() Increment the indentation level.

id	back to summary
public JFormatter id(String id) Print an identifier

isPrinting	back to summary
public boolean isPrinting() Returns true if we are in the printing mode, where we actually produce text. The other mode is the "collecting mode'

needSpace	back to summary
private boolean needSpace(char c1, char c2)

nl	back to summary
public JFormatter nl() Print a new line into the stream

o	back to summary
public JFormatter o() Decrement the indentation level.

p	back to summary
public JFormatter p(char c) Print a char into the stream Parameters c:char the char

back to summary

public JFormatter p(char c)

Print a char into the stream

Parameters

c:char: the char

p	back to summary
public JFormatter p(String s) Print a String into the stream Parameters s:String the String

back to summary

public JFormatter p(String s)

Print a String into the stream

Parameters

s:String: the String

renameClassName	back to summary
private String renameClassName(String fullName)

s	back to summary
public JFormatter s(JStatement s) Cause the JStatement to generate source for itself Parameters s:JStatement the JStatement object

back to summary

public JFormatter s(JStatement s)

Cause the JStatement to generate source for itself

Parameters

s:JStatement: the JStatement object

spaceIfNeeded	back to summary
private void spaceIfNeeded(char c)

supressImport	back to summary
private boolean supressImport(JClass clazz, JClass c) determine if an import statement should be supressed Parameters clazz:JClass JType that may or may not have an import c:JClass JType that is the current class being processed Returns:boolean true if an import statement should be suppressed, false otherwise

supressImport

back to summary

private boolean supressImport(JClass clazz, JClass c)

determine if an import statement should be supressed

Parameters

clazz:JClass: JType that may or may not have an import
c:JClass: JType that is the current class being processed

Returns:boolean

true if an import statement should be suppressed, false otherwise

t	back to summary
public JFormatter t(JType type)

t	back to summary
public JFormatter t(JClass type) Print a type name. In the collecting mode we use this information to decide what types to import and what not to.

back to summary

public JFormatter t(JClass type)

Print a type name.

In the collecting mode we use this information to decide what types to import and what not to.

write	back to summary
pack-priv void write(JDefinedClass c) Generates the whole source code out of the specified class.

com.sun.codemodel back to summary

private final Enum JFormatter.Mode

Class Inheritance

extends Enum<JFormatter.Mode>

java.lang.Object
java.lang.Enum
com.sun.codemodel.JFormatter.Mode

Field Summary

Modifier and Type	Field and Description
public static final JFormatter.Mode	COLLECTING Collect all the type names and identifiers.
public static final JFormatter.Mode	PRINTING Print the actual source code.

Constructor Summary

Access	Constructor and Description
private	Mode()

Method Summary

Modifier and Type	Method and Description
public static JFormatter.Mode	valueOf(String name)
public static JFormatter.Mode[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

COLLECTING	back to summary
public static final JFormatter.Mode COLLECTING Collect all the type names and identifiers. In this mode we don't actually generate anything.

PRINTING	back to summary
public static final JFormatter.Mode PRINTING Print the actual source code.

Constructor Detail

Mode	back to summary
private Mode()

Method Detail

valueOf	back to summary
public static JFormatter.Mode valueOf(String name)

values	back to summary
public static JFormatter.Mode[] values()

com.sun.codemodel back to summary

pack-priv final Class JFormatter.ReferenceList

Class Inheritance

extends Object

java.lang.Object
com.sun.codemodel.JFormatter.ReferenceList

Used during the optimization of class imports. List of JClasses whose short name is the same.

Author: [email protected]

Field Summary

Modifier and Type	Field and Description
private final ArrayList<JClass>	classes
private boolean	id true if this name is used as an identifier (like a variable name.)

Constructor Summary

Access	Constructor and Description
pack-priv	ReferenceList()

Method Summary

Modifier and Type	Method and Description
public void	add(JClass clazz)
public boolean	collisions(JDefinedClass enclosingClass) Returns true if the symbol represented by the short name is "importable".
public List<JClass>	getClasses()
public boolean	isId() Return true iff this is strictly an id, meaning that there are no collisions with type names.
public void	setId(boolean value)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

classes	back to summary
private final ArrayList<JClass> classes

id	back to summary
private boolean id true if this name is used as an identifier (like a variable name.)

Constructor Detail

ReferenceList	back to summary
pack-priv ReferenceList()

Method Detail

add	back to summary
public void add(JClass clazz)

collisions	back to summary
public boolean collisions(JDefinedClass enclosingClass) Returns true if the symbol represented by the short name is "importable".

getClasses	back to summary
public List<JClass> getClasses()

isId	back to summary
public boolean isId() Return true iff this is strictly an id, meaning that there are no collisions with type names.

setId	back to summary
public void setId(boolean value)

public final Class JFormatter

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Enum JFormatter.Mode

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv final Class JFormatter.ReferenceList

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail