com.steelypip.powerups.minxml

Interface MinXML

All Superinterfaces:

java.util.Collection<MinXML>, java.lang.Iterable<MinXML>, java.util.List<MinXML>

All Known Implementing Classes:

AbsFlexiMinXML, AbsMinXML, FlexiMinXML

public interface MinXML
extends java.util.List<MinXML>

MinXML is a cleaner, leaner, cut-down version of XML with only the absolute essentials. An MinXML object is a single element that represents a tree of attributed labels. The MinXML interface defines a standard interface for all classes representing MinXML elements.

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.String>	asMap() Returns a Map that represents the attributes of an element that shares updates with the original element.
java.lang.Iterable<java.util.Map.Entry<java.lang.String,java.lang.String>>	asMapEntries() Returns an iterator over the attributes of an element that shares updates with the original element.
java.lang.Iterable<java.lang.String>	asMapKeys() Returns an iterator over the keys of an element that shares updates with the original element.
void	clearAttributes() Removes all the attributes of the element.
@NonNull MinXML	deepCopy() deepCopy makes a copy of the topmost node and all the children.
java.lang.Iterable<java.util.Map.Entry<java.lang.String,java.lang.String>>	entries() Returns a iterator over the attributes of an element, as if the attributes were implemented as a Map, which shares updates with the original element (when updates are allowed).
boolean	equals(java.lang.Object obj)
java.lang.String	getAttribute(java.lang.String key) Gets the attribute value associated with a given key.
java.lang.String	getAttribute(java.lang.String key, java.lang.String value_otherwise) Gets the attribute value associated with a given key.
java.util.Map<java.lang.String,java.lang.String>	getAttributes() Returns a Map representing the attributes of an element that does not share updates with the original element.
@NonNull java.lang.String	getName() Returns the name of a MinXML element.
boolean	hasAttribute() Returns true if the element has any attributes, otherwise false.
boolean	hasAttribute(java.lang.String key) Returns true if the element has an attribute with the given key.
boolean	hasAttribute(java.lang.String key, java.lang.String value) Returns true if the element has an attribute with the given key whose value is equal to the given value.
boolean	hasName(java.lang.String name) Returns true if the name of the element is the same as given string.
boolean	hasntAttribute() Returns true if the element has no attributes, otherwise false.
boolean	isntEmpty() Returns true if the element has no children.
java.lang.Iterable<java.lang.String>	keys() Returns a iterator for the set of keys of the attributes of an element, as if the attributes were implemented as a Map, which shares updates with the original element (when updates are allowed).
void	prettyPrint(java.io.PrintWriter pw) Renders the element using the supplied PrintWriter such that each start and end tag are on their own line and the children indented.
void	prettyPrint(java.io.Writer w) Renders the element using the supplied Writer such that each start and end tag are on their own line and the children indented.
void	print(java.io.PrintWriter pw) Renders the element using the supplied PrintWriter.
void	print(java.io.Writer w) Renders the element to the supplied Writer.
void	putAllAttributes(java.util.Map<java.lang.String,java.lang.String> map)
void	putAttribute(java.lang.String key, java.lang.String value) Puts an attribute key=value into the element.
void	setName(@NonNull java.lang.String name) Changes the name of the element to the given string.
@NonNull MinXML	shallowCopy() shallowCopy makes a copy of the topmost node but shares the children.
int	sizeAttributes() Returns the number of attributes of the element.
void	trimToSize() This method signals that there will be no further updates to an element, at least for a while, and the implementation should consider this a good opportunity to compact the space used by this element and all child elements, including any shared elements.

Methods inherited from interface java.util.List

add, add, addAll, addAll, clear, contains, containsAll, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Method Detail

getName

@NonNull java.lang.String getName()

Returns the name of a MinXML element. It is not guaranteed that this is interned but it is guaranteed to be non-null.

Returns:

the element name

hasName

boolean hasName(java.lang.String name)

Returns true if the name of the element is the same as given string. Equivalent to this.getName() == name.

Parameters:

name - the name we are checking

Returns:

true if the element has that name

setName

void setName(@NonNull java.lang.String name)
      throws java.lang.UnsupportedOperationException

Changes the name of the element to the given string. Note that an implementation of MinXML is not obliged to support this method and may throw an exception. The name may not be null, otherwise a {link RuntimeException} is thrown.

Parameters:

name - the name we are setting

Throws:

java.lang.UnsupportedOperationException - if the implementing class cannot support this method

getAttribute

java.lang.String getAttribute(java.lang.String key)

Gets the attribute value associated with a given key. If the element does not have an attribute of that name it returns null.

Parameters:

key - the attribute key being looked up

Returns:

the associated value or null

getAttribute

java.lang.String getAttribute(java.lang.String key,
                              java.lang.String value_otherwise)

Gets the attribute value associated with a given key. If the element does not have an attribute of that name it returns the suppiled value_otherwise.

Parameters:

key - the attribute key being looked up

value_otherwise - the value to be returned if there is no matching attribute

Returns:

the associated value

hasAttribute

boolean hasAttribute()

Returns true if the element has any attributes, otherwise false.

Returns:

true if the element has 0 or more attributes.

hasAttribute

boolean hasAttribute(java.lang.String key)

Returns true if the element has an attribute with the given key.

Parameters:

key - the attribute key

Returns:

true if the element has an attribute with that key

hasAttribute

boolean hasAttribute(java.lang.String key,
                     java.lang.String value)

Returns true if the element has an attribute with the given key whose value is equal to the given value.

Parameters:

key - attribute being checked

value - value being checked

Returns:

true if the element has a matching attribute

hasntAttribute

boolean hasntAttribute()

Returns true if the element has no attributes, otherwise false.

Returns:

has no attributes

sizeAttributes

int sizeAttributes()

Returns the number of attributes of the element. This is guranteed to be non-negative. If there are more attributes than can be represented by a Java int, then a RuntimeException must be raised.

Returns:

number of attributes.

keys

java.lang.Iterable<java.lang.String> keys()

Returns a iterator for the set of keys of the attributes of an element, as if the attributes were implemented as a Map, which shares updates with the original element (when updates are allowed). If you want updates to be shared use asMapKeys.

Returns:

iterator over keys

asMapKeys

java.lang.Iterable<java.lang.String> asMapKeys()

Returns an iterator over the keys of an element that shares updates with the original element.

Returns:

the iterator.

entries

java.lang.Iterable<java.util.Map.Entry<java.lang.String,java.lang.String>> entries()

Returns a iterator over the attributes of an element, as if the attributes were implemented as a Map, which shares updates with the original element (when updates are allowed). If you want updates to be shared use asMapEntries.

Returns:

iterator over entries

getAttributes

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

Returns a Map representing the attributes of an element that does not share updates with the original element. If you want updates to be shared use asMap.

Returns:

map of attributes

asMap

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

Returns a Map that represents the attributes of an element that shares updates with the original element.

Returns:

the sharing map

asMapEntries

java.lang.Iterable<java.util.Map.Entry<java.lang.String,java.lang.String>> asMapEntries()

Returns an iterator over the attributes of an element that shares updates with the original element.

Returns:

the sharing iterator

putAttribute

void putAttribute(java.lang.String key,
                  java.lang.String value)
           throws java.lang.UnsupportedOperationException

Puts an attribute key=value into the element. If no attribute of that key already exists then one is created. Otherwise the value will be changed. A class implementing MinXML is not obliged to implement putAttribute and may throw an UnsupportedOperationException.

Parameters:

key - the attribute key

value - the attribute value

Throws:

java.lang.UnsupportedOperationException - if the implementing class cannot support this method

putAllAttributes

void putAllAttributes(java.util.Map<java.lang.String,java.lang.String> map)
               throws java.lang.UnsupportedOperationException

Throws:

java.lang.UnsupportedOperationException

clearAttributes

void clearAttributes()
              throws java.lang.UnsupportedOperationException

Removes all the attributes of the element. A class implementing MinXML is not obliged to implement clearAttributes and may throw an UnsupportedOperationException.

Throws:

java.lang.UnsupportedOperationException - if the implementing class cannot support this method

trimToSize

void trimToSize()

This method signals that there will be no further updates to an element, at least for a while, and the implementation should consider this a good opportunity to compact the space used by this element and all child elements, including any shared elements. Implementations must be clear on whether any subsequent updates are allowed or forbidden. If subsequent updates are forbidden, the implementation must throw an IllegalStateException.

isntEmpty

boolean isntEmpty()

Returns true if the element has no children. It is the opposite of isEmpty().

Returns:

has no children

equals

boolean equals(java.lang.Object obj)

Specified by:

equals in interface java.util.Collection<MinXML>

Specified by:

equals in interface java.util.List<MinXML>

Overrides:

equals in class java.lang.Object

print

void print(java.io.PrintWriter pw)

Renders the element using the supplied PrintWriter. The rendering will not contain any newlines. This is the same as the string generated by toString().

Parameters:

pw - the PrintWriter to use.

print

void print(java.io.Writer w)

Renders the element to the supplied Writer.

Parameters:

w - the Writer to use.

prettyPrint

void prettyPrint(java.io.PrintWriter pw)

Renders the element using the supplied PrintWriter such that each start and end tag are on their own line and the children indented. The output always finishes with a newline.

Parameters:

pw - the PrintWriter to use.

prettyPrint

void prettyPrint(java.io.Writer w)

Renders the element using the supplied Writer such that each start and end tag are on their own line and the children indented. The output always finishes with a newline.

Parameters:

w - the Writer to use.

shallowCopy

@NonNull MinXML shallowCopy()

shallowCopy makes a copy of the topmost node but shares the children. The implementation of the new node must be at least as general as the implementation of this node i.e. implement all the methods that do not raise UnsupportedOperationException

Returns:

a shallow copy

deepCopy

@NonNull MinXML deepCopy()

deepCopy makes a copy of the topmost node and all the children. The implementation of the new nodes must be at least as general as the implementation of this node i.e. implement all the methods that do not raise UnsupportedOperationException

Returns:

a deep copy