This project has retired. For details please refer to its Attic page.

org.apache.wink.webdav.server
Class WebDAVResponseBuilder.CollectionPropertyHandler

java.lang.Object
  org.apache.wink.webdav.server.WebDAVResponseBuilder.PropertyHandler
      org.apache.wink.webdav.server.WebDAVResponseBuilder.CollectionPropertyHandler

Enclosing class:

WebDAVResponseBuilder

public static class WebDAVResponseBuilder.CollectionPropertyHandler
extends WebDAVResponseBuilder.PropertyHandler

Extends the WebDAVResponseBuilder.PropertyHandler to provide additional data for the creation of multistatus responses for collections (feeds).

Constructor Summary

WebDAVResponseBuilder.CollectionPropertyHandler()
Constructs a CollectionPropertyProvider that is also the property handler for the entries

WebDAVResponseBuilder.CollectionPropertyHandler(WebDAVResponseBuilder.PropertyHandler entryPropertyHandler)
Constructor accepting another WebDAVResponseBuilder.PropertyHandler to provide properties for the entries in the collection.

Method Summary

WebDAVResponseBuilder.PropertyHandler	getEntryPropertyHandler() Get the PropertyHandler that is used to set properties for the entries in the collection
SyndFeed	getSubCollection(SyndEntry entry) Get the feed that this entry represents.
List<SyndFeed>	getSubCollections(WebDAVResponseBuilder builder, SyndFeed feed) Gets the list of sub-collection feeds for a given feed.
boolean	isSubCollection(SyndEntry entry) Specifies if an entry actually represents a feed.
void	setEntryPropertyHandler(WebDAVResponseBuilder.PropertyHandler entryPropertyHandler) Set the PropertyHandler that is used to set properties for the entries in the collection

Methods inherited from class org.apache.wink.webdav.server.WebDAVResponseBuilder.PropertyHandler

setAllPropertyNames, setPropertyValue

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WebDAVResponseBuilder.CollectionPropertyHandler

public WebDAVResponseBuilder.CollectionPropertyHandler()

Constructs a CollectionPropertyProvider that is also the property handler for the entries

WebDAVResponseBuilder.CollectionPropertyHandler

public WebDAVResponseBuilder.CollectionPropertyHandler(WebDAVResponseBuilder.PropertyHandler entryPropertyHandler)

Constructor accepting another WebDAVResponseBuilder.PropertyHandler to provide properties for the entries in the collection.

Parameters:

entryPropertyHandler -

Method Detail

getSubCollections

public List<SyndFeed> getSubCollections(WebDAVResponseBuilder builder,
                                        SyndFeed feed)

Gets the list of sub-collection feeds for a given feed. The default implementation returns null

Parameters:

builder - the current WebDAVResponseBuilder which can be used to obtain context information

feed - the feed to obtain the sub collections from

Returns:

the sub-collections

isSubCollection

public boolean isSubCollection(SyndEntry entry)

Specifies if an entry actually represents a feed. This method is called only when building the response for an entry that is part of a feed. The default implementation returns false

Parameters:

entry - the entry

Returns:

true if the entry is a sub-collection, otherwise false

getSubCollection

public SyndFeed getSubCollection(SyndEntry entry)

Get the feed that this entry represents. This method is called if the #isEntrySubCollection(DocumentResource) method returns true for the given entry. The default implementation returns null

Parameters:

entry - the entry that represents a feed

Returns:

an instance of a SyndFeed

getEntryPropertyHandler

public final WebDAVResponseBuilder.PropertyHandler getEntryPropertyHandler()

Get the PropertyHandler that is used to set properties for the entries in the collection

Returns:

the PropertyHandler used to set properties for the entries in the collection

setEntryPropertyHandler

public final void setEntryPropertyHandler(WebDAVResponseBuilder.PropertyHandler entryPropertyHandler)

Set the PropertyHandler that is used to set properties for the entries in the collection

Parameters:

entryPropertyHandler - the entry PropertyHandler