Overview Package Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

org.apache.ws.jaxme.js

Interface IndentationEngine

Known Subinterfaces:
ConditionalIndentationEngine, LocalJavaField, TextFile
Known Implementing Classes:
AbstractJavaMethod, ConditionalIndentationJavaSourceObject, ConditionalIndentationJavaSourceObject.LJFImpl, IndentationEngineImpl, JavaClassInitializer, JavaConstructor, JavaField, JavaInnerClass, JavaMethod, JavaSource, JavaSourceObject, TextFileImpl
public interface IndentationEngine
Version:
$Id: IndentationEngine.java 231785 2004-02-16 23:39:59Z jochen $
Author:
Jochen Wiedmann

Field Summary

static Object
NOTHING

Method Summary

void
addLine()
Adds an empty line, shortcut for addLine(getIndentationLevel, new Object[0]).
void
addLine(Object pLine)
Shortcut for addLine(getIndentationLevel(), new Object[]{pLine}).
void
addLine(Object pToken1, Object pToken2)
Shortcut for addLine(getIndentationLevel(), new Object[]{pToken1, pToken2}).
void
addLine(Object pToken1, Object pToken2, Object pToken3)
Shortcut for addLine(getIndentationLevel(), new Object[]{pToken1, pToken2, pToken3}).
void
addLine(Object pToken1, Object pToken2, Object pToken3, Object pToken4)
Shortcut for addLine(getIndentationLevel(), new Object[]{pToken1, pToken2, pToken3, pToken4}).
void
addLine(Object pToken1, Object pToken2, Object pToken3, Object pToken4, Object pToken5)
Shortcut for addLine(getIndentationLevel(), new Object[]{pToken1, pToken2, pToken3, pToken4, pToken5}).
void
addLine(Object pToken1, Object pToken2, Object pToken3, Object pToken4, Object pToken5, Object pToken6)
Shortcut for addLine(getIndentationLevel(), new Object[]{pToken1, pToken2, pToken3, pToken4, pToken5, pToken6}) .
void
addLine(Object pToken1, Object pToken2, Object pToken3, Object pToken4, Object pToken5, Object pToken6, Object pToken7)
Shortcut for addLine(getIndentationLevel(), new Object[]{pToken1, pToken2, pToken3, pToken4, pToken5, pToken6, pToken7}) .
void
addLine(Object pToken1, Object pToken2, Object pToken3, Object pToken4, Object pToken5, Object pToken6, Object pToken7, Object pToken8)
Shortcut for addLine(getIndentationLevel(), new Object[]{pToken1, pToken2, pToken3, pToken4, pToken5, pToken6, pToken7, pToken8}) .
void
addLine(Object pToken1, Object pToken2, Object pToken3, Object pToken4, Object pToken5, Object pToken6, Object pToken7, Object pToken8, Object pToken9)
Shortcut for addLine(getIndentationLevel(), new Object[]{pToken1, pToken2, pToken3, pToken4, pToken5, pToken6, pToken7, pToken8, pToken9}) .
void
addLine(Object pToken1, Object pToken2, Object pToken3, Object pToken4, Object pToken5, Object pToken6, Object pToken7, Object pToken8, Object pToken9, Object pToken10)
Shortcut for addLine(getIndentationLevel(), new Object[]{pToken1, pToken2, pToken3, pToken4, pToken5, pToken6, pToken7, pToken8, pToken9, pToken10}) .
void
addLine(Object pToken1, Object pToken2, Object pToken3, Object pToken4, Object pToken5, Object pToken6, Object pToken7, Object pToken8, Object pToken9, Object pToken10, Object pToken11)
Shortcut for addLine(getIndentationLevel(), new Object[]{pToken1, pToken2, pToken3, pToken4, pToken5, pToken6, pToken7, pToken8, pToken9, pToken10, pToken11}) .
void
addLine(Object pToken1, Object pToken2, Object pToken3, Object pToken4, Object pToken5, Object pToken6, Object pToken7, Object pToken8, Object pToken9, Object pToken10, Object pToken11, Object pToken12)
Shortcut for addLine(getIndentationLevel(), new Object[]{pToken1, pToken2, pToken3, pToken4, pToken5, pToken6, pToken7, pToken8, pToken9, pToken10, pToken11, pToken12}) .
void
addLine(Object pToken1, Object pToken2, Object pToken3, Object pToken4, Object pToken5, Object pToken6, Object pToken7, Object pToken8, Object pToken9, Object pToken10, Object pToken11, Object pToken12, Object pToken13)
Shortcut for addLine(getIndentationLevel(), new Object[]{pToken1, pToken2, pToken3, pToken4, pToken5, pToken6, pToken7, pToken8, pToken9, pToken10, pToken11, pToken12, pToken13}) .
void
addLine(Object pToken1, Object pToken2, Object pToken3, Object pToken4, Object pToken5, Object pToken6, Object pToken7, Object pToken8, Object pToken9, Object pToken10, Object pToken11, Object pToken12, Object pToken13, Object pToken14)
Shortcut for addLine(getIndentationLevel(), new Object[]{pToken1, pToken2, pToken3, pToken4, pToken5, pToken6, pToken7, pToken8, pToken9, pToken10, pToken11, pToken12, pToken13, pToken14}) .
void
addLine(Object pToken1, Object pToken2, Object pToken3, Object pToken4, Object pToken5, Object pToken6, Object pToken7, Object pToken8, Object pToken9, Object pToken10, Object pToken11, Object pToken12, Object pToken13, Object pToken14, Object pToken15)
Shortcut for addLine(getIndentationLevel(), new Object[]{pToken1, pToken2, pToken3, pToken4, pToken5, pToken6, pToken7, pToken8, pToken9, pToken10, pToken11, pToken12, pToken13, pToken15}) .
void
addLine(Object[] pTokens)
Shortcut for addLine(getIndentationLevel(), pTokens).
void
addLine(int pLevel, Object[] pTokens)
Adds the given tokens as a complete line, using the given level of indentation.
void
clear()
Clears the IndentationEngine's contents.
int
getLevel()
Returns the current level of indentation.
PlaceHolder
getPlaceHolder(String pName)
Searches for the placeholder with the given name.
void
indent()
Increases the current level of indentation.
void
moveToBottom()
Moves the cursor to the bottom of the method.
void
moveToTop()
Moves the cursor to the top of the method.
PlaceHolder
newPlaceHolder(String pName, boolean pAutoRemove)
Sets a placeholder with the given name.
void
setLevel(int pLevel)
Sets the current level of indentation.
void
unindent()
Decreases the current level of indentation.
void
write(IndentationTarget pTarget)
Adds the IndentationEngine's contents to the given IndentationTarget.
void
write(IndentationTarget pTarget, Object pObject)
Adds the given objects contents to the given IndentationTarget.

Field Details

NOTHING

public static final Object NOTHING

Method Details

addLine

public void addLine()
Adds an empty line, shortcut for addLine(getIndentationLevel, new Object[0]).

addLine

public void addLine(Object pLine)
Shortcut for addLine(getIndentationLevel(), new Object[]{pLine}).

addLine

public void addLine(Object pToken1,
                    Object pToken2)
Shortcut for addLine(getIndentationLevel(), new Object[]{pToken1, pToken2}).

addLine

public void addLine(Object pToken1,
                    Object pToken2,
                    Object pToken3)
Shortcut for addLine(getIndentationLevel(), new Object[]{pToken1, pToken2, pToken3}).

addLine

public void addLine(Object pToken1,
                    Object pToken2,
                    Object pToken3,
                    Object pToken4)
Shortcut for addLine(getIndentationLevel(), new Object[]{pToken1, pToken2, pToken3, pToken4}).

addLine

public void addLine(Object pToken1,
                    Object pToken2,
                    Object pToken3,
                    Object pToken4,
                    Object pToken5)
Shortcut for addLine(getIndentationLevel(), new Object[]{pToken1, pToken2, pToken3, pToken4, pToken5}).

addLine

public void addLine(Object pToken1,
                    Object pToken2,
                    Object pToken3,
                    Object pToken4,
                    Object pToken5,
                    Object pToken6)
Shortcut for addLine(getIndentationLevel(), new Object[]{pToken1, pToken2, pToken3, pToken4, pToken5, pToken6}) .

addLine

public void addLine(Object pToken1,
                    Object pToken2,
                    Object pToken3,
                    Object pToken4,
                    Object pToken5,
                    Object pToken6,
                    Object pToken7)
Shortcut for addLine(getIndentationLevel(), new Object[]{pToken1, pToken2, pToken3, pToken4, pToken5, pToken6, pToken7}) .

addLine

public void addLine(Object pToken1,
                    Object pToken2,
                    Object pToken3,
                    Object pToken4,
                    Object pToken5,
                    Object pToken6,
                    Object pToken7,
                    Object pToken8)
Shortcut for addLine(getIndentationLevel(), new Object[]{pToken1, pToken2, pToken3, pToken4, pToken5, pToken6, pToken7, pToken8}) .

addLine

public void addLine(Object pToken1,
                    Object pToken2,
                    Object pToken3,
                    Object pToken4,
                    Object pToken5,
                    Object pToken6,
                    Object pToken7,
                    Object pToken8,
                    Object pToken9)
Shortcut for addLine(getIndentationLevel(), new Object[]{pToken1, pToken2, pToken3, pToken4, pToken5, pToken6, pToken7, pToken8, pToken9}) .

addLine

public void addLine(Object pToken1,
                    Object pToken2,
                    Object pToken3,
                    Object pToken4,
                    Object pToken5,
                    Object pToken6,
                    Object pToken7,
                    Object pToken8,
                    Object pToken9,
                    Object pToken10)
Shortcut for addLine(getIndentationLevel(), new Object[]{pToken1, pToken2, pToken3, pToken4, pToken5, pToken6, pToken7, pToken8, pToken9, pToken10}) .

addLine

public void addLine(Object pToken1,
                    Object pToken2,
                    Object pToken3,
                    Object pToken4,
                    Object pToken5,
                    Object pToken6,
                    Object pToken7,
                    Object pToken8,
                    Object pToken9,
                    Object pToken10,
                    Object pToken11)
Shortcut for addLine(getIndentationLevel(), new Object[]{pToken1, pToken2, pToken3, pToken4, pToken5, pToken6, pToken7, pToken8, pToken9, pToken10, pToken11}) .

addLine

public void addLine(Object pToken1,
                    Object pToken2,
                    Object pToken3,
                    Object pToken4,
                    Object pToken5,
                    Object pToken6,
                    Object pToken7,
                    Object pToken8,
                    Object pToken9,
                    Object pToken10,
                    Object pToken11,
                    Object pToken12)
Shortcut for addLine(getIndentationLevel(), new Object[]{pToken1, pToken2, pToken3, pToken4, pToken5, pToken6, pToken7, pToken8, pToken9, pToken10, pToken11, pToken12}) .

addLine

public void addLine(Object pToken1,
                    Object pToken2,
                    Object pToken3,
                    Object pToken4,
                    Object pToken5,
                    Object pToken6,
                    Object pToken7,
                    Object pToken8,
                    Object pToken9,
                    Object pToken10,
                    Object pToken11,
                    Object pToken12,
                    Object pToken13)
Shortcut for addLine(getIndentationLevel(), new Object[]{pToken1, pToken2, pToken3, pToken4, pToken5, pToken6, pToken7, pToken8, pToken9, pToken10, pToken11, pToken12, pToken13}) .

addLine

public void addLine(Object pToken1,
                    Object pToken2,
                    Object pToken3,
                    Object pToken4,
                    Object pToken5,
                    Object pToken6,
                    Object pToken7,
                    Object pToken8,
                    Object pToken9,
                    Object pToken10,
                    Object pToken11,
                    Object pToken12,
                    Object pToken13,
                    Object pToken14)
Shortcut for addLine(getIndentationLevel(), new Object[]{pToken1, pToken2, pToken3, pToken4, pToken5, pToken6, pToken7, pToken8, pToken9, pToken10, pToken11, pToken12, pToken13, pToken14}) .

addLine

public void addLine(Object pToken1,
                    Object pToken2,
                    Object pToken3,
                    Object pToken4,
                    Object pToken5,
                    Object pToken6,
                    Object pToken7,
                    Object pToken8,
                    Object pToken9,
                    Object pToken10,
                    Object pToken11,
                    Object pToken12,
                    Object pToken13,
                    Object pToken14,
                    Object pToken15)
Shortcut for addLine(getIndentationLevel(), new Object[]{pToken1, pToken2, pToken3, pToken4, pToken5, pToken6, pToken7, pToken8, pToken9, pToken10, pToken11, pToken12, pToken13, pToken15}) .

addLine

public void addLine(Object[] pTokens)
Shortcut for addLine(getIndentationLevel(), pTokens).

addLine

public void addLine(int pLevel,
                    Object[] pTokens)
Adds the given tokens as a complete line, using the given level of indentation.

clear

public void clear()
Clears the IndentationEngine's contents.

getLevel

public int getLevel()
Returns the current level of indentation.

getPlaceHolder

public PlaceHolder getPlaceHolder(String pName)
Searches for the placeholder with the given name. The cursor will be set to the line after the placeholder, if it is found. In that case subsequent invocations of addLine() will add code to the lines following the placeholder. Otherwise the cursor is unchanged.
Parameters:
pName - The placeholders name
Returns:
The placeholder or null, if it wasn't found.

indent

public void indent()
Increases the current level of indentation.

moveToBottom

public void moveToBottom()
Moves the cursor to the bottom of the method.

moveToTop

public void moveToTop()
Moves the cursor to the top of the method.

newPlaceHolder

public PlaceHolder newPlaceHolder(String pName,
                                  boolean pAutoRemove)
Sets a placeholder with the given name.
Parameters:
pName - The placeholders name
pAutoRemove - Whether the placeholder must be removed by invoking PlaceHolder.remove() (false) or not (true).

setLevel

public void setLevel(int pLevel)
Sets the current level of indentation.

unindent

public void unindent()
Decreases the current level of indentation.

write

public void write(IndentationTarget pTarget)
            throws IOException
Adds the IndentationEngine's contents to the given IndentationTarget.

write

public void write(IndentationTarget pTarget,
                  Object pObject)
            throws IOException
Adds the given objects contents to the given IndentationTarget.

Overview Package Tree Index Deprecated About