org.apache.abdera.model
Interface ExtensibleElement

All Superinterfaces:
Base, java.lang.Cloneable, Element
All Known Subinterfaces:
Categories, Category, Collection, Control, Div, Entry, Feed, Link, Person, Service, Source, Workspace
All Known Implementing Classes:
ExtensibleElementWrapper, MediaContent, MediaGroup

public interface ExtensibleElement
extends Element

An abstract element that can be extended with namespaced child elements


Method Summary
 void addExtension(Element extension)
          Adds an individual extension element
<T extends Element>
T
addExtension(javax.xml.namespace.QName qname)
          Adds an individual extension element
<T extends Element>
T
addExtension(java.lang.String namespace, java.lang.String localPart, java.lang.String prefix)
          Adds an individual extension element
 Element addSimpleExtension(javax.xml.namespace.QName qname, java.lang.String value)
          Adds a simple extension (text content only)
 Element addSimpleExtension(java.lang.String namespace, java.lang.String localPart, java.lang.String prefix, java.lang.String value)
          Adds a simple extension (text content only)
<T extends Element>
T
getExtension(java.lang.Class<T> _class)
          Find an extension by Class rather than QName
<T extends Element>
T
getExtension(javax.xml.namespace.QName qname)
          Returns the first extension element with the XML qualified name
 java.util.List<Element> getExtensions()
          Returns the complete set of extension elements
<T extends Element>
java.util.List<T>
getExtensions(javax.xml.namespace.QName qname)
          Returns the complete set of extension elements using the specified XML qualified name
 java.util.List<Element> getExtensions(java.lang.String uri)
          Returns the complete set of extension elements using the specified XML Namespace URI
 java.lang.String getSimpleExtension(javax.xml.namespace.QName qname)
          Gets the value of a simple extension
 java.lang.String getSimpleExtension(java.lang.String namespace, java.lang.String localPart, java.lang.String prefix)
          Gets the value of a simple extension
 
Methods inherited from interface org.apache.abdera.model.Element
declareNS, discard, getAttributes, getAttributeValue, getAttributeValue, getBaseUri, getDocument, getExtensionAttributes, getFirstChild, getFirstChild, getLanguage, getLanguageTag, getLocale, getNextSibling, getNextSibling, getParentElement, getPreviousSibling, getPreviousSibling, getQName, getResolvedBaseUri, getText, removeAttribute, setAttributeValue, setAttributeValue, setBaseUri, setBaseUri, setLanguage, setParentElement, setText
 
Methods inherited from interface org.apache.abdera.model.Base
addComment, clone, getFactory, writeTo, writeTo
 

Method Detail

getExtensions

java.util.List<Element> getExtensions()
Returns the complete set of extension elements

Returns:
a listing of extensions

getExtensions

java.util.List<Element> getExtensions(java.lang.String uri)
Returns the complete set of extension elements using the specified XML Namespace URI

Parameters:
uri - A namespace URI
Returns:
A listing of extensions using the specified XML namespace

getExtensions

<T extends Element> java.util.List<T> getExtensions(javax.xml.namespace.QName qname)
Returns the complete set of extension elements using the specified XML qualified name

Parameters:
qname - An XML QName
Returns:
A listing of extensions with the specified QName

getExtension

<T extends Element> T getExtension(javax.xml.namespace.QName qname)
Returns the first extension element with the XML qualified name

Parameters:
qname - An XML QName
Returns:
An extension with the specified qname

addExtension

void addExtension(Element extension)
Adds an individual extension element

Parameters:
extension - An extension element to add

addExtension

<T extends Element> T addExtension(javax.xml.namespace.QName qname)
Adds an individual extension element

Parameters:
qname - An extension element to create
Returns:
The newly created extension element

addExtension

<T extends Element> T addExtension(java.lang.String namespace,
                                   java.lang.String localPart,
                                   java.lang.String prefix)
Adds an individual extension element

Parameters:
namespace - An XML namespace
localPart - A localname
prefix - A XML namespace prefix
Returns:
The newly creatd extension element

addSimpleExtension

Element addSimpleExtension(javax.xml.namespace.QName qname,
                           java.lang.String value)
Adds a simple extension (text content only)

Parameters:
qname - An XML QName
value - The simple text value of the element
Returns:
The newly created extension element

addSimpleExtension

Element addSimpleExtension(java.lang.String namespace,
                           java.lang.String localPart,
                           java.lang.String prefix,
                           java.lang.String value)
Adds a simple extension (text content only)

Parameters:
namespace - An XML namespace
localPart - A local name
prefix - A namespace prefix
value - The simple text value
Returns:
The newly created extension element

getSimpleExtension

java.lang.String getSimpleExtension(javax.xml.namespace.QName qname)
Gets the value of a simple extension

Parameters:
qname - An XML QName
Returns:
The string value of the extension

getSimpleExtension

java.lang.String getSimpleExtension(java.lang.String namespace,
                                    java.lang.String localPart,
                                    java.lang.String prefix)
Gets the value of a simple extension

Parameters:
namespace - An XML namespace
localPart - A localname
prefix - A namespace prefix
Returns:
The string value of the extension

getExtension

<T extends Element> T getExtension(java.lang.Class<T> _class)
Find an extension by Class rather than QName

Parameters:
_class - The implementation class of the extension
Returns:
The extension element