Package org.apache.juneau.dto.atom

Class Link

java.lang.Object
org.apache.juneau.dto.atom.Common
org.apache.juneau.dto.atom.Link
@Bean(typeName="link") public class Link extends Common
Represents an atomLink construct in the RFC4287 specification.
Schema

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 }

See Also:

  • Constructor Details

    • Link

      public Link(String rel, String type, String href)
      Normal constructor.
      Parameters:
      rel - The rel of the link.
      type - The type of the link.
      href - The URI of the link.

    • Link

      public Link()
      Bean constructor.

  • Method Details

    • getHref

      @Xml(format=ATTR) public String getHref()
      Bean property getter: href.

      The href of the target of this link.

      Returns:
      The property value, or null if it is not set.

    • setHref

      public Link setHref(String value)
      Bean property setter: href.

      The href of the target of this link.

      Parameters:
      value - The new value for this property.
      Can be null to unset the property.
      Returns:
      This object

    • getRel

      @Xml(format=ATTR) public String getRel()
      Bean property getter: rel.

      The rel of this link.

      Returns:
      The property value, or null if it is not set.

    • setRel

      public Link setRel(String value)
      Bean property setter: rel.

      The rel of this link.

      Parameters:
      value - The new value for this property.
      Can be null to unset the property.
      Returns:
      This object

    • getType

      @Xml(format=ATTR) public String getType()
      Bean property getter: type.

      The content type of the target of this link.

      Returns:
      The property value, or null if it is not set.

    • setType

      public Link setType(String value)
      Bean property setter: type.

      The content type of the target of this link.

      Must be one of the following:

      • "text"
      • "html"
      • "xhtml"
      • null (defaults to "text")
      Parameters:
      value - The new value for this property.
      Can be null to unset the property.
      Returns:
      This object

    • getHreflang

      @Xml(format=ATTR) public String getHreflang()
      Bean property getter: hreflang.

      The language of the target of this link.

      Returns:
      The property value, or null if it is not set.

    • setHreflang

      public Link setHreflang(String value)
      Bean property setter: hreflang.

      The language of the target of this link.

      Parameters:
      value - The new value for this property.
      Can be null to unset the property.
      Returns:
      This object

    • getTitle

      @Xml(format=ATTR) public String getTitle()
      Bean property getter: title.

      The title of the target of this link.

      Returns:
      The property value, or null if it is not set.

    • setTitle

      public Link setTitle(String value)
      Bean property setter: title.

      The title of the target of this link.

      Parameters:
      value - The new value for this property.
      Can be null to unset the property.
      Returns:
      This object

    • getLength

      @Xml(format=ATTR) public Integer getLength()
      Bean property getter: length.

      The length of the contents of the target of this link.

      Returns:
      The property value, or null if it is not set.

    • setLength

      public Link setLength(Integer value)
      Bean property setter: length.

      The length of the contents of the target of this link.

      Parameters:
      value - The new value for this property.
      Can be null to unset the property.
      Returns:
      This object

    • setBase

      public Link setBase(Object value)
      Description copied from class: Common
      Bean property setter: term.

      The URI base of this object.

      The value can be of any of the following types: URI, URL, String. Strings must be valid URIs.

      Overrides:
      setBase in class Common
      Parameters:
      value - The new value for this property.
      Can be null to unset the property.
      Returns:
      This object

    • setLang

      public Link setLang(String value)
      Description copied from class: Common
      Bean property setter: lang.

      The language of this object.

      Overrides:
      setLang in class Common
      Parameters:
      value - The new value for this property.
      Can be null to unset the property.
      Returns:
      This object