Package org.codehaus.janino.util

Class AutoIndentWriter

java.lang.Object

java.io.Writer

java.io.FilterWriter

org.codehaus.janino.util.AutoIndentWriter

All Implemented Interfaces:

Closeable, Flushable, Appendable, AutoCloseable

public class AutoIndentWriter
extends FilterWriter

A FilterWriter that automatically indents lines by looking at trailing opening braces ('{') and leading closing braces ('}').

Field Summary

Fields

Modifier and Type	Field	Description
static final char	CLEAR_TABULATORS	Special character indicating to clear all tabluar layout that was configured through TABULATOR.
static final char	INDENT	Special character that inserts a line break and indents the following text by one position.
private int	indentation
private final StringBuilder	lineBuffer
static final char	TABULATOR	Special character indicating a tabular layout of the following text.
private List<StringBuilder>	tabulatorBuffer
private int	tabulatorIndentation
static final char	UNINDENT	Special character that inserts a line break and unindents the following text by one position.

Fields inherited from class java.io.FilterWriter

out

Fields inherited from class java.io.Writer

lock

Constructor Summary

Constructors

Constructor	Description
AutoIndentWriter(Writer out)

Method Summary

Modifier and Type	Method	Description
void	close()
void	flush()
private void	flushTabulatorBuffer()
private void	line(String line)
private static void	resolveTabs(List<StringBuilder> lineGroup)	Expands all TABULATORs in the given List of StringBuilders with spaces, so that the characters immediately following the TABULATORs are vertically aligned, like this:
private static String	spaces(int n)
void	write(char[] cbuf, int off, int len)
void	write(int c)
void	write(String str, int off, int len)

Methods inherited from class java.io.Writer

append, append, append, nullWriter, write, write

Methods inherited from class java.lang.Object

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

Field Details

TABULATOR

public static final char TABULATOR

Special character indicating a tabular layout of the following text.

See Also:

• Constant Field Values

CLEAR_TABULATORS

public static final char CLEAR_TABULATORS

Special character indicating to clear all tabluar layout that was configured through TABULATOR.

See Also:

• Constant Field Values

INDENT

public static final char INDENT

Special character that inserts a line break and indents the following text by one position.

See Also:

• Constant Field Values

UNINDENT

public static final char UNINDENT

Special character that inserts a line break and unindents the following text by one position.

See Also:

• Constant Field Values

lineBuffer

private final StringBuilder lineBuffer

indentation

private int indentation

tabulatorBuffer

@Nullable
private List<StringBuilder> tabulatorBuffer

tabulatorIndentation

private int tabulatorIndentation

Constructor Details

AutoIndentWriter

public AutoIndentWriter(Writer out)

Method Details

write

public void write(@Nullable
 char[] cbuf,
 int off,
 int len)
           throws IOException

Overrides:

write in class FilterWriter

Throws:

IOException

write

public void write(@Nullable
 String str,
 int off,
 int len)
           throws IOException

Overrides:

write in class FilterWriter

Throws:

IOException

write

public void write(int c)
           throws IOException

Overrides:

write in class FilterWriter

Throws:

IOException

line

private void line(String line)
           throws IOException

Throws:

IOException

flushTabulatorBuffer

private void flushTabulatorBuffer()
                           throws IOException

Throws:

IOException

resolveTabs

private static void resolveTabs(List<StringBuilder> lineGroup)

Expands all TABULATORs in the given List of StringBuilders with spaces, so that the characters immediately following the TABULATORs are vertically aligned, like this:

Input:

   a @b @c\r\n
   aa @bb @cc\r\n
   aaa @bbb @ccc\r\n
 

Output:

   a   b   c\r\n
   aa  bb  cc\r\n
   aaa bbb ccc\r\n
 

spaces

private static String spaces(int n)

Returns:

a String of n spaces

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class FilterWriter

Throws:

IOException

flush

public void flush()
           throws IOException

Specified by:

flush in interface Flushable

Overrides:

flush in class FilterWriter

Throws:

IOException