StringTemplate 4 4.3.4 · org.stringtemplate.v4.AutoIndentWriter

Essentially a char filter that knows how to auto-indent output by maintaining a stack of indent levels.

The indent stack is a stack of strings so we can repeat original indent not just the same number of columns (don't have to worry about tabs vs spaces then). Anchors are char positions (tabs won't work) that indicate where all future wraps should justify to. The wrap position is actually the larger of either the last anchor or the indentation level.

This is a filter on a Writer.

\n is the proper way to say newline for options and templates. Templates can mix \r\n and \n them, but use \n in options like wrap="\n". This writer will render newline characters according to newline. The default value is taken from the line.separator system property, and can be overridden by passing in a String to the appropriate constructor.

Field Summary

Modifier and Type	Field and Description
public int[]	anchors Stack of integer anchors (char positions in line); avoid `Integer` creation overhead.
public int	anchors_sp
public boolean	atStartOfLine
public int	charIndex The absolute char index into the output of the next char to be written.
public int	charPosition Track char position in the line (later we can think about tabs).
public List<String>	indents Stack of indents.
public int	lineWidth
public String	newline `\n` or `\r\n`?
public Writer	out

Constructor Summary

Access	Constructor and Description
public	AutoIndentWriter(Writer out, String newline)
public	AutoIndentWriter(Writer out)

Method Summary

Modifier and Type	Method and Description
public int	indent()
public int	index() Implements org.stringtemplate.v4.STWriter.index. Return the absolute char index into the output of the char we're about to write.
public void	popAnchorPoint() Implements org.stringtemplate.v4.STWriter.popAnchorPoint.
public String	popIndentation() Implements org.stringtemplate.v4.STWriter.popIndentation.
public void	pushAnchorPoint() Implements org.stringtemplate.v4.STWriter.pushAnchorPoint.
public void	pushIndentation(String indent) Implements org.stringtemplate.v4.STWriter.pushIndentation.
public void	setLineWidth(int lineWidth) Implements org.stringtemplate.v4.STWriter.setLineWidth.
public int	write(String str) Implements org.stringtemplate.v4.STWriter.write. Write out a string literal or attribute expression or expression element.
public int	write(String str, String wrap) Implements org.stringtemplate.v4.STWriter.write. Write out a string literal or attribute expression or expression element.
public int	writeSeparator(String str) Implements org.stringtemplate.v4.STWriter.writeSeparator. Write a separator.
public int	writeWrap(String wrap) Implements org.stringtemplate.v4.STWriter.writeWrap. Because we evaluate ST instance by invoking `Interpreter#exec(STWriter, InstanceScope)` again, we can't pass options in. So the `Bytecode#INSTR_WRITE` instruction of an applied template (such as when we wrap in between template applications like `<data:{v\|[<v>]}; wrap>`) we need to write the `wrap` string before calling `Interpreter#exec`.

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

Field Detail

anchors	back to summary
public int[] anchors Stack of integer anchors (char positions in line); avoid `Integer` creation overhead.

anchors_sp	back to summary
public int anchors_sp

atStartOfLine	back to summary
public boolean atStartOfLine

charIndex	back to summary
public int charIndex The absolute char index into the output of the next char to be written.

charPosition	back to summary
public int charPosition Track char position in the line (later we can think about tabs). Indexed from 0. We want to keep `charPosition <=` `lineWidth`. This is the position we are about to write, not the position last written to.

indents	back to summary
public List<String> indents Stack of indents. Use `List` as it's much faster than `Stack`. Grows from 0..n-1.

lineWidth	back to summary
public int lineWidth

newline	back to summary
public String newline `\n` or `\r\n`?

out	back to summary
public Writer out

Constructor Detail

AutoIndentWriter	back to summary
public AutoIndentWriter(Writer out, String newline)

AutoIndentWriter	back to summary
public AutoIndentWriter(Writer out)

Method Detail

indent	back to summary
public int indent() throws IOException

index	back to summary
public int index() Implements org.stringtemplate.v4.STWriter.index. Doc from org.stringtemplate.v4.STWriter.index. Return the absolute char index into the output of the char we're about to write. Returns 0 if no char written yet. Annotations @Override

index

back to summary

public int index()

Implements org.stringtemplate.v4.STWriter.index.

Doc from org.stringtemplate.v4.STWriter.index.

Return the absolute char index into the output of the char we're about to write. Returns 0 if no char written yet.

Annotations

@Override

popAnchorPoint	back to summary
public void popAnchorPoint() Implements org.stringtemplate.v4.STWriter.popAnchorPoint. Annotations @Override

popAnchorPoint

back to summary

public void popAnchorPoint()

Implements org.stringtemplate.v4.STWriter.popAnchorPoint.

Annotations

@Override

popIndentation	back to summary
public String popIndentation() Implements org.stringtemplate.v4.STWriter.popIndentation. Annotations @Override

popIndentation

back to summary

public String popIndentation()

Implements org.stringtemplate.v4.STWriter.popIndentation.

Annotations

@Override

pushAnchorPoint	back to summary
public void pushAnchorPoint() Implements org.stringtemplate.v4.STWriter.pushAnchorPoint. Annotations @Override

pushAnchorPoint

back to summary

public void pushAnchorPoint()

Implements org.stringtemplate.v4.STWriter.pushAnchorPoint.

Annotations

@Override

pushIndentation	back to summary
public void pushIndentation(String indent) Implements org.stringtemplate.v4.STWriter.pushIndentation. Annotations @Override

pushIndentation

back to summary

public void pushIndentation(String indent)

Implements org.stringtemplate.v4.STWriter.pushIndentation.

Annotations

@Override

setLineWidth	back to summary
public void setLineWidth(int lineWidth) Implements org.stringtemplate.v4.STWriter.setLineWidth. Annotations @Override

setLineWidth

back to summary

public void setLineWidth(int lineWidth)

Implements org.stringtemplate.v4.STWriter.setLineWidth.

Annotations

@Override

write	back to summary
public int write(String str) throws IOException Implements org.stringtemplate.v4.STWriter.write. Write out a string literal or attribute expression or expression element. Annotations @Override

write

back to summary

public int write(String str) throws IOException

Implements org.stringtemplate.v4.STWriter.write.

Write out a string literal or attribute expression or expression element.

Annotations

@Override

write back to summary

write	back to summary
public int write(String str, String wrap) throws IOException Implements org.stringtemplate.v4.STWriter.write. Write out a string literal or attribute expression or expression element. If doing line wrap, then check `wrap` before emitting `str`. If at or beyond desired line width then emit a `newline` and any indentation before spitting out `str`. Annotations @Override

public int write(String str, String wrap) throws IOException

Implements org.stringtemplate.v4.STWriter.write.

Write out a string literal or attribute expression or expression element.

If doing line wrap, then check wrap before emitting str. If at or beyond desired line width then emit a newline and any indentation before spitting out str.

Annotations

@Override

writeSeparator back to summary

writeSeparator	back to summary
public int writeSeparator(String str) throws IOException Implements org.stringtemplate.v4.STWriter.writeSeparator. Doc from org.stringtemplate.v4.STWriter.writeSeparator. Write a separator. Same as `write(String)` except that a `"\n"` cannot be inserted before emitting a separator. Annotations @Override

public int writeSeparator(String str) throws IOException

Implements org.stringtemplate.v4.STWriter.writeSeparator.

Doc from org.stringtemplate.v4.STWriter.writeSeparator.

Write a separator. Same as write(String) except that a "\n" cannot be inserted before emitting a separator.

Annotations

@Override

writeWrap back to summary

writeWrap	back to summary
public int writeWrap(String wrap) throws IOException Implements org.stringtemplate.v4.STWriter.writeWrap. Doc from org.stringtemplate.v4.STWriter.writeWrap. Because we evaluate ST instance by invoking `Interpreter#exec(STWriter, InstanceScope)` again, we can't pass options in. So the `Bytecode#INSTR_WRITE` instruction of an applied template (such as when we wrap in between template applications like `<data:{v\|[<v>]}; wrap>`) we need to write the `wrap` string before calling `Interpreter#exec`. We expose just like for the separator. See `Interpreter#writeObject` where it checks for ST instance. If POJO, `Interpreter#writePOJO` passes `wrap` to `STWriter#write(String str, String wrap)`. Can't pass to `Interpreter#exec`. Annotations @Override

public int writeWrap(String wrap) throws IOException

Implements org.stringtemplate.v4.STWriter.writeWrap.

Doc from org.stringtemplate.v4.STWriter.writeWrap.

Because we evaluate ST instance by invoking Interpreter#exec(STWriter, InstanceScope) again, we can't pass options in. So the Bytecode#INSTR_WRITE instruction of an applied template (such as when we wrap in between template applications like <data:{v|[<v>]}; wrap>) we need to write the wrap string before calling Interpreter#exec. We expose just like for the separator. See Interpreter#writeObject where it checks for ST instance. If POJO, Interpreter#writePOJO passes wrap to STWriter#write(String str, String wrap). Can't pass to Interpreter#exec.

Annotations

@Override

public Class AutoIndentWriter

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail