Package org.restlet.data

Class Tag

java.lang.Object
org.restlet.data.Tag
public final class Tag extends Object
Validation tag equivalent to an HTTP entity tag (E-Tag). "A strong entity tag may be shared by two entities of a resource only if they are equivalent by octet equality.

A weak entity tag may be shared by two entities of a resource only if the entities are equivalent and could be substituted for each other with no significant change in semantics."
Author:
Jerome Louvel
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final Tag
    ALL
    Tag matching any other tag, used in call's condition data.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Tag()
    Default constructor.
    Tag(String opaqueTag)
    Constructor of weak tags.
    Tag(String opaqueTag, boolean weak)
    Constructor.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object object)
    Indicates if both tags are equal.
    boolean
    equals(Object object, boolean checkWeakness)
    Indicates if both tags are equal.
    String
    format()
    Returns tag formatted as an HTTP tag string.
    String
    getName()
    Returns the name, corresponding to an HTTP opaque tag value.
    int
    hashCode()
    boolean
    isWeak()
    Indicates if the tag is weak.
    static Tag
    parse(String httpTag)
    Parses a tag formatted as defined by the HTTP standard.
    String
    toString()
    Returns the name.

    Methods inherited from class java.lang.Object

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

  • Field Details

    • ALL

      public static final Tag ALL
      Tag matching any other tag, used in call's condition data.

  • Constructor Details

    • Tag

      public Tag()
      Default constructor. The opaque tag is set to null and the weakness indicator is set to true.

    • Tag

      public Tag(String opaqueTag)
      Constructor of weak tags.
      Parameters:
      opaqueTag - The tag value.

    • Tag

      public Tag(String opaqueTag, boolean weak)
      Constructor.
      Parameters:
      opaqueTag - The tag value.
      weak - The weakness indicator.

  • Method Details

    • parse

      public static Tag parse(String httpTag)
      Parses a tag formatted as defined by the HTTP standard.
      Parameters:
      httpTag - The HTTP tag string; if it starts with 'W/' the tag will be marked as weak and the data following the 'W/' used as the tag; otherwise it should be surrounded with quotes (e.g., "sometag").
      Returns:
      A new tag instance.
      See Also:

    • equals

      public boolean equals(Object object)
      Indicates if both tags are equal.
      Overrides:
      equals in class Object
      Parameters:
      object - The object to compare to.
      Returns:
      True if both tags are equal.

    • equals

      public boolean equals(Object object, boolean checkWeakness)
      Indicates if both tags are equal.
      Parameters:
      object - The object to compare to.
      checkWeakness - The equality test takes care or not of the weakness.
      Returns:
      True if both tags are equal.

    • format

      public String format()
      Returns tag formatted as an HTTP tag string.
      Returns:
      The formatted HTTP tag string.
      See Also:

    • getName

      public String getName()
      Returns the name, corresponding to an HTTP opaque tag value.
      Returns:
      The name, corresponding to an HTTP opaque tag value.

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • isWeak

      public boolean isWeak()
      Indicates if the tag is weak.
      Returns:
      True if the tag is weak, false if the tag is strong.

    • toString

      public String toString()
      Returns the name.
      Overrides:
      toString in class Object
      Returns:
      The name.