com.steelypip.powerups.minxml

Class AbsFlexiMinXML

java.lang.Object

com.steelypip.powerups.minxml.AbsMinXML

com.steelypip.powerups.minxml.AbsFlexiMinXML

All Implemented Interfaces:

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

Direct Known Subclasses:

FlexiMinXML

public abstract class AbsFlexiMinXML
extends AbsMinXML

This is a support class for FlexiMinXML that provides a layer for managing the allocation of the TreeMap and the ArrayList.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.TreeMap<java.lang.String,java.lang.String>	attributes
protected java.util.ArrayList<MinXML>	children
protected @NonNull java.lang.String	name

Constructor Summary

Constructors

Constructor and Description
AbsFlexiMinXML(@NonNull java.lang.String name)

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.
@NonNull java.lang.String	getName() Returns the name of a MinXML element.
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.
void	setName(@NonNull java.lang.String name) Changes the name of the element to the given string.
java.util.List<MinXML>	toList()

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

add, add, addAll, addAll, asMapEntries, asMapKeys, clear, clearAttributes, contains, containsAll, deepCopy, entries, equals, get, getAttribute, getAttribute, getAttributes, hasAttribute, hasAttribute, hasAttribute, hashCode, hasName, hasntAttribute, indexOf, isEmpty, isntEmpty, iterator, keys, lastIndexOf, listIterator, listIterator, prettyPrint, prettyPrint, print, print, putAllAttributes, putAttribute, remove, remove, removeAll, retainAll, set, shallowCopy, size, sizeAttributes, subList, toArray, toArray, toString, trimToSize

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

Field Detail

name

protected @NonNull java.lang.String name

attributes

protected java.util.TreeMap<java.lang.String,java.lang.String> attributes

children

protected java.util.ArrayList<MinXML> children

Constructor Detail

AbsFlexiMinXML

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

Method Detail

getName

public @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

Specified by:

getName in class AbsMinXML

Returns:

the element name

setName

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

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

Specified by:

setName in class AbsMinXML

Parameters:

name - the name we are setting

asMap

public 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

Specified by:

asMap in class AbsMinXML

Returns:

the sharing map

quickGetAttributes

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

Description copied from class: AbsMinXML

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.

Specified by:

quickGetAttributes in class AbsMinXML

Returns:

map of attributes that is only safe until the next update

toList

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

Specified by:

toList in class AbsMinXML