Package com.planet_ink.coffee_mud.Libraries.interfaces

Interface XMLLibrary.XMLTag

Enclosing interface:

XMLLibrary

public static interface XMLLibrary.XMLTag

Method Summary

Modifier and Type	Method	Description
void	addContent(XMLLibrary.XMLTag x)
java.util.List<XMLLibrary.XMLTag>	contents()
XMLLibrary.XMLTag	copyOf()
boolean	getBoolFromPieces(java.lang.String tag)	Return the data value within a given XML block <TAG>Data</TAG> Usage: String ThisColHead=getBoolFromPieces(ThisRow,"TD");
boolean	getBoolFromPieces(java.lang.String tag, boolean defValue)	Return the data value within a given XML block <TAG>Data</TAG> Usage: String ThisColHead=getBoolFromPieces(ThisRow,"TD");
java.util.List<XMLLibrary.XMLTag>	getContentsFromPieces(java.lang.String tag)	Returns the contents of a container tag, searched for in another container tags contents
double	getDoubleFromPieces(java.lang.String tag)	Return the data value within a given XML block <TAG>Data</TAG> Usage: String ThisColHead=getDoubleFromPieces(ThisRow,"TD");
double	getDoubleFromPieces(java.lang.String tag, double defVal)	Return the data value within a given XML block <TAG>Data</TAG> Usage: String ThisColHead=getDoubleFromPieces(ThisRow,"TD");
int	getIntFromPieces(java.lang.String tag)	Return the data value within a given XML block <TAG>Data</TAG> Usage: String ThisColHead=getIntFromPieces(ThisRow,"TD");
int	getIntFromPieces(java.lang.String tag, int defVal)	Return the data value within a given XML block <TAG>Data</TAG> Usage: String ThisColHead=getIntFromPieces(ThisRow,"TD");
long	getLongFromPieces(java.lang.String tag)	Return the data value within a given XML block <TAG>Data</TAG> Usage: String ThisColHead=getLongFromPieces(ThisRow,"TD");
long	getLongFromPieces(java.lang.String tag, long defVal)	Return the data value within a given XML block <TAG>Data</TAG> Usage: String ThisColHead=getLongFromPieces(ThisRow,"TD");
java.lang.String	getParmValue(java.lang.String Tag)	Return a parameter value within an XML tag <TAG Parameter="VALUE"> Usage: String ThisColHead=getParmValue(parmSet,"TD");
XMLLibrary.XMLTag	getPieceFromPieces(java.lang.String tag)	Returns the xml tag node for the given tag name, if found in the given tag container contents
java.util.List<XMLLibrary.XMLTag>	getPiecesFromPieces(java.lang.String tag)	Returns all tags inside the gives set that match this tag name
short	getShortFromPieces(java.lang.String tag)	Return the data value within a given XML block <TAG>Data</TAG> Usage: String ThisColHead=getShortFromPieces(ThisRow,"TD");
short	getShortFromPieces(java.lang.String tag, short defVal)	Return the data value within a given XML block <TAG>Data</TAG> Usage: String ThisColHead=getShortFromPieces(ThisRow,"TD");
java.lang.String	getValFromPieces(java.lang.String tag)	Returns the value of the tag, if it exists in the given tag collection
java.lang.String	getValFromPieces(java.lang.String tag, java.lang.String defValue)	Returns the value of the tag, if it exists in the given tag collection
int	innerEndIndex()
int	innerStartIndex()
boolean	isTagInPieces(java.lang.String tag)	Return where the value is within a given XML block <TAG>Data</TAG> Usage: boolean ThisColHead=isTagInPieces(ThisRow,"TD");
int	outerEndIndex()
int	outerStartIndex()
XMLLibrary.XMLTag	parent()
java.util.Map<java.lang.String,java.lang.String>	parms()
void	setValue(java.lang.String newVal)	Sets new value Be very careful with this
java.lang.String	tag()
java.lang.String	toString()
java.lang.String	value()

Method Detail

copyOf

XMLLibrary.XMLTag copyOf()

addContent

void addContent(XMLLibrary.XMLTag x)

toString

java.lang.String toString()

Overrides:

toString in class java.lang.Object

tag

java.lang.String tag()

Returns:

the tag

value

java.lang.String value()

Returns:

the value

setValue

void setValue(java.lang.String newVal)

Sets new value Be very careful with this

Parameters:

newVal - the new value

contents

java.util.List<XMLLibrary.XMLTag> contents()

Returns:

the contents

parms

java.util.Map<java.lang.String,java.lang.String> parms()

Returns:

the parms

parent

XMLLibrary.XMLTag parent()

Returns:

the parent

outerStartIndex

int outerStartIndex()

Returns:

the outerStart

innerStartIndex

int innerStartIndex()

Returns:

the innerStart

innerEndIndex

int innerEndIndex()

Returns:

the innerEnd

outerEndIndex

int outerEndIndex()

Returns:

the outerEnd

getParmValue

java.lang.String getParmValue(java.lang.String Tag)

Return a parameter value within an XML tag <TAG Parameter="VALUE"> Usage: String ThisColHead=getParmValue(parmSet,"TD");

Parameters:

Tag - Tag to search for

Returns:

String Parameter value

getDoubleFromPieces

double getDoubleFromPieces(java.lang.String tag,
                           double defVal)

Return the data value within a given XML block <TAG>Data</TAG> Usage: String ThisColHead=getDoubleFromPieces(ThisRow,"TD");

Parameters:

tag - Tag to search for

defVal - the value to return if the tag doesn't exist

Returns:

the tags value, or defValue

getPieceFromPieces

XMLLibrary.XMLTag getPieceFromPieces(java.lang.String tag)

Returns the xml tag node for the given tag name, if found in the given tag container contents

Parameters:

tag - the tag name

Returns:

the xml tag node for the given tag name

getBoolFromPieces

boolean getBoolFromPieces(java.lang.String tag,
                          boolean defValue)

Return the data value within a given XML block <TAG>Data</TAG> Usage: String ThisColHead=getBoolFromPieces(ThisRow,"TD");

Parameters:

tag - Tag to search for

defValue - the value to return if the tag doesn't exist

Returns:

the tags value, or defValue

getShortFromPieces

short getShortFromPieces(java.lang.String tag,
                         short defVal)

Return the data value within a given XML block <TAG>Data</TAG> Usage: String ThisColHead=getShortFromPieces(ThisRow,"TD");

Parameters:

tag - Tag to search for

defVal - the value to return if the tag doesn't exist

Returns:

the tags value, or defValue

getIntFromPieces

int getIntFromPieces(java.lang.String tag,
                     int defVal)

Return the data value within a given XML block <TAG>Data</TAG> Usage: String ThisColHead=getIntFromPieces(ThisRow,"TD");

Parameters:

tag - Tag to search for

defVal - the value to return if the tag doesn't exist

Returns:

the tags value, or defValue

getLongFromPieces

long getLongFromPieces(java.lang.String tag,
                       long defVal)

Return the data value within a given XML block <TAG>Data</TAG> Usage: String ThisColHead=getLongFromPieces(ThisRow,"TD");

Parameters:

tag - Tag to search for

defVal - the value to return if the tag doesn't exist

Returns:

the tags value, or defValue

getValFromPieces

java.lang.String getValFromPieces(java.lang.String tag)

Returns the value of the tag, if it exists in the given tag collection

Parameters:

tag - the tag to look for

Returns:

its value, or null

getValFromPieces

java.lang.String getValFromPieces(java.lang.String tag,
                                  java.lang.String defValue)

Returns the value of the tag, if it exists in the given tag collection

Parameters:

tag - the tag to look for

defValue - the value to return if the tag doesn't exist

Returns:

the tags value, or defValue

getContentsFromPieces

java.util.List<XMLLibrary.XMLTag> getContentsFromPieces(java.lang.String tag)

Returns the contents of a container tag, searched for in another container tags contents

Parameters:

tag - the tag to look for

Returns:

the tags contained in tag, or null

getPiecesFromPieces

java.util.List<XMLLibrary.XMLTag> getPiecesFromPieces(java.lang.String tag)

Returns all tags inside the gives set that match this tag name

Parameters:

tag - the tag to look for

Returns:

all the tags contained in tag

getBoolFromPieces

boolean getBoolFromPieces(java.lang.String tag)

Return the data value within a given XML block <TAG>Data</TAG> Usage: String ThisColHead=getBoolFromPieces(ThisRow,"TD");

Parameters:

tag - Tag to search for

Returns:

boolean Information from XML block

getShortFromPieces

short getShortFromPieces(java.lang.String tag)

Return the data value within a given XML block <TAG>Data</TAG> Usage: String ThisColHead=getShortFromPieces(ThisRow,"TD");

Parameters:

tag - Tag to search for

Returns:

short Information from XML block

getIntFromPieces

int getIntFromPieces(java.lang.String tag)

Return the data value within a given XML block <TAG>Data</TAG> Usage: String ThisColHead=getIntFromPieces(ThisRow,"TD");

Parameters:

tag - Tag to search for

Returns:

int Information from XML block

isTagInPieces

boolean isTagInPieces(java.lang.String tag)

Return where the value is within a given XML block <TAG>Data</TAG> Usage: boolean ThisColHead=isTagInPieces(ThisRow,"TD");

Parameters:

tag - Tag to search for

Returns:

boolean Information from XML block

getLongFromPieces

long getLongFromPieces(java.lang.String tag)

Return the data value within a given XML block <TAG>Data</TAG> Usage: String ThisColHead=getLongFromPieces(ThisRow,"TD");

Parameters:

tag - Tag to search for

Returns:

long Information from XML block

getDoubleFromPieces

double getDoubleFromPieces(java.lang.String tag)

Return the data value within a given XML block <TAG>Data</TAG> Usage: String ThisColHead=getDoubleFromPieces(ThisRow,"TD");

Parameters:

tag - Tag to search for

Returns:

double Information from XML block