com.helger.jcodemodel

Class JFormatter

java.lang.Object

com.helger.jcodemodel.JFormatter

All Implemented Interfaces:

Closeable, AutoCloseable

@NotThreadSafe
public class JFormatter
extends Object
implements Closeable

This is a utility class for managing indentation and other basic formatting for PrintWriter.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_INDENT_SPACE

Constructor Summary

Constructors

Constructor and Description
JFormatter(PrintWriter aPW) Creates a formatter with default incremental indentations of four spaces.
JFormatter(PrintWriter aPW, String sIndentSpace) Creates a JFormatter.
JFormatter(Writer aWriter) Creates a formatter with default incremental indentations of four spaces.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Closes this formatter.
static boolean	containsErrorTypes(JDefinedClass c)
JFormatter	declaration(IJDeclaration d) Cause the JDeclaration to generate source for itself
JFormatter	generable(Collection<? extends IJGenerable> list) Produces IJGenerables separated by ','
JFormatter	generable(IJGenerable g) Cause the JGenerable object to generate source for iteself
JFormatter	id(String id) Print an identifier
JFormatter	indent() Increment the indentation level.
boolean	isPrinting()
JFormatter	newline() Print a new line into the stream
JFormatter	outdent() Decrement the indentation level.
JFormatter	print(char c) Print a char into the stream
JFormatter	print(String s) Print a String into the stream
JFormatter	statement(IJStatement s) Cause the JStatement to generate source for itself
JFormatter	type(AbstractJClass aType) Print a type name.
JFormatter	type(AbstractJType aType)
JFormatter	var(JVar v) Cause the JVar to generate source for itself

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_INDENT_SPACE

public static final String DEFAULT_INDENT_SPACE

See Also:

Constant Field Values

Constructor Detail

JFormatter

public JFormatter(@Nonnull
          PrintWriter aPW,
          @Nonnull
          String sIndentSpace)

Creates a JFormatter.

Parameters:

aPW - PrintWriter to JFormatter to use. May not be null.

sIndentSpace - Incremental indentation string, similar to tab value. May not be null.

JFormatter

public JFormatter(@Nonnull
          PrintWriter aPW)

Creates a formatter with default incremental indentations of four spaces.

Parameters:

aPW - The PrintWriter to use

JFormatter

public JFormatter(@Nonnull
          Writer aWriter)

Creates a formatter with default incremental indentations of four spaces.

Parameters:

aWriter - The Writer to be wrapped in a PrintWriter

Method Detail

close

public void close()

Closes this formatter.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

isPrinting

public boolean isPrinting()

Returns:

true if we are in the printing mode, where we actually produce text. The other mode is the "collecting mode'

outdent

@Nonnull
public JFormatter outdent()

Decrement the indentation level.

Returns:

this for chaining

indent

@Nonnull
public JFormatter indent()

Increment the indentation level.

Returns:

this for chaining

print

@Nonnull
public JFormatter print(char c)

Print a char into the stream

Parameters:

c - the char

Returns:

this for chaining

print

@Nonnull
public JFormatter print(@Nonnull
                       String s)

Print a String into the stream

Parameters:

s - the String

Returns:

this

type

@Nonnull
public JFormatter type(@Nonnull
                      AbstractJType aType)

type

@Nonnull
public JFormatter type(@Nonnull
                      AbstractJClass aType)

Print a type name.

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

Parameters:

aType - Type to be emitted

Returns:

this for chaining

id

@Nonnull
public JFormatter id(@Nonnull
                    String id)

Print an identifier

Parameters:

id - identifier

Returns:

this for chaining

newline

@Nonnull
public JFormatter newline()

Print a new line into the stream

Returns:

this for chaining

generable

@Nonnull
public JFormatter generable(@Nonnull
                           IJGenerable g)

Cause the JGenerable object to generate source for iteself

Parameters:

g - the JGenerable object

Returns:

this for chaining

generable

@Nonnull
public JFormatter generable(@Nonnull
                           Collection<? extends IJGenerable> list)

Produces IJGenerables separated by ','

Parameters:

list - List of IJGenerable objects that will be separated by a comma

Returns:

this for chaining

declaration

@Nonnull
public JFormatter declaration(@Nonnull
                             IJDeclaration d)

Cause the JDeclaration to generate source for itself

Parameters:

d - the JDeclaration object

Returns:

this for chaining

statement

@Nonnull
public JFormatter statement(@Nonnull
                           IJStatement s)

Cause the JStatement to generate source for itself

Parameters:

s - the JStatement object

Returns:

this for chaining

var

@Nonnull
public JFormatter var(@Nonnull
                     JVar v)

Cause the JVar to generate source for itself

Parameters:

v - the JVar object

Returns:

this for chaining

containsErrorTypes

public static boolean containsErrorTypes(@Nonnull
                         JDefinedClass c)