Package com.oorian.html.elements.consts

Enum Class Relationship

java.lang.Object
java.lang.Enum<Relationship>
com.oorian.html.elements.consts.Relationship
All Implemented Interfaces:
Serializable, Comparable<Relationship>, Constable
public enum Relationship extends Enum<Relationship>
Enumeration defining the relationship types between the current document and linked resources. This enum provides type-safe constants for the "rel" attribute used in link and anchor elements, which describes the relationship between the current document and the linked resource.
Since:
1.0
Version:
1.0
Author:
Marvin P. Warble Jr.
See Also:

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    ALTERNATE
    Provides a link to an alternate representation of the document.
    ARCHIVES
    Provides a link to a collection of archived documents.
    AUTHOR
    Provides a link to the author of the document.
    BOOKMARK
    Provides a permanent link to the current section or document.
    EXTERNAL
    Indicates the link references an external resource.
    FIRST
    Indicates the link to the first document in a series.
    HELP
    Provides a link to help documentation.
    ICON
    Specifies an icon representing the document.
    LAST
    Indicates the link to the last document in a series.
    LICENSE
    Provides a link to copyright or licensing information.
    NEXT
    Indicates the link to the next document in a series.
    NOFOLLOW
    Instructs search engines not to follow the link.
    NOREFERRER
    Instructs the browser not to send an HTTP referrer header.
    PINGBACK
    Provides the address of a pingback server.
    PREFETCH
    Hints that the target resource should be cached.
    PREV
    Indicates the link to the previous document in a series.
    SEARCH
    Provides a link to a search tool for the document.
    SIDEBAR
    Indicates the link should be shown in a sidebar.
    STYLESHEET
    Imports an external stylesheet.
    TAG
    Provides a tag or keyword for the current document.
    UP
    Indicates the link to a parent document in the hierarchy.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getValue()
    Gets the relationship type value for use in HTML rel attribute.
    String
    toString()
     
    static Relationship
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static Relationship[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • ALTERNATE

      public static final Relationship ALTERNATE
      Provides a link to an alternate representation of the document. Used for alternate stylesheets, RSS feeds, or translations.

    • ARCHIVES

      public static final Relationship ARCHIVES
      Provides a link to a collection of archived documents. Used to reference historical versions or archives.

    • AUTHOR

      public static final Relationship AUTHOR
      Provides a link to the author of the document. Used to reference the creator or author's contact information.

    • BOOKMARK

      public static final Relationship BOOKMARK
      Provides a permanent link to the current section or document. Used for permalink URLs that won't change over time.

    • EXTERNAL

      public static final Relationship EXTERNAL
      Indicates the link references an external resource. Used to mark links that navigate away from the current domain.

    • FIRST

      public static final Relationship FIRST
      Indicates the link to the first document in a series. Used for navigation in a sequence of documents.

    • HELP

      public static final Relationship HELP
      Provides a link to help documentation. Used to reference context-sensitive help or documentation.

    • ICON

      public static final Relationship ICON
      Specifies an icon representing the document. Used for favicon or application icons.

    • LAST

      public static final Relationship LAST
      Indicates the link to the last document in a series. Used for navigation in a sequence of documents.

    • LICENSE

      public static final Relationship LICENSE
      Provides a link to copyright or licensing information. Used to reference legal terms or license agreements.

    • NEXT

      public static final Relationship NEXT
      Indicates the link to the next document in a series. Used for sequential navigation or pagination.

    • NOFOLLOW

      public static final Relationship NOFOLLOW
      Instructs search engines not to follow the link. Used to prevent passing PageRank or endorsement to the linked page.

    • NOREFERRER

      public static final Relationship NOREFERRER
      Instructs the browser not to send an HTTP referrer header. Used for privacy when navigating to external sites.

    • PINGBACK

      public static final Relationship PINGBACK
      Provides the address of a pingback server. Used for blog pingback functionality.

    • PREFETCH

      public static final Relationship PREFETCH
      Hints that the target resource should be cached. Used to prefetch resources that will likely be needed.

    • PREV

      public static final Relationship PREV
      Indicates the link to the previous document in a series. Used for sequential navigation or pagination.

    • STYLESHEET

      public static final Relationship STYLESHEET
      Imports an external stylesheet. Used to include CSS files for styling the document.

    • TAG

      public static final Relationship TAG
      Provides a tag or keyword for the current document. Used for categorization and tagging.

    • UP

      public static final Relationship UP
      Indicates the link to a parent document in the hierarchy. Used for navigating up a document tree structure.

  • Method Details

    • values

      public static Relationship[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static Relationship valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • getValue

      public String getValue()
      Gets the relationship type value for use in HTML rel attribute.
      Returns:
      the string value used in HTML rel attribute.

    • toString

      public String toString()
      Overrides:
      toString in class Enum<Relationship>