com.steelypip.powerups.minxml

Class FlexiMinXML

java.lang.Object

com.steelypip.powerups.minxml.AbsMinXML

com.steelypip.powerups.minxml.AbsFlexiMinXML

com.steelypip.powerups.minxml.FlexiMinXML

All Implemented Interfaces:

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

public class FlexiMinXML
extends AbsFlexiMinXML

This implementation provides a full implementation of all the mandatory and optional methods of the MinXML interface. It aims to strike a balance between fast access, update and reasonable compactness in the most important cases. A TreeMap is used to track attributes and an ArrayList to track children; these provide good performance at the expense of space. However, when there are no attributes the TreeMap is not allocated and when there are no children the ArrayList is not allocated; these two cases are so common that the reduction in space is (typically) significant.

Field Summary

Fields inherited from class com.steelypip.powerups.minxml.AbsFlexiMinXML

attributes, children, name

Constructor Summary

Constructors

Constructor and Description
FlexiMinXML(@NonNull java.lang.String name) Constructs an element with a given name but no attributes or children.

Method Summary

Modifier and Type	Method and Description
void	clear()
boolean	contains(java.lang.Object o)
boolean	containsAll(java.util.Collection<?> c)
static @NonNull FlexiMinXML	deepCopy(@NonNull MinXML element)
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).
static MinXML	fromString(java.lang.String input)
java.lang.String	getAttribute(java.lang.String key) Gets the attribute value associated with a given key.
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	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)
static @NonNull FlexiMinXML	shallowCopy(@NonNull MinXML element) Creates a copy of the top-level node of the given element.
int	size()
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 class com.steelypip.powerups.minxml.AbsFlexiMinXML

asMap, getName, quickGetAttributes, setName, toList

Methods inherited from class com.steelypip.powerups.minxml.AbsMinXML

add, add, addAll, addAll, asMapEntries, asMapKeys, clearAttributes, deepCopy, equals, get, getAttribute, getAttributes, hashCode, hasName, listIterator, listIterator, prettyPrint, prettyPrint, print, print, putAllAttributes, putAttribute, remove, remove, removeAll, retainAll, set, shallowCopy, subList, toArray, toArray, toString

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

FlexiMinXML

public FlexiMinXML(@NonNull java.lang.String name)

Constructs an element with a given name but no attributes or children.

Parameters:

name - the name of the element

Method Detail

fromString

public static MinXML fromString(java.lang.String input)

shallowCopy

public static @NonNull FlexiMinXML shallowCopy(@NonNull MinXML element)

Creates a copy of the top-level node of the given element.

Parameters:

element - the element to copy

Returns:

the copy

deepCopy

public static @NonNull FlexiMinXML deepCopy(@NonNull MinXML element)

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

Overrides:

trimToSize in class AbsMinXML

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

Overrides:

getAttribute in class AbsMinXML

Parameters:

key - the attribute key being looked up

Returns:

the associated value or null

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

Overrides:

hasAttribute in class AbsMinXML

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

Overrides:

hasAttribute in class AbsMinXML

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

Overrides:

hasAttribute in class AbsMinXML

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

Overrides:

hasntAttribute in class AbsMinXML

Returns:

has no 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

Overrides:

keys in class AbsMinXML

Returns:

iterator over keys

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

Overrides:

sizeAttributes in class AbsMinXML

Returns:

number of attributes.

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

Overrides:

entries in class AbsMinXML

Returns:

iterator over entries

clear

public void clear()

Specified by:

clear in interface java.util.Collection<MinXML>

Specified by:

clear in interface java.util.List<MinXML>

Overrides:

clear in class AbsMinXML

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>

Overrides:

contains in class AbsMinXML

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>

Overrides:

containsAll in class AbsMinXML

indexOf

public int indexOf(java.lang.Object o)

Specified by:

indexOf in interface java.util.List<MinXML>

Overrides:

indexOf in class AbsMinXML

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface java.util.Collection<MinXML>

Specified by:

isEmpty in interface java.util.List<MinXML>

Overrides:

isEmpty in class AbsMinXML

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>

Overrides:

iterator in class AbsMinXML

lastIndexOf

public int lastIndexOf(java.lang.Object o)

Specified by:

lastIndexOf in interface java.util.List<MinXML>

Overrides:

lastIndexOf in class AbsMinXML

size

public int size()

Specified by:

size in interface java.util.Collection<MinXML>

Specified by:

size in interface java.util.List<MinXML>

Overrides:

size in class AbsMinXML

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

Overrides:

isntEmpty in class AbsMinXML

Returns:

has no children