Package org.restlet.ext.atom

Class Relation

  • public class Relation
extends java.lang.Object
    Enumeration of relation types.
    See Also:
    IANA Atom relations

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static Relation ALTERNATE
      Signifies that the IRI in the value of the href attribute identifies an alternate version of the resource described by the containing element.
      static Relation CURRENT
      Signifies that the IRI returns a feed document containing the most recent entries in the feed.
      static Relation DESCRIBED_BY
      Relationship that asserts that resource B provides a description of resource A.
      static Relation EDIT
      Signifies that the IRI in the value of the href attribute identifies a resource that is able to edit the current resource.
      static Relation EDIT_MEDIA
      An IRI of an editable Media Resource.
      static Relation ENCLOSURE
      Signifies that the IRI in the value of the href attribute identifies a related resource that is potentially large in size and might require special handling.
      static Relation FIRST
      Signifies that the IRI in the value of the href attribute identifies the first resource in a series including the current resource.
      static Relation HUB
      A URI for a hub that enables registration for real-time updates to the resource.
      static Relation LAST
      Signifies that the IRI in the value of the href attribute identifies the last resource in a series including the current resource.
      static Relation LAST_VERSION
      When included on a versioned resource, this link points to a resource containing the latest (e.g., current) version.
      static Relation LICENSE
      Signifies that the IRI in the value of the href attribute identifies the resource describing the license.
      private java.lang.String name
      The name of the relation.
      static Relation NEXT
      Signifies that the IRI in the value of the href attribute identifies the next resource in a series including the current resource.
      static Relation NEXT_ARCHIVE
      Signifies that the IRI in the value of the href attribute identifies the immediately following archive document.
      static Relation PAYMENT
      Signifies that the IRI in the value of the href attribute identifies where payment is accepted.
      static Relation PREDECESSOR_VERSION
      When included on a versioned resource, this link points to a resource containing the predecessor version in the version history.
      static Relation PREVIOUS
      Signifies that the IRI in the value of the href attribute identifies the previous resource in a series including the current resource.
      static Relation PREVIOUS_ARCHIVE
      A URI that refers to the immediately preceding archive document.
      static Relation RELATED
      Signifies that the IRI in the value of the href attribute identifies a resource related to the resource described by the containing element.
      static Relation REPLIES
      Signifies that the IRI in the value of the href attribute identifies a resource where responses to an entry may be found.
      static Relation SELF
      Signifies that the IRI in the value of the href attribute identifies a resource equivalent to the containing element.
      static Relation SERVICE
      Signifies that the IRI in the value of the href attribute identifies a resource that can be used to retrieve an Atom Publishing Protocol Service Document as defined by RFC 5023.
      static Relation SUCCESSOR_VERSION
      When included on a versioned resource, this link points to a resource containing the successor version in the version history.
      static Relation UP
      A URI that refers to a parent document in a hierarchy of documents.
      static Relation VERSION_HISTORY
      When included on a versioned resource, this link points to a resource containing the version history for this resource.
      static Relation VIA
      Signifies that the IRI in the value of the href attribute identifies a resource that is the source of the information provided in the containing element.
      static Relation WORKING_COPY
      When included on a versioned resource, this link points to a working copy for this resource.
      static Relation WORKING_COPY_OF
      When included on a working copy, this link points to the versioned resource from which this working copy was obtained.

    • Constructor Summary

      Constructors 
      Constructor Description
      Relation​(java.lang.String name)
      Constructor.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object object)
      java.lang.String getName()
      Returns the name of the relation.
      int hashCode()
      java.lang.String toString()  
      static java.lang.String toString​(Relation rel)
      Return a String object representing the specified Relation.
      static Relation valueOf​(java.lang.String rel)
      Parses a relation name into the equivalent item.

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • ALTERNATE

        public static final Relation ALTERNATE
        Signifies that the IRI in the value of the href attribute identifies an alternate version of the resource described by the containing element.

      • CURRENT

        public static final Relation CURRENT
        Signifies that the IRI returns a feed document containing the most recent entries in the feed.

      • DESCRIBED_BY

        public static final Relation DESCRIBED_BY
        Relationship that asserts that resource B provides a description of resource A. There are no constraints on the format or representation of either A or B, neither are there any further constraints on either resource.

      • EDIT

        public static final Relation EDIT
        Signifies that the IRI in the value of the href attribute identifies a resource that is able to edit the current resource.

      • EDIT_MEDIA

        public static final Relation EDIT_MEDIA
        An IRI of an editable Media Resource. When appearing within an atom:entry, the href IRI can be used to retrieve, update and delete the Media Resource associated with that Entry.

      • ENCLOSURE

        public static final Relation ENCLOSURE
        Signifies that the IRI in the value of the href attribute identifies a related resource that is potentially large in size and might require special handling. For atom:link elements with rel="enclosure", the length attribute SHOULD be provided.

      • FIRST

        public static final Relation FIRST
        Signifies that the IRI in the value of the href attribute identifies the first resource in a series including the current resource.

      • HUB

        public static final Relation HUB
        A URI for a hub that enables registration for real-time updates to the resource.

      • LAST

        public static final Relation LAST
        Signifies that the IRI in the value of the href attribute identifies the last resource in a series including the current resource.

      • LAST_VERSION

        public static final Relation LAST_VERSION
        When included on a versioned resource, this link points to a resource containing the latest (e.g., current) version. The latest version is defined by the system. For linear versioning systems, this is probably the latest version by timestamp. For systems that support branching, there will be multiple latest versions, one for each branch in the version history. Some systems may allow multiple of these link relations.

      • LICENSE

        public static final Relation LICENSE
        Signifies that the IRI in the value of the href attribute identifies the resource describing the license.

      • NEXT

        public static final Relation NEXT
        Signifies that the IRI in the value of the href attribute identifies the next resource in a series including the current resource.

      • NEXT_ARCHIVE

        public static final Relation NEXT_ARCHIVE
        Signifies that the IRI in the value of the href attribute identifies the immediately following archive document.

      • PAYMENT

        public static final Relation PAYMENT
        Signifies that the IRI in the value of the href attribute identifies where payment is accepted.

      • PREDECESSOR_VERSION

        public static final Relation PREDECESSOR_VERSION
        When included on a versioned resource, this link points to a resource containing the predecessor version in the version history. Some systems may allow multiple of these link relations in the case of a multiple branches merging.

      • PREVIOUS

        public static final Relation PREVIOUS
        Signifies that the IRI in the value of the href attribute identifies the previous resource in a series including the current resource.

      • PREVIOUS_ARCHIVE

        public static final Relation PREVIOUS_ARCHIVE
        A URI that refers to the immediately preceding archive document.

      • RELATED

        public static final Relation RELATED
        Signifies that the IRI in the value of the href attribute identifies a resource related to the resource described by the containing element.

      • REPLIES

        public static final Relation REPLIES
        Signifies that the IRI in the value of the href attribute identifies a resource where responses to an entry may be found.

      • SELF

        public static final Relation SELF
        Signifies that the IRI in the value of the href attribute identifies a resource equivalent to the containing element.

      • SERVICE

        public static final Relation SERVICE
        Signifies that the IRI in the value of the href attribute identifies a resource that can be used to retrieve an Atom Publishing Protocol Service Document as defined by RFC 5023.

      • SUCCESSOR_VERSION

        public static final Relation SUCCESSOR_VERSION
        When included on a versioned resource, this link points to a resource containing the successor version in the version history. Some systems may allow multiple of these link relations in order to support branching.

      • UP

        public static final Relation UP
        A URI that refers to a parent document in a hierarchy of documents.

      • VERSION_HISTORY

        public static final Relation VERSION_HISTORY
        When included on a versioned resource, this link points to a resource containing the version history for this resource.

      • VIA

        public static final Relation VIA
        Signifies that the IRI in the value of the href attribute identifies a resource that is the source of the information provided in the containing element.

      • WORKING_COPY

        public static final Relation WORKING_COPY
        When included on a versioned resource, this link points to a working copy for this resource. Some systems may allow multiple of these link relations.

      • WORKING_COPY_OF

        public static final Relation WORKING_COPY_OF
        When included on a working copy, this link points to the versioned resource from which this working copy was obtained.

      • name

        private java.lang.String name
        The name of the relation.

    • Constructor Detail

      • Relation

        public Relation​(java.lang.String name)
        Constructor.
        Parameters:
        name - The name of the relation.

    • Method Detail

      • toString

        public static java.lang.String toString​(Relation rel)
        Return a String object representing the specified Relation.
        Parameters:
        rel - The relation to be converted.
        Returns:
        The String representation of the argument.

      • valueOf

        public static Relation valueOf​(java.lang.String rel)
        Parses a relation name into the equivalent item.
        Parameters:
        rel - The relation name to parse.
        Returns:
        The equivalent item.

      • equals

        public boolean equals​(java.lang.Object object)
        Overrides:
        equals in class java.lang.Object

      • getName

        public java.lang.String getName()
        Returns the name of the relation.
        Returns:
        The name of the relation.

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object