StringTemplate 4 4.3.4 · org.stringtemplate.v4.STWriter

Modifier and Type	Field and Description
public static final int	NO_WRAP

Method Summary

Modifier and Type	Method and Description
public int	index() Return the absolute char index into the output of the char we're about to write.
public void	popAnchorPoint()
public String	popIndentation()
public void	pushAnchorPoint()
public void	pushIndentation(String indent)
public void	setLineWidth(int lineWidth)
public int	write(String str) Write the string and return how many actual characters were written.
public int	write(String str, String wrap) Same as write, but wrap lines using the indicated string as the wrap character (such as `"\n"`).
public int	writeSeparator(String str) Write a separator.
public int	writeWrap(String wrap) 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`.

NO_WRAP	back to summary
public static final int NO_WRAP

index	back to summary
public int index() Return the absolute char index into the output of the char we're about to write. Returns 0 if no char written yet.

popAnchorPoint	back to summary
public void popAnchorPoint()

popIndentation	back to summary
public String popIndentation()

pushAnchorPoint	back to summary
public void pushAnchorPoint()

pushIndentation	back to summary
public void pushIndentation(String indent)

setLineWidth	back to summary
public void setLineWidth(int lineWidth)

write	back to summary
public int write(String str) throws IOException Write the string and return how many actual characters were written. With auto-indentation and wrapping, more chars than `str.length()` can be emitted. No wrapping is done.

write	back to summary
public int write(String str, String wrap) throws IOException Same as write, but wrap lines using the indicated string as the wrap character (such as `"\n"`).

writeSeparator	back to summary
public int writeSeparator(String str) throws IOException Write a separator. Same as `write(String)` except that a `"\n"` cannot be inserted before emitting a separator.

writeWrap back to summary

writeWrap	back to summary
public int writeWrap(String wrap) throws IOException 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`.

public int writeWrap(String wrap) throws IOException

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.