Package org.antlr.stringtemplate
Interface StringTemplateWriter
- All Known Implementing Classes:
AutoIndentWriter
,NoIndentWriter
public interface StringTemplateWriter
Generic StringTemplate output writer filter.
Literals and the elements of expressions are emitted via write().
Separators are emitted via writeSeparator() because they must be
handled specially when wrapping lines (we don't want to wrap
in between an element and it's separator).
-
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionvoid
void
void
pushIndentation
(String indent) void
setLineWidth
(int lineWidth) int
Write the string and return how many actual chars were written.int
Same as write, but wrap lines using the indicated string as the wrap character (such as "\n").int
writeSeparator
(String str) Write a separator.int
writeWrapSeparator
(String wrap) Because we might need to wrap at a non-atomic string boundary (such as when we wrap in between template applications invalid input: '<'data:{v|[]}; wrap>) we need to expose the wrap string writing just like for the separator.
-
Field Details
-
NO_WRAP
static final int NO_WRAP- See Also:
-
-
Method Details
-
pushIndentation
-
popIndentation
String popIndentation() -
pushAnchorPoint
void pushAnchorPoint() -
popAnchorPoint
void popAnchorPoint() -
setLineWidth
void setLineWidth(int lineWidth) -
write
Write the string and return how many actual chars were written. With autoindentation and wrapping, more chars than length(str) can be emitted. No wrapping is done.- Throws:
IOException
-
write
Same as write, but wrap lines using the indicated string as the wrap character (such as "\n").- Throws:
IOException
-
writeWrapSeparator
Because we might need to wrap at a non-atomic string boundary (such as when we wrap in between template applications invalid input: '<'data:{v|[]}; wrap>) we need to expose the wrap string writing just like for the separator. - Throws:
IOException
-
writeSeparator
Write a separator. Same as write() except that a \n cannot be inserted before emitting a separator.- Throws:
IOException
-