|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.wink.common.categories.Categories
public class Categories
The Atom Publishing Protocol introduces the notion of a "Category Document" and the app:categories element. These are used to provide a listing of atom:Category elements that may be used with the members of an Atom Publishing Protocol collection.
Constructor Summary | |
---|---|
Categories()
Constructor |
|
Categories(java.util.List<AtomCategory> categories)
Constructor |
Method Summary | |
---|---|
Categories |
addCategory(AtomCategory category)
Add an atom:Category to the listing |
AtomCategory |
addCategory(java.lang.String term)
Create and add an atom:Category to the listing |
AtomCategory |
addCategory(java.lang.String scheme,
java.lang.String term,
java.lang.String label)
Create an add an atom:Category to the listing |
boolean |
contains(java.lang.String term)
Returns true if this app:categories listing contains a Category with the specified term |
boolean |
contains(java.lang.String term,
java.lang.String scheme)
Returns true if this app:categories listing contains a Category with the specified term and scheme |
java.util.List<AtomCategory> |
getCategories()
Lists the complete set of categories |
java.util.List<AtomCategory> |
getCategories(java.lang.String scheme)
Lists the complete set of categories that use the specified scheme |
java.lang.Class<?> |
getHandlingClass()
Get Categories Document handling Resource class |
java.lang.Object |
getHandlingInstance()
Get handling Bean for Categories Document |
java.lang.String |
getHref()
When contained within an app:collection element, the app:categories element can have an href attribute whose value MUST point to an Atompub Categories Document. |
java.lang.String |
getScheme()
The app:categories element may specify a default scheme attribute for listed atom:Category elements that do not have their own scheme attribute. |
javax.ws.rs.core.MultivaluedMap<java.lang.String,java.lang.String> |
getTemplateParameters()
Get Uri Template Variables |
boolean |
isFixed()
If an app:categories element is marked as fixed, then the set of atom:Category elements is considered to be a closed set. |
boolean |
isOutOfLine()
Returns true if the href attribute is set |
void |
setCategories(java.util.List<AtomCategory> categories)
Set a list of categories |
Categories |
setFixed(boolean fixed)
Sets whether or not this is a fixed listing of categories. |
void |
setHref(java.lang.Class<?> handlingClass,
javax.ws.rs.core.MultivaluedMap<java.lang.String,java.lang.String> templateParams)
Set Resource class that will generate Categories Document |
void |
setHref(java.lang.Object handlingInstance,
javax.ws.rs.core.MultivaluedMap<java.lang.String,java.lang.String> templateParams)
Set Resource that will generate Categories Document |
Categories |
setHref(java.lang.String href)
Sets the value of the href attribute. |
Categories |
setScheme(java.lang.String scheme)
Sets the default scheme for this listing of categories |
void |
setTemplateParameters(javax.ws.rs.core.MultivaluedMap<java.lang.String,java.lang.String> templateParams)
Set Uri Template Variables |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public Categories(java.util.List<AtomCategory> categories)
categories
- public Categories()
categories
- Method Detail |
---|
public java.lang.String getHref()
public Categories setHref(java.lang.String href)
href
- The location of an Atompub Categories Documentpublic void setHref(java.lang.Class<?> handlingClass, javax.ws.rs.core.MultivaluedMap<java.lang.String,java.lang.String> templateParams)
handlingClass
- Resource ClasstemplateParams
- Map of URI variable names and their valuespublic void setHref(java.lang.Object handlingInstance, javax.ws.rs.core.MultivaluedMap<java.lang.String,java.lang.String> templateParams)
handlingInstance
- Resource instancetemplateParams
- Map of URI variable names and their valuespublic boolean isFixed()
public Categories setFixed(boolean fixed)
fixed
- True if the app:categories listing is fixedpublic java.lang.String getScheme()
public Categories setScheme(java.lang.String scheme)
scheme
- The default scheme used for this listing of categoriespublic java.util.List<AtomCategory> getCategories()
public java.util.List<AtomCategory> getCategories(java.lang.String scheme)
scheme
- The String of an atom:Category scheme
public Categories addCategory(AtomCategory category)
Category
- The atom:Category to add to the listingpublic AtomCategory addCategory(java.lang.String term)
term
- The string term
public AtomCategory addCategory(java.lang.String scheme, java.lang.String term, java.lang.String label)
scheme
- The scheme String for the newly created Categoryterm
- The string termlabel
- The human readable label for the Category
public boolean contains(java.lang.String term)
term
- The term to look for
public boolean contains(java.lang.String term, java.lang.String scheme)
term
- The term to look forscheme
- The String scheme
public boolean isOutOfLine()
public java.lang.Class<?> getHandlingClass()
public void setCategories(java.util.List<AtomCategory> categories)
categories
- public java.lang.Object getHandlingInstance()
public javax.ws.rs.core.MultivaluedMap<java.lang.String,java.lang.String> getTemplateParameters()
public void setTemplateParameters(javax.ws.rs.core.MultivaluedMap<java.lang.String,java.lang.String> templateParams)
templateParams
-
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |