de.saxsys.svgfx.xml.core

Class ElementBase<TAttributeType extends AttributeWrapper,TAttributeHolder extends AttributeHolder<TAttributeType>,TDocumentDataProvider extends IDocumentDataProvider,TResult,TParent extends ElementBase<?,?,TDocumentDataProvider,?,?,?>,TChild extends ElementBase<?,?,TDocumentDataProvider,?,?,?>>

java.lang.Object

de.saxsys.svgfx.xml.core.ElementBase<TAttributeType,TAttributeHolder,TDocumentDataProvider,TResult,TParent,TChild>

Type Parameters:

TAttributeType - the type of the AttributeWrapper to be used

TAttributeHolder - the type of the AttributeHolder to be used

TDocumentDataProvider - the type of the IDocumentDataProvider to be used

TResult - the type of result provided by the element

TParent - the type of parent of this element

Direct Known Subclasses:

SVGElementBase

public abstract class ElementBase<TAttributeType extends AttributeWrapper,TAttributeHolder extends AttributeHolder<TAttributeType>,TDocumentDataProvider extends IDocumentDataProvider,TResult,TParent extends ElementBase<?,?,TDocumentDataProvider,?,?,?>,TChild extends ElementBase<?,?,TDocumentDataProvider,?,?,?>>
extends Object

Represents an actual element of the parsed document from an SAXParser.

Author:

Xyanid on 24.10.2015.

Constructor Summary

Constructors

Constructor and Description
ElementBase(String name, Attributes attributes, TParent parent, TDocumentDataProvider documentDataProvider, TAttributeHolder attributeHolder) Creates a new instance of he element using the given attributes, parent and documentDataProvider.

Method Summary

Modifier and Type	Method and Description
abstract boolean	canConsumeResult() Determines whether the result of this element will be requested or not.
abstract void	endProcessing() Will be called when the end of the element was been reached and thus the processing is finished.
TAttributeHolder	getAttributeHolder() Gets the attributeHolder.
Map<String,TAttributeType>	getAttributes() Gets the attribute map as an unmodifiable map.
TDocumentDataProvider	getDocumentDataProvider() Gets the documentDataProvider.
String	getName() Gets the value of the property.
TParent	getParent() Gets the parent.
abstract TResult	getResult() Returns the result for the current element.
List<TChild>	getUnmodifiableChildren() Gets an unmodifiable instance of the children.
abstract void	processCharacterData(char[] ch, int start, int length) Will be called when character data (CDATA) is read for an element.
abstract boolean	rememberElement() Determines if the element will be kept, meaning it will be kept in memory and is available as a parent for all its children.
abstract void	startProcessing() Will be called when an element is started that represents this element.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ElementBase

public ElementBase(String name,
                   Attributes attributes,
                   TParent parent,
                   TDocumentDataProvider documentDataProvider,
                   TAttributeHolder attributeHolder)
            throws IllegalArgumentException

Creates a new instance of he element using the given attributes, parent and documentDataProvider.

Parameters:

name - value of the element, must not be null

attributes - attributes to be used

parent - parent of the element

documentDataProvider - documentDataProvider to be used, must not be null

attributeHolder - the element that will contain the attributes of this element.

Throws:

IllegalArgumentException - if either value or documentDataProvider are null

Method Detail

getName

public String getName()

Gets the value of the property.

Returns:

the name of the element

getAttributes

public final Map<String,TAttributeType> getAttributes()

Gets the attribute map as an unmodifiable map.

Returns:

the map of the attributes

getParent

public TParent getParent()

Gets the parent.

Returns:

the parent

getDocumentDataProvider

public TDocumentDataProvider getDocumentDataProvider()

Gets the documentDataProvider.

Returns:

the documentDataProvider

getAttributeHolder

public TAttributeHolder getAttributeHolder()

Gets the attributeHolder.

Returns:

the attributeHolder

getUnmodifiableChildren

public List<TChild> getUnmodifiableChildren()

Gets an unmodifiable instance of the children.

Returns:

an unmodifiable instance of the children

rememberElement

public abstract boolean rememberElement()

Determines if the element will be kept, meaning it will be kept in memory and is available as a parent for all its children.

Returns:

true if the element will be kept, otherwise false.

startProcessing

public abstract void startProcessing()
                              throws SAXException

Will be called when an element is started that represents this element.

Throws:

SAXException - will be thrown when an error occurs during processing

processCharacterData

public abstract void processCharacterData(char[] ch,
                                          int start,
                                          int length)
                                   throws SAXException

Will be called when character data (CDATA) is read for an element.

Parameters:

ch - The characters.

start - The start position in the character array.

length - The number of characters to use from the character array.

Throws:

SAXException - will be thrown when an error occurs during processing the characters

endProcessing

public abstract void endProcessing()
                            throws SAXException

Will be called when the end of the element was been reached and thus the processing is finished.

Throws:

SAXException - will be thrown when an error occurs during processing

canConsumeResult

public abstract boolean canConsumeResult()

Determines whether the result of this element will be requested or not. A call to this method should be made prior to the getResult().

Returns:

true if the element can be consume, otherwise false.

getResult

public abstract TResult getResult()
                           throws SAXException

Returns the result for the current element.

Returns:

result for the element

Throws:

SAXException - will be thrown when an error occurs retrieving the result

toString

public String toString()

Overrides:

toString in class Object