Package org.restlet.ext.atom

Class Categories

java.lang.Object

org.restlet.representation.Variant

org.restlet.representation.RepresentationInfo

org.restlet.representation.Representation

org.restlet.representation.CharacterRepresentation

org.restlet.representation.WriterRepresentation

org.restlet.ext.xml.XmlRepresentation

org.restlet.ext.xml.SaxRepresentation

org.restlet.ext.atom.Categories

All Implemented Interfaces:

javax.xml.namespace.NamespaceContext

public class Categories
extends SaxRepresentation

Collection of Category entries.

Field Summary

Fields

Modifier and Type	Field	Description
private Reference	baseReference	The base reference used to resolve relative references found within the scope of the xml:base attribute.
private java.util.List<Category>	entries	The list of entries.
private boolean	fixed	Indicates if the list is fixed.
private Reference	scheme

Fields inherited from class org.restlet.ext.xml.SaxRepresentation

XML_SECURE_PROCESSING

Fields inherited from class org.restlet.ext.xml.XmlRepresentation

XML_EXPANDING_ENTITY_REFS, XML_VALIDATING_DTD

Fields inherited from class org.restlet.representation.Representation

UNKNOWN_SIZE

Constructor Summary

Constructors

Constructor	Description
Categories(java.lang.String categoriesUri)	Constructor.
Categories(Client clientDispatcher, java.lang.String categoriesUri)	Constructor.
Categories(Context context, java.lang.String categoriesUri)	Constructor.
Categories(Representation categoriesFeed)	Constructor.

Method Summary

Modifier and Type	Method	Description
Reference	getBaseReference()	Returns the base reference used to resolve relative references found within the scope of the xml:base attribute.
java.util.List<Category>	getEntries()	Returns the list of entries.
Reference	getScheme()	Returns the scheme.
boolean	isFixed()	Indicates if the list is fixed.
void	setBaseReference(Reference baseReference)	Sets the base reference used to resolve relative references found within the scope of the xml:base attribute.
void	setEntries(java.util.List<Category> entries)	Sets the list of entries.
void	setFixed(boolean fixed)	Indicates if the list is fixed.
void	setScheme(Reference scheme)	Sets the scheme.
void	write(XmlWriter writer)	Writes the representation to a XML writer.
void	writeElement(XmlWriter writer)	Writes the representation to a XML writer.

Methods inherited from class org.restlet.ext.xml.SaxRepresentation

getInputSource, getSaxSource, isSecureProcessing, parse, release, setSaxSource, setSecureProcessing, write

Methods inherited from class org.restlet.ext.xml.XmlRepresentation

getBoolean, getDocument, getDocumentBuilder, getDomSource, getEntityResolver, getErrorHandler, getNamespaces, getNamespaceURI, getNode, getNodes, getNumber, getPrefix, getPrefixes, getSaxSource, getSchema, getStreamSource, getText, getTextContent, isCoalescing, isExpandingEntityRefs, isIgnoringComments, isIgnoringExtraWhitespaces, isNamespaceAware, isValidatingDtd, isXIncludeAware, setCoalescing, setEntityResolver, setErrorHandler, setExpandingEntityRefs, setIgnoringComments, setIgnoringExtraWhitespaces, setNamespaceAware, setNamespaces, setSchema, setSchema, setValidatingDtd, setXIncludeAware, validate, validate, validate, validate

Methods inherited from class org.restlet.representation.WriterRepresentation

getReader

Methods inherited from class org.restlet.representation.CharacterRepresentation

getChannel, getStream, write, write

Methods inherited from class org.restlet.representation.Representation

append, exhaust, getAvailableSize, getDigest, getDisposition, getExpirationDate, getRange, getRegistration, getSize, getText, hasKnownSize, isAvailable, isEmpty, isSelectable, isTransient, setAvailable, setDigest, setDisposition, setExpirationDate, setListener, setRange, setSize, setTransient

Methods inherited from class org.restlet.representation.RepresentationInfo

getModificationDate, getTag, setModificationDate, setTag

Methods inherited from class org.restlet.representation.Variant

createClientInfo, equals, getCharacterSet, getEncodings, getLanguages, getLocationRef, getMediaType, hashCode, includes, isCompatible, setCharacterSet, setEncodings, setLanguages, setLocationRef, setLocationRef, setMediaType, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

baseReference

private volatile Reference baseReference

The base reference used to resolve relative references found within the scope of the xml:base attribute.

entries

private volatile java.util.List<Category> entries

The list of entries.

fixed

private boolean fixed

Indicates if the list is fixed.

scheme

private Reference scheme

Constructor Detail

Categories

public Categories(Client clientDispatcher,
                  java.lang.String categoriesUri)
           throws java.io.IOException

Constructor.

Parameters:

clientDispatcher - The client HTTP dispatcher.

categoriesUri - The feed URI.

Throws:

java.io.IOException

Categories

public Categories(Context context,
                  java.lang.String categoriesUri)
           throws java.io.IOException

Constructor.

Parameters:

context - The context from which the client dispatcher will be retrieved.

categoriesUri - The feed URI.

Throws:

java.io.IOException

Categories

public Categories(Representation categoriesFeed)
           throws java.io.IOException

Constructor.

Parameters:

categoriesFeed - The XML entries document.

Throws:

java.io.IOException

Categories

public Categories(java.lang.String categoriesUri)
           throws java.io.IOException

Constructor.

Parameters:

categoriesUri - The feed URI.

Throws:

java.io.IOException

Method Detail

getBaseReference

public Reference getBaseReference()

Returns the base reference used to resolve relative references found within the scope of the xml:base attribute.

Returns:

The base reference used to resolve relative references found within the scope of the xml:base attribute.

getEntries

public java.util.List<Category> getEntries()

Returns the list of entries.

Returns:

The list of entries.

getScheme

public Reference getScheme()

Returns the scheme.

Returns:

The scheme.

isFixed

public boolean isFixed()

Indicates if the list is fixed.

Returns:

True if the list is fixed.

setBaseReference

public void setBaseReference(Reference baseReference)

Sets the base reference used to resolve relative references found within the scope of the xml:base attribute.

Parameters:

baseReference - The base reference used to resolve relative references found within the scope of the xml:base attribute.

setEntries

public void setEntries(java.util.List<Category> entries)

Sets the list of entries.

Parameters:

entries - The list of entries.

setFixed

public void setFixed(boolean fixed)

Indicates if the list is fixed.

Parameters:

fixed - True if the list is fixed.

setScheme

public void setScheme(Reference scheme)

Sets the scheme.

Parameters:

scheme - The scheme.

write

public void write(XmlWriter writer)
           throws java.io.IOException

Writes the representation to a XML writer.

Overrides:

write in class SaxRepresentation

Parameters:

writer - The XML writer to write to.

Throws:

java.io.IOException

writeElement

public void writeElement(XmlWriter writer)
                  throws org.xml.sax.SAXException

Writes the representation to a XML writer.

Parameters:

writer - The XML writer to write to.

Throws:

org.xml.sax.SAXException