com.steelypip.powerups.minxml

Interface MinXMLBuilder

All Known Implementing Classes:

FlexiMinXMLBuilder

public interface MinXMLBuilder

This interface linearises the construction of a MinXML tree. Start tags are constructed with at least two calls: startTagOpen and startTagClose. In between these two calls there can be any number of puts, which set up the attributes. Note that startTagOpen, startTagClose and endTag all take the element name as a parameter. When using this interface with an unknown implementation the same (equals) element name should be supplied for all three calls that construct a particular element. However an implementation may elect to allow the element name to be null on one or more of these calls (or even all!). All non-null values should be the same and that must be the final value of the element name.

Method Summary

Modifier and Type	Method and Description
MinXML	build() This method returns the constructed tree.
void	endTag(java.lang.String name) This method finishes the construction of the current element.
void	put(java.lang.String key, java.lang.String value) This method adds the attribute key=value to the start tag that is under construction.
void	startTagClose(java.lang.String name) This method finishes the construction of the current start tag.
void	startTagOpen(java.lang.String name) This method should be called to begin the construction of a start-tag with a particular element name.

Method Detail

startTagOpen

void startTagOpen(java.lang.String name)

This method should be called to begin the construction of a start-tag with a particular element name. An implementation may insist on the name being non-null or may permit it to be supplied later. After this method, the next builder method should be put or startTagClose.

Parameters:

name - the name of the element to be constructed (or null).

put

void put(java.lang.String key,
         java.lang.String value)

This method adds the attribute key=value to the start tag that is under construction. The builder method starTagOpen must have been the immediately previous method.

Parameters:

key - the attribute key

value - the attribute value

startTagClose

void startTagClose(java.lang.String name)

This method finishes the construction of the current start tag. It may be followed by a call to endTag or startTagOpen. If the tag name is not-null it must agree with the previous value. If the previous value was null then it automatically is in agreement. An implementation may choose to make startTagClose optional, implicitly closing it when the next startTagOpen is invoked.

Parameters:

name - the name of the element to be constructed (or null)

endTag

void endTag(java.lang.String name)

This method finishes the construction of the current element. If the tag-name is non-null then it must be in agreement with the previous value. If the previous value is null then it is automatically in agreement.

Parameters:

name - the name of the element to be constructed (or null)

build

MinXML build()

This method returns the constructed tree. An implementation may elect to make the builder reusable again.

Returns:

the constructed tree