Package org.restlet.ext.atom

Class Collection

  • public class Collection
extends java.lang.Object
    Atom Protocol collection, part of a workspace.
    Author:
    Jerome Louvel

    • Constructor Summary

      Constructors 
      Constructor Description
      Collection​(Workspace workspace, java.lang.String title, java.lang.String href)
      Constructor.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.util.List<org.restlet.data.MediaType> getAccept()
      Returns the accepted media types.
      org.restlet.data.Reference getBaseReference()
      Returns the base reference used to resolve relative references found within the scope of the xml:base attribute.
      Categories getCategories()
      Returns the categories.
      Feed getFeed()
      Returns the feed representation.
      org.restlet.data.Reference getHref()
      Returns the hypertext reference.
      java.lang.String getTitle()
      Returns the title.
      Workspace getWorkspace()
      Returns the parent workspace.
      org.restlet.data.Reference postMember​(org.restlet.representation.Representation member)
      Posts a member to the collection resulting in the creation of a new resource.
      void setAccept​(java.util.List<org.restlet.data.MediaType> accept)
      Sets the accepted media types.
      void setBaseReference​(org.restlet.data.Reference baseReference)
      Sets the base reference used to resolve relative references found within the scope of the xml:base attribute.
      void setCategories​(Categories categories)
      Sets the categories.
      void setHref​(org.restlet.data.Reference href)
      Sets the hypertext reference.
      void setTitle​(java.lang.String title)
      Sets the title.
      void setWorkspace​(Workspace workspace)
      Sets the parent workspace.
      void writeElement​(XmlWriter writer)
      Writes the current object as an XML element using the given SAX writer.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • Collection

        public Collection​(Workspace workspace,
                  java.lang.String title,
                  java.lang.String href)
        Constructor.
        Parameters:
        workspace - The parent workspace.
        title - The title.
        href - The hypertext reference.

    • Method Detail

      • getAccept

        public java.util.List<org.restlet.data.MediaType> getAccept()
        Returns the accepted media types.
        Returns:
        The accepted media types.

      • getBaseReference

        public org.restlet.data.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.

      • getCategories

        public Categories getCategories()
        Returns the categories.
        Returns:
        The categories.

      • getFeed

        public Feed getFeed()
             throws java.lang.Exception
        Returns the feed representation.
        Returns:
        The feed representation.
        Throws:
        java.lang.Exception

      • getHref

        public org.restlet.data.Reference getHref()
        Returns the hypertext reference.
        Returns:
        The hypertext reference.

      • getTitle

        public java.lang.String getTitle()
        Returns the title.
        Returns:
        The title.

      • getWorkspace

        public Workspace getWorkspace()
        Returns the parent workspace.
        Returns:
        The parent workspace.

      • postMember

        public org.restlet.data.Reference postMember​(org.restlet.representation.Representation member)
                                      throws java.lang.Exception
        Posts a member to the collection resulting in the creation of a new resource.
        Parameters:
        member - The member representation to post.
        Returns:
        The reference of the new resource.
        Throws:
        java.lang.Exception

      • setAccept

        public void setAccept​(java.util.List<org.restlet.data.MediaType> accept)
        Sets the accepted media types.
        Parameters:
        accept - The accepted media types.

      • setBaseReference

        public void setBaseReference​(org.restlet.data.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.

      • setCategories

        public void setCategories​(Categories categories)
        Sets the categories.
        Parameters:
        categories - The categories.

      • setHref

        public void setHref​(org.restlet.data.Reference href)
        Sets the hypertext reference.
        Parameters:
        href - The hypertext reference.

      • setTitle

        public void setTitle​(java.lang.String title)
        Sets the title.
        Parameters:
        title - The title.

      • setWorkspace

        public void setWorkspace​(Workspace workspace)
        Sets the parent workspace.
        Parameters:
        workspace - The parent workspace.

      • writeElement

        public void writeElement​(XmlWriter writer)
                  throws org.xml.sax.SAXException
        Writes the current object as an XML element using the given SAX writer.
        Parameters:
        writer - The SAX writer.
        Throws:
        org.xml.sax.SAXException