Package org.exolab.javasource
Class JSourceWriter
java.lang.Object
java.io.Writer
org.exolab.javasource.JSourceWriter
- All Implemented Interfaces:
Closeable
,Flushable
,Appendable
,AutoCloseable
The writer used by the javasource classes.
- Version:
- $Revision: 8011 $ $Date: 2005-03-30 03:29:24 -0700 (Wed, 30 Mar 2005) $
- Author:
- Keith Visco
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final char
The default character to use for indentation.static final short
The default indentation size. -
Constructor Summary
ConstructorsConstructorDescriptionJSourceWriter
(Writer out) Creates a new JSourceWriter.JSourceWriter
(Writer out, boolean autoflush) Creates a new JSourceWriter.JSourceWriter
(Writer out, short tabSize, boolean autoflush) Creates a new JSourceWriter.JSourceWriter
(Writer out, short tabSize, char tabChar, boolean autoflush) Creates a new JSourceWriter. -
Method Summary
Modifier and TypeMethodDescriptionvoid
close()
void
flush()
protected char
Returns the current character used for indentation.protected short
Returns the current indentation level.protected short
Returns the current indent size (getIndentLevel()*tabSize).Returns the line separator being used by this JSourceWriter.void
indent()
Increases the indentation level by 1.boolean
Checks to see if the cursor is positioned on a new line.void
setLineSeparator
(String lineSeparator) Sets the line separator to use at the end of each line.void
unindent()
Decreases the indentation level by 1.void
write
(boolean b) void
write
(char[] buf) void
write
(char[] buf, int off, int len) void
write
(double d) void
write
(float f) void
write
(int c) void
write
(long l) void
void
void
protected void
Always applies the current indentation.void
writeln()
void
writeln
(boolean b) void
writeln
(char c) void
writeln
(char[] chars) void
writeln
(double d) void
writeln
(float f) void
writeln
(int i) void
writeln
(long l) void
void
Methods inherited from class java.io.Writer
append, append, append, nullWriter
-
Field Details
-
DEFAULT_CHAR
public static final char DEFAULT_CHARThe default character to use for indentation.- See Also:
-
DEFAULT_SIZE
public static final short DEFAULT_SIZEThe default indentation size.- See Also:
-
-
Constructor Details
-
JSourceWriter
Creates a new JSourceWriter.- Parameters:
out
- The Writer to write the actual output to.
-
JSourceWriter
Creates a new JSourceWriter.- Parameters:
out
- The Writer to write the actual output to.autoflush
- A boolean indicating whether or not to perform automatic flush at the end of a line.
-
JSourceWriter
Creates a new JSourceWriter.- Parameters:
out
- The Writer to write the actual output to.tabSize
- The size of each indentation.autoflush
- A boolean indicating whether or not to perform automatic flush at the end of a line.
-
JSourceWriter
Creates a new JSourceWriter.- Parameters:
out
- The Writer to write the actual output to.tabSize
- The size of each indentation.tabChar
- The character to use for indentation.autoflush
- A boolean indicating whether or not to perform an automatic flush at the end of each line.
-
-
Method Details
-
getLineSeparator
Returns the line separator being used by this JSourceWriter.- Returns:
- The line separator being used by this JSourceWriter.
-
indent
public void indent()Increases the indentation level by 1. -
isNewline
public boolean isNewline()Checks to see if the cursor is positioned on a new line.- Returns:
- True if the cursor is at the start of a new line, otherwise false.
-
setLineSeparator
Sets the line separator to use at the end of each line. Typically a line separator will be one of the following:- "\r\n" for MS Windows
- "\n" for UNIX
- "\r" for Macintosh
- Parameters:
lineSeparator
- The String to use as a line separator.
-
unindent
public void unindent()Decreases the indentation level by 1. -
getIndentLevel
protected short getIndentLevel()Returns the current indentation level.- Returns:
- The current indentation level.
-
getIndentSize
protected short getIndentSize()Returns the current indent size (getIndentLevel()*tabSize).- Returns:
- The current indent size.
-
getIndentChar
protected char getIndentChar()Returns the current character used for indentation.- Returns:
- The current character used for indentation.
-
writeIndent
protected void writeIndent()Always applies the current indentation. -
write
public void write(float f) -
write
public void write(long l) -
write
public void write(double d) -
write
-
write
public void write(boolean b) -
writeln
public void writeln() -
writeln
public void writeln(float f) -
writeln
public void writeln(long l) -
writeln
public void writeln(int i) -
writeln
public void writeln(double d) -
writeln
-
writeln
-
writeln
public void writeln(char[] chars) -
writeln
public void writeln(boolean b) -
writeln
public void writeln(char c) -
close
public void close() -
flush
public void flush() -
write
-
write
-
write
public void write(char[] buf) -
write
public void write(int c) -
write
public void write(char[] buf, int off, int len)
-