org.codehaus.httpcache4j

Class Tag

java.lang.Object

org.codehaus.httpcache4j.Tag

public final class Tag
extends Object

Validation tag equivalent to the HTTP entity 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."

See Also:

HTTP Entity Tags, HTTP Entity Tag Cache Validators

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
Tag(String opaqueTag) Constructor.
Tag(String opaqueTag, boolean weak) Constructor.

Method Summary

Modifier and Type	Method and 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()
int	hashCode()
boolean	isWeak() Indicates if the tag is weak.
static Optional<Tag>	parse(String httpTag) Parses a tag formatted as defined by the HTTP standard.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

ALL

public static final Tag ALL

Tag matching any other tag, used in call's condition data.

Constructor Detail

Tag

public Tag(String opaqueTag,
           boolean weak)

Constructor.

Parameters:

opaqueTag - The tag value without quotes.

weak - The weakness indicator.

Tag

public Tag(String opaqueTag)

Constructor.

Parameters:

opaqueTag - The tag value without quotes..

Method Detail

parse

public static Optional<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:

HTTP Entity Tags

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:

HTTP Entity Tags

getName

public String getName()

toString

public String toString()

Overrides:

toString in class Object

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.