|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Collection
Represents an collection element in an Atom Publishing Protocol introspection document.
The "app:collection" describes an Atom Protocol collection. One child element is defined here for app:collection: "app:member-type". appCollection = element app:collection { appCommonAttributes, attribute href { text }, ( atomTitle & appAccept & extensionElement* ) }
Method Summary | |
---|---|
boolean |
accepts(javax.activation.MimeType mediaType)
Returns true if the collection accepts the given media-type |
boolean |
accepts(java.lang.String mediaType)
Returns true if the collection accepts the given media-type |
Categories |
addCategories()
Add an app:categories element |
void |
addCategories(Categories categories)
Add the app:categories element to the collection |
Categories |
addCategories(java.util.List<Category> categories,
boolean fixed,
java.lang.String scheme)
Add a listing of categories to the collection |
Categories |
addCategories(java.lang.String href)
Add an app:categories element that links to an external Category Document |
java.lang.String[] |
getAccept()
Returns the listing of media-ranges allowed for this collection |
Element |
getAcceptElement()
Returns the app:accept element |
java.util.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 |
java.lang.String |
getTitle()
The text value of the collections atom:title element |
Text |
getTitleElement()
Return the title element |
void |
setAccept(java.lang.String... mediaRanges)
Set the listing of media-ranges allowed for this collection. |
void |
setHref(java.lang.String href)
Set the value of the href attribute |
Text |
setTitle(java.lang.String title)
Set the value of the collections atom:title element using type="text" |
Text |
setTitleAsHtml(java.lang.String title)
Set the value of the collections atom:title element using type="html". |
Text |
setTitleAsXHtml(java.lang.String title)
Set the value of the collections atom:title element using type="xhtml". |
Methods inherited from interface org.apache.abdera.model.ExtensibleElement |
---|
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, 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 |
---|
java.lang.String getTitle()
Text setTitle(java.lang.String title)
title
- The value of the atom:title
Text setTitleAsHtml(java.lang.String title)
title
- The value of the atom:title
Text setTitleAsXHtml(java.lang.String title)
title
- The value of the atom:title
Text getTitleElement()
IRI getHref() throws IRISyntaxException
IRISyntaxException
- if the value of the href attribute is malformedIRI getResolvedHref() throws IRISyntaxException
IRISyntaxException
- if the value of the href attribute is malformedvoid setHref(java.lang.String href) throws IRISyntaxException
href
- The value of href attribute
IRISyntaxException
- if the href attribute is malformedElement getAcceptElement()
java.lang.String[] getAccept()
void setAccept(java.lang.String... mediaRanges)
mediaRanges
- a listing of media-rangesboolean accepts(java.lang.String mediaType)
mediaType
- The media-type to check
boolean accepts(javax.activation.MimeType mediaType)
mediaType
- The media-type to check
java.util.List<Categories> getCategories()
Categories addCategories()
Categories addCategories(java.lang.String href) throws IRISyntaxException
href
- The IRI of the external Category Document
IRISyntaxException
- if the href value is malformedvoid addCategories(Categories categories)
categories
- The app:categories elementCategories addCategories(java.util.List<Category> categories, boolean fixed, java.lang.String scheme) throws IRISyntaxException
categories
- The listing of categories to addfixed
- True if the listing of categories should be fixedscheme
- The default IRI scheme for the categories listing
IRISyntaxException
- if the scheme value if malformed
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |