org.eclipse.epsilon.egl.output

Class OutputBuffer

java.lang.Object

org.eclipse.epsilon.egl.output.OutputBuffer

All Implemented Interfaces:

IOutputBuffer

public class OutputBuffer
extends Object
implements IOutputBuffer

Field Summary

Fields

Modifier and Type	Field and Description
protected StringBuilder	buffer
protected ColumnCounter	columnCounter
protected boolean	contentTypeSet
protected IEglContext	context
protected List<CommentBlockPartitioner>	customPartitioners
protected boolean	hasControlledRegions
protected boolean	hasProtectedRegions
protected String	lastLine
protected LineCounter	lineCounter

Constructor Summary

Constructors

Constructor and Description
OutputBuffer()
OutputBuffer(IEglContext context)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	assertNoMixedRegions(RegionType regionType)
protected String	calculateIndentationToMatch(String previousLine)
void	chop(int chars) Removes the specified number of characters from the end of the buffer.
String	control(String id, boolean enabled, String contents) Appends a controlled region to the buffer.
String	control(String startComment, String endComment, String id, boolean enabled, String contents) Appends a controlled region to the buffer.
void	formatWith(Formatter formatter) Reformats the contents of the buffer with the given Formatter.
int	getCurrentColumnNumber() Returns the character number of the last character in the buffer.
int	getCurrentLineNumber() Returns the line number of the last character in the buffer.
protected String	getLastLineInBuffer()
int	getOffset() Returns the size of the buffer.
String	getSpaces(int howMany) Returns a string comprised of the specificed number of spaces.
String	preserve(String id, boolean enabled, String contents) Appends a protected region to the buffer.
String	preserve(String startComment, String endComment, String id, boolean enabled, String contents) Appends a protected region to the buffer.
void	print(Object o) Appends a string representation of the given object to the buffer.
void	printdyn(Object o) Appends a string representation of the given object to the buffer, correcting the indentation of the string representation to match the indentation level of the previous line in the buffer.
void	println() Appends a new line the buffer.
void	println(Object o) Appends a string representation of the given object and a new line to the buffer.
void	prinx(Object o) An alias for print(Object) that should only be called internally, by code generated by the Preprocessor.
protected void	replaceContentsWith(String newContents)
void	setContentType(String name) Specifies the type of output in the buffer, such as Java or HTML.
String	startControl(String id, boolean enabled) Appends the starting tag for a controlled region to the buffer.
String	startControl(String startComment, String endComment, String id, boolean enabled) Appends the starting tag for a protected region to the buffer.
String	startLocate(String id, boolean enabled, RegionType regionType)
String	startLocate(String startComment, String endComment, String id, boolean enabled, RegionType regionType)
String	startPreserve(String id, boolean enabled) Appends the starting tag for a protected region to the buffer.
String	startPreserve(String startComment, String endComment, String id, boolean enabled) Appends the starting tag for a protected region to the buffer.
void	stop() Halts execution of the current template.
String	stopControl() Appends a closing tag for a protected region to the buffer.
String	stopLocate()
String	stopPreserve() Appends a closing tag for a protected region to the buffer.
String	toString() Converts the contents of the buffer to a string.

Methods inherited from class java.lang.Object

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

Field Detail

buffer

protected StringBuilder buffer

context

protected IEglContext context

lineCounter

protected LineCounter lineCounter

columnCounter

protected ColumnCounter columnCounter

customPartitioners

protected List<CommentBlockPartitioner> customPartitioners

contentTypeSet

protected boolean contentTypeSet

lastLine

protected String lastLine

hasProtectedRegions

protected boolean hasProtectedRegions

hasControlledRegions

protected boolean hasControlledRegions

Constructor Detail

OutputBuffer

public OutputBuffer(IEglContext context)

OutputBuffer

public OutputBuffer()

Method Detail

chop

public void chop(int chars)

Description copied from interface: IOutputBuffer

Removes the specified number of characters from the end of the buffer.

Specified by:

chop in interface IOutputBuffer

print

public void print(Object o)

Description copied from interface: IOutputBuffer

Appends a string representation of the given object to the buffer.

Specified by:

print in interface IOutputBuffer

printdyn

public void printdyn(Object o)

Description copied from interface: IOutputBuffer

Appends a string representation of the given object to the buffer, correcting the indentation of the string representation to match the indentation level of the previous line in the buffer. Used to output EGL dynamic sections.

Specified by:

printdyn in interface IOutputBuffer

prinx

public void prinx(Object o)

An alias for print(Object) that should only be called internally, by code generated by the Preprocessor. This is a workaround to allow us to identify, in the preprocessed EOL, statements that were generated from an EGL static section. We then adjust these ASTs to allow better traceability in the AST outline view.

Specified by:

prinx in interface IOutputBuffer

See Also:

EglPreprocessorModule.updateRegionsOfStaticTextASTs(org.eclipse.epsilon.common.parse.AST)

getLastLineInBuffer

protected String getLastLineInBuffer()

calculateIndentationToMatch

protected String calculateIndentationToMatch(String previousLine)

getSpaces

public String getSpaces(int howMany)

Description copied from interface: IOutputBuffer

Returns a string comprised of the specificed number of spaces.

Specified by:

getSpaces in interface IOutputBuffer

println

public void println()

Description copied from interface: IOutputBuffer

Appends a new line the buffer.

Specified by:

println in interface IOutputBuffer

println

public void println(Object o)

Description copied from interface: IOutputBuffer

Appends a string representation of the given object and a new line to the buffer.

Specified by:

println in interface IOutputBuffer

preserve

public String preserve(String id,
              boolean enabled,
              String contents)
                throws EglRuntimeException

Description copied from interface: IOutputBuffer

Appends a protected region to the buffer.

Specified by:

preserve in interface IOutputBuffer

Parameters:

id - - a unique identifier for this protected region

enabled - - a flag indicating whether protection of text in this region should be enabled or not

contents - - the contents for this protected region

Throws:

EglRuntimeException - if IOutputBuffer.setContentType(String) has not been called.

control

public String control(String id,
             boolean enabled,
             String contents)
               throws EglRuntimeException

Description copied from interface: IOutputBuffer

Appends a controlled region to the buffer.

Specified by:

control in interface IOutputBuffer

Parameters:

id - - a unique identifier for this protected region

enabled - - a flag indicating whether protection of text in this region should be enabled or not

contents - - the contents for this protected region

Throws:

EglRuntimeException - if IOutputBuffer.setContentType(String) has not been called.

preserve

public String preserve(String startComment,
              String endComment,
              String id,
              boolean enabled,
              String contents)
                throws EglRuntimeException

Description copied from interface: IOutputBuffer

Appends a protected region to the buffer.

Specified by:

preserve in interface IOutputBuffer

Parameters:

startComment - - the character sequence used to denote the start of a comment for the type of output in the buffer

endComment - - the character sequence used to denote the end of a comment for the type of output in the buffer

id - - a unique identifier for this protected region

enabled - - a flag indicating whether protection of text in this region should be enabled or not

contents - - the contents for this protected region

Throws:

EglRuntimeException

control

public String control(String startComment,
             String endComment,
             String id,
             boolean enabled,
             String contents)
               throws EglRuntimeException

Description copied from interface: IOutputBuffer

Appends a controlled region to the buffer.

Specified by:

control in interface IOutputBuffer

Parameters:

startComment - - the character sequence used to denote the start of a comment for the type of output in the buffer

endComment - - the character sequence used to denote the end of a comment for the type of output in the buffer

id - - a unique identifier for this protected region

enabled - - a flag indicating whether protection of text in this region should be enabled or not

contents - - the contents for this protected region

Throws:

EglRuntimeException

setContentType

public void setContentType(String name)
                    throws EglRuntimeException

Description copied from interface: IOutputBuffer

Specifies the type of output in the buffer, such as Java or HTML.

Specified by:

setContentType in interface IOutputBuffer

Throws:

EglRuntimeException - if the content type is not supported.

startPreserve

public String startPreserve(String id,
                   boolean enabled)
                     throws EglRuntimeException

Description copied from interface: IOutputBuffer

Appends the starting tag for a protected region to the buffer.

Specified by:

startPreserve in interface IOutputBuffer

Parameters:

id - - a unique identifier for this protected region

enabled - - a flag indicating whether protection of text in this region should be enabled or not

Throws:

EglRuntimeException - if IOutputBuffer.setContentType(String) has not been called

startControl

public String startControl(String id,
                  boolean enabled)
                    throws EglRuntimeException

Description copied from interface: IOutputBuffer

Appends the starting tag for a controlled region to the buffer.

Specified by:

startControl in interface IOutputBuffer

Parameters:

id - - a unique identifier for this protected region

enabled - - a flag indicating whether protection of text in this region should be enabled or not

Throws:

EglRuntimeException - if IOutputBuffer.setContentType(String) has not been called

startLocate

public String startLocate(String id,
                 boolean enabled,
                 RegionType regionType)
                   throws EglRuntimeException

Throws:

EglRuntimeException

startControl

public String startControl(String startComment,
                  String endComment,
                  String id,
                  boolean enabled)
                    throws EglRuntimeException

Description copied from interface: IOutputBuffer

Appends the starting tag for a protected region to the buffer.

Specified by:

startControl in interface IOutputBuffer

Parameters:

startComment - - the character sequence used to denote the start of a comment for the type of output in the buffer

endComment - - the character sequence used to denote the end of a comment for the type of output in the buffer

id - - a unique identifier for this protected region

enabled - - a flag indicating whether protection of text in this region should be enabled or not

Throws:

EglRuntimeException

startPreserve

public String startPreserve(String startComment,
                   String endComment,
                   String id,
                   boolean enabled)
                     throws EglRuntimeException

Description copied from interface: IOutputBuffer

Appends the starting tag for a protected region to the buffer.

Specified by:

startPreserve in interface IOutputBuffer

Parameters:

startComment - - the character sequence used to denote the start of a comment for the type of output in the buffer

endComment - - the character sequence used to denote the end of a comment for the type of output in the buffer

id - - a unique identifier for this protected region

enabled - - a flag indicating whether protection of text in this region should be enabled or not

Throws:

EglRuntimeException

startLocate

public String startLocate(String startComment,
                 String endComment,
                 String id,
                 boolean enabled,
                 RegionType regionType)
                   throws EglRuntimeException

Throws:

EglRuntimeException

assertNoMixedRegions

protected void assertNoMixedRegions(RegionType regionType)
                             throws EglRuntimeException

Throws:

EglRuntimeException

stopControl

public String stopControl()
                   throws EglRuntimeException

Description copied from interface: IOutputBuffer

Appends a closing tag for a protected region to the buffer.

Specified by:

stopControl in interface IOutputBuffer

Throws:

EglRuntimeException - if there is no unclosed protected region in the buffer.

stopPreserve

public String stopPreserve()
                    throws EglRuntimeException

Description copied from interface: IOutputBuffer

Appends a closing tag for a protected region to the buffer.

Specified by:

stopPreserve in interface IOutputBuffer

Throws:

EglRuntimeException - if there is no unclosed protected region in the buffer.

stopLocate

public String stopLocate()
                  throws EglRuntimeException

Throws:

EglRuntimeException

stop

public void stop()
          throws EglStoppedException

Description copied from interface: IOutputBuffer

Halts execution of the current template.

Specified by:

stop in interface IOutputBuffer

Throws:

EglStoppedException

getCurrentLineNumber

public int getCurrentLineNumber()

Description copied from interface: IOutputBuffer

Returns the line number of the last character in the buffer.

Specified by:

getCurrentLineNumber in interface IOutputBuffer

getCurrentColumnNumber

public int getCurrentColumnNumber()

Description copied from interface: IOutputBuffer

Returns the character number of the last character in the buffer.

Specified by:

getCurrentColumnNumber in interface IOutputBuffer

getOffset

public int getOffset()

Description copied from interface: IOutputBuffer

Returns the size of the buffer.

Specified by:

getOffset in interface IOutputBuffer

formatWith

public void formatWith(Formatter formatter)

Description copied from interface: IOutputBuffer

Reformats the contents of the buffer with the given Formatter.

Specified by:

formatWith in interface IOutputBuffer

replaceContentsWith

protected void replaceContentsWith(String newContents)

toString

public String toString()

Description copied from interface: IOutputBuffer

Converts the contents of the buffer to a string.

Specified by:

toString in interface IOutputBuffer

Overrides:

toString in class Object