Package org.apache.abdera.model

Interface Link

  • All Superinterfaces:
    Base, java.lang.Cloneable, Element, ExtensibleElement, java.lang.Iterable<Element>
    @Deprecated(since="2021-07-29")
public interface Link
extends ExtensibleElement
    Deprecated.
    This API is deprecated as Apache Abdera is a retired project since 2017.

    Represents an Atom Link element.

    Per RFC4287: 

       The "atom:link" element defines a reference from an entry or feed to
   a Web resource.  This specification assigns no meaning to the content
   (if any) of this element.

   atomLink =
      element atom:link {
         atomCommonAttributes,
         attribute href { atomUri },
         attribute rel { atomNCName | atomUri }?,
         attribute type { atomMediaType }?,
         attribute hreflang { atomLanguageTag }?,
         attribute title { text }?,
         attribute length { text }?,
         undefinedContent
      }

    • Method Detail

      • getHref

        IRI getHref()
        Deprecated.
        RFC4287: The "href" attribute contains the link's IRI. atom:link elements MUST have an href attribute, whose value MUST be a IRI reference [RFC3987].
        Returns:
        The href IRI value
        Throws:
        IRISyntaxException - if the href is malformed

      • getResolvedHref

        IRI getResolvedHref()
        Deprecated.
        Returns the value of the link's href attribute resolved against the in-scope Base IRI
        Returns:
        The href IRI value
        Throws:
        IRISyntaxException - if the href is malformed

      • setHref

        Link setHref​(java.lang.String href)
        Deprecated.
        RFC4287: The "href" attribute contains the link's IRI. atom:link elements MUST have an href attribute, whose value MUST be a IRI reference [RFC3987].
        Parameters:
        href - The href IRI
        Throws:
        IRISyntaxException - if the href is malformed

      • getRel

        java.lang.String getRel()
        Deprecated.

        RFC4287: atom:link elements MAY have a "rel" attribute that indicates the link relation type. If the "rel" attribute is not present, the link element MUST be interpreted as if the link relation type is "alternate"... The value of "rel" MUST be a string that is non-empty and matches either the "isegment-nz-nc" or the "IRI" production in [RFC3987]. Note that use of a relative reference other than a simple name is not allowed. If a name is given, implementations MUST consider the link relation type equivalent to the same name registered within the IANA Registry of Link Relations (Section 7), and thus to the IRI that would be obtained by appending the value of the rel attribute to the string "http://www.iana.org/assignments/relation/". The value of "rel" describes the meaning of the link, but does not impose any behavioral requirements on Atom Processors.

        Returns:
        The rel attribute value

      • setRel

        Link setRel​(java.lang.String rel)
        Deprecated.

        RFC4287: atom:link elements MAY have a "rel" attribute that indicates the link relation type. If the "rel" attribute is not present, the link element MUST be interpreted as if the link relation type is "alternate"... The value of "rel" MUST be a string that is non-empty and matches either the "isegment-nz-nc" or the "IRI" production in [RFC3987]. Note that use of a relative reference other than a simple name is not allowed. If a name is given, implementations MUST consider the link relation type equivalent to the same name registered within the IANA Registry of Link Relations (Section 7), and thus to the IRI that would be obtained by appending the value of the rel attribute to the string "http://www.iana.org/assignments/relation/". The value of "rel" describes the meaning of the link, but does not impose any behavioral requirements on Atom Processors.

        Parameters:
        rel - The rel attribute value

      • getMimeType

        javax.activation.MimeType getMimeType()
        Deprecated.
        RFC4287: On the link element, the "type" attribute's value is an advisory media type: it is a hint about the type of the representation that is expected to be returned when the value of the href attribute is dereferenced. Note that the type attribute does not override the actual media type returned with the representation. Link elements MAY have a type attribute, whose value MUST conform to the syntax of a MIME media type [MIMEREG].
        Returns:
        The value of the type attribute
        Throws:
        MimeTypeParseException - if the type is malformed

      • setMimeType

        Link setMimeType​(java.lang.String type)
        Deprecated.
        RFC4287: On the link element, the "type" attribute's value is an advisory media type: it is a hint about the type of the representation that is expected to be returned when the value of the href attribute is dereferenced. Note that the type attribute does not override the actual media type returned with the representation. Link elements MAY have a type attribute, whose value MUST conform to the syntax of a MIME media type [MIMEREG].
        Parameters:
        type - The link type
        Throws:
        MimeTypeParseException - if the type is malformed

      • getHrefLang

        java.lang.String getHrefLang()
        Deprecated.
        RFC4287: The "hreflang" attribute's content describes the language of the resource pointed to by the href attribute. When used together with the rel="alternate", it implies a translated version of the entry. Link elements MAY have an hreflang attribute, whose value MUST be a language tag [RFC3066].
        Returns:
        The hreflang value

      • setHrefLang

        Link setHrefLang​(java.lang.String lang)
        Deprecated.
        RFC4287: The "hreflang" attribute's content describes the language of the resource pointed to by the href attribute. When used together with the rel="alternate", it implies a translated version of the entry. Link elements MAY have an hreflang attribute, whose value MUST be a language tag [RFC3066].
        Parameters:
        lang - The hreflang value

      • getTitle

        java.lang.String getTitle()
        Deprecated.
        RFC4287: The "title" attribute conveys human-readable information about the link. The content of the "title" attribute is Language-Sensitive. Entities such as "&amp;" and "&lt;" represent their corresponding characters ("&" and "<", respectively), not markup. Link elements MAY have a title attribute.
        Returns:
        The title attribute

      • setTitle

        Link setTitle​(java.lang.String title)
        Deprecated.
        RFC4287: The "title" attribute conveys human-readable information about the link. The content of the "title" attribute is Language-Sensitive. Entities such as "&amp;" and "&lt;" represent their corresponding characters ("&" and "<", respectively), not markup. Link elements MAY have a title attribute.
        Parameters:
        title - The title attribute

      • getLength

        long getLength()
        Deprecated.
        RFC4287: The "length" attribute indicates an advisory length of the linked content in octets; it is a hint about the content length of the representation returned when the URI in the href attribute is mapped to a IRI and dereferenced. Note that the length attribute does not override the actual content length of the representation as reported by the underlying protocol. Link elements MAY have a length attribute.
        Returns:
        The length attribute value

      • setLength

        Link setLength​(long length)
        Deprecated.
        RFC4287: The "length" attribute indicates an advisory length of the linked content in octets; it is a hint about the content length of the representation returned when the IRI in the href attribute is mapped to a URI and dereferenced. Note that the length attribute does not override the actual content length of the representation as reported by the underlying protocol. Link elements MAY have a length attribute.
        Parameters:
        length - The length attribute value