org.apache.ws.jaxme.js

Interface PlaceHolder

public interface PlaceHolder

Interface of a placeholder. A placeholder is used by one method to note, that another method should insert code "here". A placeholder is created by invoking {@link org.apache.ws.jaxme.js.IndentationEngine#newPlaceHolder(String, boolean)}.

Author: Jochen Wiedmann

Method Summary
intgetLevel()

Returns the placeholders indentation level.

StringgetName()

Returns the placeholders name.

ObjectgetProperty(String pName)

Returns a property value.

booleanisAutoRemovable()

Returns whether the placeholder is automatically removable.

voidremove()

Removes the placeholder.

voidsetProperty(String pName, Object pValue)

Sets a property.

Method Detail

getLevel

public int getLevel()

Returns the placeholders indentation level.

getName

public String getName()

Returns the placeholders name.

getProperty

public Object getProperty(String pName)

Returns a property value. There is no distinction between the property value null and the case where the property isn't set.

isAutoRemovable

public boolean isAutoRemovable()

Returns whether the placeholder is automatically removable.

remove

public void remove()

Removes the placeholder. If a placeholder isn't automatically removable, then it must be removed by an explicit invocation of this method.

setProperty

public void setProperty(String pName, Object pValue)

Sets a property.