org.exolab.javasource

Class JSourceCode

java.lang.Object

org.exolab.javasource.JSourceCode

public final class JSourceCode
extends java.lang.Object

A class for holding in-memory Java source code.

Version:

$Revision: 6324 $ $Date: 2005-03-05 06:42:06 -0700 (Sat, 05 Mar 2005) $

Author:

Keith Visco

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_INDENT_SIZE Default indentation size.

Constructor Summary

Constructors

Constructor and Description
JSourceCode() Creates an empty JSourceCode.
JSourceCode(java.lang.String sourceCode) Creates a JSourceCode and adds the given String to its contents.

Method Summary

Modifier and Type	Method and Description
void	add(java.lang.String statement) Adds the given statement to this JSourceCode.
void	add(java.lang.String statement, short indentSize) Adds the given statement to this JSourceCode.
void	addIndented(java.lang.String statement) Adds the given statement to this JSourceCode.
void	append(java.lang.String segment) Appends the given String to the last line in this JSourceCode.
void	clear() Clears all the code statements from this JSourceCode.
void	copyInto(JSourceCode jsc) Copies the contents of this JSourceCode into the given JSourceCode.
void	indent() Increases the current indent level by 1.
boolean	isEmpty() Returns true if this JSourceCode is empty (ie.
void	print(JSourceWriter jsw) Prints this JSourceCode to the given JSourceWriter.
java.lang.String	toString() Returns the String representation of this JSourceCode.
void	unindent() Decreases the indent level by 1.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_INDENT_SIZE

public static final int DEFAULT_INDENT_SIZE

Default indentation size.

See Also:

Constant Field Values

Constructor Detail

JSourceCode

public JSourceCode()

Creates an empty JSourceCode.

JSourceCode

public JSourceCode(java.lang.String sourceCode)

Creates a JSourceCode and adds the given String to its contents.

Parameters:

sourceCode - the source to add

Method Detail

add

public void add(java.lang.String statement)

Adds the given statement to this JSourceCode. The statement will be added on a new line.

Parameters:

statement - the statement to add

add

public void add(java.lang.String statement,
                short indentSize)

Adds the given statement to this JSourceCode. The statement will be added on a new line.

Parameters:

statement - the statement to add

indentSize - indentSize is the size of the indentation to use when printing this JSourceCode

See Also:

print(JSourceWriter)

addIndented

public void addIndented(java.lang.String statement)

Adds the given statement to this JSourceCode. The statement will be added on a new line and added with increased indent. This is a convenience method for the sequence: indent(); add(statement); unindent();

Parameters:

statement - the statement to add

append

public void append(java.lang.String segment)

Appends the given String to the last line in this JSourceCode.

Parameters:

segment - the String to append

clear

public void clear()

Clears all the code statements from this JSourceCode.

copyInto

public void copyInto(JSourceCode jsc)

Copies the contents of this JSourceCode into the given JSourceCode.

Parameters:

jsc - the JSourceCode to copy this JSourceCode into

indent

public void indent()

Increases the current indent level by 1.

isEmpty

public boolean isEmpty()

Returns true if this JSourceCode is empty (ie. no source).

Returns:

true if this JSourceCode is empty.

print

public void print(JSourceWriter jsw)

Prints this JSourceCode to the given JSourceWriter.

Parameters:

jsw - the JSourceWriter to print to

unindent

public void unindent()

Decreases the indent level by 1.

toString

public java.lang.String toString()

Returns the String representation of this JSourceCode.

Overrides:

toString in class java.lang.Object

Returns:

the String representation of this JSourceCode.