|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.axiom.om.impl.llom.OMNodeImpl
org.apache.axiom.om.impl.llom.OMElementImpl
org.apache.abdera.parser.stax.FOMElement
org.apache.abdera.parser.stax.FOMExtensibleElement
org.apache.abdera.parser.stax.FOMCollection
public class FOMCollection
Field Summary |
---|
Fields inherited from class org.apache.axiom.om.impl.llom.OMElementImpl |
---|
attributes, DEFAULT_DEFAULT_NS_OBJECT, firstChild, lastChild, localName, namespaces, noPrefixNamespaceCounter, ns, qName |
Fields inherited from class org.apache.axiom.om.impl.llom.OMNodeImpl |
---|
builder, done, factory, nextSibling, nodeType, parent, previousSibling |
Fields inherited from interface org.apache.axiom.om.OMNode |
---|
CDATA_SECTION_NODE, COMMENT_NODE, DTD_NODE, ELEMENT_NODE, ENTITY_REFERENCE_NODE, PI_NODE, SPACE_NODE, TEXT_NODE |
Fields inherited from interface org.apache.axiom.om.OMConstants |
---|
ARRAY_ITEM_LOCALNAME, ARRAY_ITEM_NS_PREFIX, ARRAY_ITEM_NSURI, ARRAY_ITEM_QNAME, DATA_HANDLER, DEFAULT_CHAR_SET_ENCODING, DEFAULT_DEFAULT_NAMESPACE, DEFAULT_XML_VERSION, IS_BINARY, IS_DATA_HANDLERS_AWARE, PULL_TYPE_BUILDER, PUSH_TYPE_BUILDER, XMLATTRTYPE_CDATA, XMLATTRTYPE_ENTITIES, XMLATTRTYPE_ENTITY, XMLATTRTYPE_ID, XMLATTRTYPE_IDREF, XMLATTRTYPE_IDREFS, XMLATTRTYPE_NMTOKEN, XMLATTRTYPE_NMTOKENS, XMLATTRTYPE_NOTATION, XMLNS_NS_PREFIX, XMLNS_NS_URI, XMLNS_PREFIX, XMLNS_URI |
Constructor Summary | |
---|---|
|
FOMCollection()
|
protected |
FOMCollection(org.apache.axiom.om.OMContainer parent,
org.apache.axiom.om.OMFactory factory)
|
protected |
FOMCollection(org.apache.axiom.om.OMContainer parent,
org.apache.axiom.om.OMFactory factory,
org.apache.axiom.om.OMXMLParserWrapper builder)
|
protected |
FOMCollection(QName qname,
org.apache.axiom.om.OMContainer parent,
org.apache.axiom.om.OMFactory factory)
|
protected |
FOMCollection(QName qname,
org.apache.axiom.om.OMContainer parent,
org.apache.axiom.om.OMFactory factory,
org.apache.axiom.om.OMXMLParserWrapper builder)
|
protected |
FOMCollection(String name,
org.apache.axiom.om.OMNamespace namespace,
org.apache.axiom.om.OMContainer parent,
org.apache.axiom.om.OMFactory factory)
|
|
FOMCollection(String title,
String href,
String[] accepts)
|
Method Summary | |
---|---|
boolean |
accepts(javax.activation.MimeType mediaType)
Returns true if the collection accepts the given media-type |
boolean |
accepts(String mediaType)
Returns true if the collection accepts the given media-type |
boolean |
acceptsEntry()
Returns true if the collection accepts Atom entry documents (equivalent to calling accepts("application/atom+xml;type=entry");) |
boolean |
acceptsNothing()
Returns true if the collection accepts nothing (i.e. |
Collection |
addAccepts(String... mediaRanges)
Adds new accept elements to the collection |
Collection |
addAccepts(String mediaRange)
Adds a new accept element to the collection |
Collection |
addAcceptsEntry()
Same as setAcceptsEntry except the existing accepts are not discarded |
Categories |
addCategories()
Add an app:categories element |
Collection |
addCategories(Categories categories)
Add the app:categories element to the collection |
Categories |
addCategories(List<Category> categories,
boolean fixed,
String scheme)
Add a listing of categories to the collection |
Categories |
addCategories(String href)
Add an app:categories element that links to an external Category Document |
String[] |
getAccept()
Returns the listing of media-ranges allowed for this collection |
List<Categories> |
getCategories()
Returns the app:categories element |
IRI |
getHref()
Return the value of the app:collection elements href attribute |
IRI |
getResolvedHref()
Return the href attribute resolved against the in-scope Base URI |
String |
getTitle()
The text value of the collections atom:title element |
Text |
getTitleElement()
Return the title element |
Collection |
setAccept(String... mediaRanges)
Set the listing of media-ranges allowed for this collection. |
Collection |
setAccept(String mediaRange)
|
Collection |
setAcceptsEntry()
Sets the appropriate accept element to indicate that entries are accepted (equivalent to calling setAccept("application/atom+xml;type=entry");) |
Collection |
setAcceptsNothing()
Sets the collection so that nothing is accepted (equivalent to calling setAccept(""); ) |
Collection |
setHref(String href)
Set the value of the href attribute |
Text |
setTitle(String title)
Set the value of the collections atom:title element using type="text" |
Text |
setTitleAsHtml(String title)
Set the value of the collections atom:title element using type="html". |
Text |
setTitleAsXHtml(String title)
Set the value of the collections atom:title element using type="xhtml". |
Methods inherited from class org.apache.abdera.parser.stax.FOMExtensibleElement |
---|
addExtension, addExtension, addExtension, addExtension, addExtension, addExtensions, addSimpleExtension, addSimpleExtension, getExtension, getExtension, getExtensions, getExtensions, getExtensions, getSimpleExtension, getSimpleExtension |
Methods inherited from class org.apache.axiom.om.impl.llom.OMElementImpl |
---|
addAttribute, addAttribute, addChild, build, buildNext, buildWithAttachments, cloneOMElement, declareDefaultNamespace, declareNamespace, declareNamespace, detach, discard, findNamespace, findNamespaceURI, getAllAttributes, getAllDeclaredNamespaces, getAttribute, getBuilder, getChildElements, getChildren, getChildrenWithLocalName, getChildrenWithName, getChildrenWithNamespaceURI, getDefaultNamespace, getFirstChildWithName, getFirstElement, getFirstOMChild, getLineNumber, getLocalName, getNamespace, getNextOMSibling, getQName, getTextAsQName, getTrimmedText, getType, getXMLStreamReader, getXMLStreamReaderWithoutCaching, internalSerialize, internalSerialize, internalSerializeAndConsume, isComplete, notifyChildComplete, removeAttribute, resolveQName, setBuilder, setFirstChild, setLastChild, setLineNumber, setLocalName, setNamespace, setNamespaceWithNoFindInCurrentScope, setText, toString, toStringWithConsume |
Methods inherited from class org.apache.axiom.om.impl.llom.OMNodeImpl |
---|
close, getOMFactory, getParent, getPreviousOMSibling, importNode, insertSiblingAfter, insertSiblingBefore, serialize, serialize, serialize, serialize, serialize, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, setComplete, setNextOMSibling, setParent, setPreviousOMSibling, setType |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface org.apache.abdera.model.ExtensibleElement |
---|
addExtension, addExtension, addExtension, addExtension, addExtension, addSimpleExtension, addSimpleExtension, getExtension, getExtension, getExtensions, getExtensions, getExtensions, getSimpleExtension, getSimpleExtension |
Methods inherited from interface org.apache.abdera.model.Element |
---|
declareNS, discard, getAttributes, getAttributeValue, getAttributeValue, getBaseUri, getDocument, getElements, getExtensionAttributes, getFirstChild, getFirstChild, getLanguage, getLanguageTag, getLocale, getMustPreserveWhitespace, getNamespaces, getNextSibling, getNextSibling, getParentElement, getPreviousSibling, getPreviousSibling, getQName, getResolvedBaseUri, getText, removeAttribute, removeAttribute, setAttributeValue, setAttributeValue, setBaseUri, setBaseUri, setLanguage, setMustPreserveWhitespace, setParentElement, setText, setText |
Methods inherited from interface org.apache.abdera.model.Base |
---|
addComment, clone, complete, getDefaultWriterOptions, getFactory, writeTo, writeTo, writeTo, writeTo, writeTo, writeTo, writeTo, writeTo, writeTo, writeTo, writeTo, writeTo |
Methods inherited from interface java.lang.Iterable |
---|
iterator |
Methods inherited from interface org.apache.axiom.om.OMElement |
---|
addAttribute, addAttribute, cloneOMElement, declareDefaultNamespace, declareNamespace, declareNamespace, findNamespace, findNamespaceURI, getAllAttributes, getAllDeclaredNamespaces, getAttribute, getBuilder, getChildElements, getDefaultNamespace, getFirstElement, getLineNumber, getLocalName, getNamespace, getQName, getTextAsQName, getXMLStreamReader, getXMLStreamReaderWithoutCaching, removeAttribute, resolveQName, setBuilder, setFirstChild, setLineNumber, setLocalName, setNamespace, setNamespaceWithNoFindInCurrentScope, setText, toString, toStringWithConsume |
Methods inherited from interface org.apache.axiom.om.OMNode |
---|
build, buildWithAttachments, close, detach, discard, getNextOMSibling, getOMFactory, getParent, getPreviousOMSibling, getType, insertSiblingAfter, insertSiblingBefore, isComplete, serialize, serialize, serialize, serialize, serialize, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume |
Methods inherited from interface org.apache.axiom.om.OMContainer |
---|
addChild, buildNext, getChildren, getChildrenWithLocalName, getChildrenWithName, getChildrenWithNamespaceURI, getFirstChildWithName, getFirstOMChild, isComplete |
Methods inherited from interface org.apache.axiom.om.impl.OMContainerEx |
---|
setComplete |
Constructor Detail |
---|
public FOMCollection()
public FOMCollection(String title, String href, String[] accepts)
protected FOMCollection(String name, org.apache.axiom.om.OMNamespace namespace, org.apache.axiom.om.OMContainer parent, org.apache.axiom.om.OMFactory factory) throws org.apache.axiom.om.OMException
org.apache.axiom.om.OMException
protected FOMCollection(QName qname, org.apache.axiom.om.OMContainer parent, org.apache.axiom.om.OMFactory factory)
protected FOMCollection(QName qname, org.apache.axiom.om.OMContainer parent, org.apache.axiom.om.OMFactory factory, org.apache.axiom.om.OMXMLParserWrapper builder)
protected FOMCollection(org.apache.axiom.om.OMContainer parent, org.apache.axiom.om.OMFactory factory)
protected FOMCollection(org.apache.axiom.om.OMContainer parent, org.apache.axiom.om.OMFactory factory, org.apache.axiom.om.OMXMLParserWrapper builder)
Method Detail |
---|
public String getTitle()
Collection
getTitle
in interface Collection
public Text setTitle(String title)
Collection
setTitle
in interface Collection
title
- The value of the atom:title
public Text setTitleAsHtml(String title)
Collection
setTitleAsHtml
in interface Collection
title
- The value of the atom:title
public Text setTitleAsXHtml(String title)
Collection
setTitleAsXHtml
in interface Collection
title
- The value of the atom:title
public Text getTitleElement()
Collection
getTitleElement
in interface Collection
public IRI getHref()
Collection
getHref
in interface Collection
public IRI getResolvedHref()
Collection
getResolvedHref
in interface Collection
public Collection setHref(String href)
Collection
setHref
in interface Collection
href
- The value of href attributepublic String[] getAccept()
Collection
getAccept
in interface Collection
public Collection setAccept(String mediaRange)
public Collection setAccept(String... mediaRanges)
Collection
setAccept
in interface Collection
mediaRanges
- a listing of media-rangespublic Collection addAccepts(String mediaRange)
Collection
addAccepts
in interface Collection
public Collection addAccepts(String... mediaRanges)
Collection
addAccepts
in interface Collection
public Collection addAcceptsEntry()
Collection
addAcceptsEntry
in interface Collection
public Collection setAcceptsEntry()
Collection
setAcceptsEntry
in interface Collection
public Collection setAcceptsNothing()
Collection
setAcceptsNothing
in interface Collection
public boolean acceptsEntry()
Collection
acceptsEntry
in interface Collection
public boolean acceptsNothing()
Collection
acceptsNothing
in interface Collection
public boolean accepts(String mediaType)
Collection
accepts
in interface Collection
mediaType
- The media-type to check
public boolean accepts(javax.activation.MimeType mediaType)
Collection
accepts
in interface Collection
mediaType
- The media-type to check
public Categories addCategories()
Collection
addCategories
in interface Collection
public Collection addCategories(Categories categories)
Collection
addCategories
in interface Collection
categories
- The app:categories elementpublic Categories addCategories(String href)
Collection
addCategories
in interface Collection
href
- The IRI of the external Category Document
public Categories addCategories(List<Category> categories, boolean fixed, String scheme)
Collection
addCategories
in interface Collection
categories
- The listing of categories to addfixed
- True if the listing of categories should be fixedscheme
- The default IRI scheme for the categories listing
public List<Categories> getCategories()
Collection
getCategories
in interface Collection
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |