com.steelypip.powerups.minxml

Class AbsMinXML

java.lang.Object

com.steelypip.powerups.minxml.AbsMinXML

All Implemented Interfaces:

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

Direct Known Subclasses:

AbsFlexiMinXML

public abstract class AbsMinXML
extends java.lang.Object
implements MinXML

This is a abstract class for simplifying writing MinXML implementations. To utilize it, the implementation has to implement the element name (via getName/setName), the attributes as a {{Javadoc:SE|class=Map<String,String>|java/util|Map}}, and the children as a {{Javadoc:SE|class=List<String>|java/util|List}}.

Constructor Summary

Constructors

Constructor and Description
AbsMinXML()

Method Summary

Modifier and Type	Method and Description
void	add(int index, @NonNull MinXML element)
boolean	add(@NonNull MinXML e)
boolean	addAll(java.util.Collection<? extends MinXML> c)
boolean	addAll(int index, java.util.Collection<? extends MinXML> c)
abstract 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	clear()
void	clearAttributes() Removes all the attributes of the element.
boolean	contains(java.lang.Object o)
boolean	containsAll(java.util.Collection<?> c)
@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 o)
@NonNull MinXML	get(int index)
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 default_value) 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.
abstract @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.
int	hashCode()
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.
int	indexOf(java.lang.Object o)
boolean	isEmpty()
boolean	isntEmpty() Returns true if the element has no children.
java.util.Iterator<MinXML>	iterator()
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).
int	lastIndexOf(java.lang.Object o)
java.util.ListIterator<MinXML>	listIterator()
java.util.ListIterator<MinXML>	listIterator(int index)
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.
abstract java.util.Map<java.lang.String,java.lang.String>	quickGetAttributes() This method will return a map representing the attributes of the element that is safe to use until the first update of the original element.
@NonNull MinXML	remove(int index)
boolean	remove(java.lang.Object o)
boolean	removeAll(java.util.Collection<?> c)
boolean	retainAll(java.util.Collection<?> c)
@NonNull MinXML	set(int index, @NonNull MinXML element)
abstract 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	size()
int	sizeAttributes() Returns the number of attributes of the element.
java.util.List<MinXML>	subList(int fromIndex, int toIndex)
java.lang.Object[]	toArray()
<T> T[]	toArray(T[] a)
abstract java.util.List<MinXML>	toList()
java.lang.String	toString()
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 class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.List

replaceAll, sort, spliterator

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

AbsMinXML

public AbsMinXML()

Method Detail

getName

public abstract @NonNull java.lang.String getName()

Description copied from interface: MinXML

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

Specified by:

getName in interface MinXML

Returns:

the element name

setName

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

Description copied from interface: MinXML

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.

Specified by:

setName in interface MinXML

Parameters:

name - the name we are setting

Throws:

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

asMap

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

Description copied from interface: MinXML

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

Specified by:

asMap in interface MinXML

Returns:

the sharing map

quickGetAttributes

public abstract java.util.Map<java.lang.String,java.lang.String> quickGetAttributes()

This method will return a map representing the attributes of the element that is safe to use until the first update of the original element. Any update to the original element invalidates this object.

Returns:

map of attributes that is only safe until the next update

toList

public abstract java.util.List<MinXML> toList()

getAttributes

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

Description copied from interface: MinXML

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.

Specified by:

getAttributes in interface MinXML

Returns:

map of attributes

trimToSize

public void trimToSize()

Description copied from interface: MinXML

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.

Specified by:

trimToSize in interface MinXML

add

public void add(int index,
                @NonNull MinXML element)

Specified by:

add in interface java.util.List<MinXML>

add

public boolean add(@NonNull MinXML e)

Specified by:

add in interface java.util.Collection<MinXML>

Specified by:

add in interface java.util.List<MinXML>

addAll

public boolean addAll(java.util.Collection<? extends MinXML> c)

Specified by:

addAll in interface java.util.Collection<MinXML>

Specified by:

addAll in interface java.util.List<MinXML>

addAll

public boolean addAll(int index,
                      java.util.Collection<? extends MinXML> c)

Specified by:

addAll in interface java.util.List<MinXML>

clear

public void clear()

Specified by:

clear in interface java.util.Collection<MinXML>

Specified by:

clear in interface java.util.List<MinXML>

contains

public boolean contains(java.lang.Object o)

Specified by:

contains in interface java.util.Collection<MinXML>

Specified by:

contains in interface java.util.List<MinXML>

containsAll

public boolean containsAll(java.util.Collection<?> c)

Specified by:

containsAll in interface java.util.Collection<MinXML>

Specified by:

containsAll in interface java.util.List<MinXML>

equals

public boolean equals(java.lang.Object o)

Specified by:

equals in interface MinXML

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

get

public @NonNull MinXML get(int index)

Specified by:

get in interface java.util.List<MinXML>

hashCode

public int hashCode()

Specified by:

hashCode in interface java.util.Collection<MinXML>

Specified by:

hashCode in interface java.util.List<MinXML>

Overrides:

hashCode in class java.lang.Object

indexOf

public int indexOf(java.lang.Object o)

Specified by:

indexOf in interface java.util.List<MinXML>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface java.util.Collection<MinXML>

Specified by:

isEmpty in interface java.util.List<MinXML>

iterator

public java.util.Iterator<MinXML> iterator()

Specified by:

iterator in interface java.lang.Iterable<MinXML>

Specified by:

iterator in interface java.util.Collection<MinXML>

Specified by:

iterator in interface java.util.List<MinXML>

lastIndexOf

public int lastIndexOf(java.lang.Object o)

Specified by:

lastIndexOf in interface java.util.List<MinXML>

listIterator

public java.util.ListIterator<MinXML> listIterator()

Specified by:

listIterator in interface java.util.List<MinXML>

listIterator

public java.util.ListIterator<MinXML> listIterator(int index)

Specified by:

listIterator in interface java.util.List<MinXML>

remove

public @NonNull MinXML remove(int index)

Specified by:

remove in interface java.util.List<MinXML>

remove

public boolean remove(java.lang.Object o)

Specified by:

remove in interface java.util.Collection<MinXML>

Specified by:

remove in interface java.util.List<MinXML>

removeAll

public boolean removeAll(java.util.Collection<?> c)

Specified by:

removeAll in interface java.util.Collection<MinXML>

Specified by:

removeAll in interface java.util.List<MinXML>

retainAll

public boolean retainAll(java.util.Collection<?> c)

Specified by:

retainAll in interface java.util.Collection<MinXML>

Specified by:

retainAll in interface java.util.List<MinXML>

set

public @NonNull MinXML set(int index,
                           @NonNull MinXML element)

Specified by:

set in interface java.util.List<MinXML>

size

public int size()

Specified by:

size in interface java.util.Collection<MinXML>

Specified by:

size in interface java.util.List<MinXML>

subList

public java.util.List<MinXML> subList(int fromIndex,
                                      int toIndex)

Specified by:

subList in interface java.util.List<MinXML>

toArray

public java.lang.Object[] toArray()

Specified by:

toArray in interface java.util.Collection<MinXML>

Specified by:

toArray in interface java.util.List<MinXML>

toArray

public <T> T[] toArray(T[] a)

Specified by:

toArray in interface java.util.Collection<MinXML>

Specified by:

toArray in interface java.util.List<MinXML>

hasName

public boolean hasName(java.lang.String name)

Description copied from interface: MinXML

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

Specified by:

hasName in interface MinXML

Parameters:

name - the name we are checking

Returns:

true if the element has that name

getAttribute

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

Description copied from interface: MinXML

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

Specified by:

getAttribute in interface MinXML

Parameters:

key - the attribute key being looked up

Returns:

the associated value or null

getAttribute

public java.lang.String getAttribute(java.lang.String key,
                                     java.lang.String default_value)

Description copied from interface: MinXML

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.

Specified by:

getAttribute in interface MinXML

Parameters:

key - the attribute key being looked up

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

Returns:

the associated value

hasAttribute

public boolean hasAttribute()

Description copied from interface: MinXML

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

Specified by:

hasAttribute in interface MinXML

Returns:

true if the element has 0 or more attributes.

hasAttribute

public boolean hasAttribute(java.lang.String key)

Description copied from interface: MinXML

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

Specified by:

hasAttribute in interface MinXML

Parameters:

key - the attribute key

Returns:

true if the element has an attribute with that key

hasAttribute

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

Description copied from interface: MinXML

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

Specified by:

hasAttribute in interface MinXML

Parameters:

key - attribute being checked

value - value being checked

Returns:

true if the element has a matching attribute

hasntAttribute

public boolean hasntAttribute()

Description copied from interface: MinXML

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

Specified by:

hasntAttribute in interface MinXML

Returns:

has no attributes

sizeAttributes

public int sizeAttributes()

Description copied from interface: MinXML

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.

Specified by:

sizeAttributes in interface MinXML

Returns:

number of attributes.

keys

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

Description copied from interface: MinXML

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.

Specified by:

keys in interface MinXML

Returns:

iterator over keys

asMapKeys

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

Description copied from interface: MinXML

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

Specified by:

asMapKeys in interface MinXML

Returns:

the iterator.

entries

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

Description copied from interface: MinXML

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.

Specified by:

entries in interface MinXML

Returns:

iterator over entries

asMapEntries

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

Description copied from interface: MinXML

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

Specified by:

asMapEntries in interface MinXML

Returns:

the sharing iterator

putAttribute

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

Description copied from interface: MinXML

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.

Specified by:

putAttribute in interface MinXML

Parameters:

key - the attribute key

value - the attribute value

Throws:

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

putAllAttributes

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

Specified by:

putAllAttributes in interface MinXML

Throws:

java.lang.UnsupportedOperationException

clearAttributes

public void clearAttributes()
                     throws java.lang.UnsupportedOperationException

Description copied from interface: MinXML

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

Specified by:

clearAttributes in interface MinXML

Throws:

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

isntEmpty

public boolean isntEmpty()

Description copied from interface: MinXML

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

Specified by:

isntEmpty in interface MinXML

Returns:

has no children

print

public void print(java.io.Writer w)

Description copied from interface: MinXML

Renders the element to the supplied Writer.

Specified by:

print in interface MinXML

Parameters:

w - the Writer to use.

prettyPrint

public void prettyPrint(java.io.Writer w)

Description copied from interface: MinXML

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.

Specified by:

prettyPrint in interface MinXML

Parameters:

w - the Writer to use.

print

public void print(java.io.PrintWriter pw)

Description copied from interface: MinXML

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

Specified by:

print in interface MinXML

Parameters:

pw - the PrintWriter to use.

prettyPrint

public void prettyPrint(java.io.PrintWriter pw)

Description copied from interface: MinXML

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.

Specified by:

prettyPrint in interface MinXML

Parameters:

pw - the PrintWriter to use.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

shallowCopy

public @NonNull MinXML shallowCopy()

Description copied from interface: MinXML

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

Specified by:

shallowCopy in interface MinXML

Returns:

a shallow copy

deepCopy

public @NonNull MinXML deepCopy()

Description copied from interface: MinXML

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

Specified by:

deepCopy in interface MinXML

Returns:

a deep copy