org.apache.flex.compiler.internal.codegen.js

Class JSDocEmitter

java.lang.Object

org.apache.flex.compiler.internal.codegen.js.JSDocEmitter

All Implemented Interfaces:

IDocEmitter, IEmitter

Direct Known Subclasses:

JSAMDDocEmitter, JSGoogDocEmitter

public class JSDocEmitter
extends Object
implements IDocEmitter, IEmitter

Field Summary

Fields

Modifier and Type	Field and Description
protected IEmitter	emitter

Constructor Summary

Constructors

Constructor and Description
JSDocEmitter(IJSEmitter emitter)

Method Summary

Methods

Modifier and Type	Method and Description
void	begin()
void	end()
String	flushBuffer()
protected StringBuilder	getBuilder()
void	indentPop() Pops an indent from the emitter so after newlines are emitted, the output is correctly formatted.
void	indentPush() Pushes an indent into the emitter so after newlines are emitted, the output is correctly formatted.
boolean	isBufferWrite()
void	setBufferWrite(boolean value)
String	stringifyNode(IASNode node) Takes the node argument and created a String representation if it using the buffer temporarily.
void	write(IEmitterTokens value) Writes a string to the writer.
void	write(String value)
void	writeBlockClose()
void	writeBlockOpen()
void	writeNewline() Writes newline character(s)
void	writeNewline(IEmitterTokens value) Writes the value and then a newline which will automatically have the indent applied after the \n character.
void	writeNewline(IEmitterTokens value, boolean pushIndent) Writes the value after a push or pop of the indent.
void	writeNewline(String value)
void	writeNewline(String value, boolean pushIndent)
void	writeToken(IEmitterTokens value) Writes a ASEmitterTokens character to the buffer and appends a space after automatically.
void	writeToken(String value)

Methods inherited from class java.lang.Object

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

Field Detail

emitter

protected IEmitter emitter

Constructor Detail

JSDocEmitter

public JSDocEmitter(IJSEmitter emitter)

Method Detail

getBuilder

protected StringBuilder getBuilder()

isBufferWrite

public boolean isBufferWrite()

setBufferWrite

public void setBufferWrite(boolean value)

Specified by:

setBufferWrite in interface IDocEmitter

flushBuffer

public String flushBuffer()

Specified by:

flushBuffer in interface IDocEmitter

indentPush

public void indentPush()

Description copied from interface: IEmitter

Pushes an indent into the emitter so after newlines are emitted, the output is correctly formatted.

Specified by:

indentPush in interface IEmitter

indentPop

public void indentPop()

Description copied from interface: IEmitter

Pops an indent from the emitter so after newlines are emitted, the output is correctly formatted.

Specified by:

indentPop in interface IEmitter

write

public void write(IEmitterTokens value)

Description copied from interface: IEmitter

Writes a string to the writer.

Specified by:

write in interface IEmitter

Parameters:

value - The string to write to the output buffer.

write

public void write(String value)

Specified by:

write in interface IEmitter

writeNewline

public void writeNewline()

Description copied from interface: IEmitter

Writes newline character(s)

Specified by:

writeNewline in interface IEmitter

writeNewline

public void writeNewline(String value)

Specified by:

writeNewline in interface IEmitter

writeNewline

public void writeNewline(IEmitterTokens value)

Description copied from interface: IEmitter

Writes the value and then a newline which will automatically have the indent applied after the \n character.

Specified by:

writeNewline in interface IEmitter

Parameters:

value - The String value to write before the \n is appended.

writeNewline

public void writeNewline(String value,
                boolean pushIndent)

Specified by:

writeNewline in interface IEmitter

writeNewline

public void writeNewline(IEmitterTokens value,
                boolean pushIndent)

Description copied from interface: IEmitter

Writes the value after a push or pop of the indent.

This method effectively lets you write a value and then indent our outdent. The method can be useful in the following where your cursor writer is at [0], you write writeNewline("if (foo) {", true); and the cursor after the call will end up at [1].

 [0]if (foo) {
     [1]this.something;
 }
 

Specified by:

writeNewline in interface IEmitter

Parameters:

value - The String value to write before the \n is appended.

pushIndent - Whether to push indent true or pop indent false.

writeToken

public void writeToken(IEmitterTokens value)

Description copied from interface: IEmitter

Writes a ASEmitterTokens character to the buffer and appends a space after automatically.

Specified by:

writeToken in interface IEmitter

Parameters:

value - The ASEmitterTokens value.

writeToken

public void writeToken(String value)

Specified by:

writeToken in interface IEmitter

writeBlockClose

public void writeBlockClose()

writeBlockOpen

public void writeBlockOpen()

begin

public void begin()

Specified by:

begin in interface IDocEmitter

end

public void end()

Specified by:

end in interface IDocEmitter

stringifyNode

public String stringifyNode(IASNode node)

Description copied from interface: IEmitter

Takes the node argument and created a String representation if it using the buffer temporarily.

Note; This method is still beta, it need more logic if an emitter is actually using the buffer!

Specified by:

stringifyNode in interface IEmitter

Parameters:

node - The node walk and create a String for.

Returns:

The node's output.