org.dmfs.httpclientinterfaces.headers.values

Interface Link

public interface Link

Interface of a link value as specified in RFC 5988

Author:

Marten Gajda

Method Summary

Modifier and Type	Method and Description
java.net.URI	anchor() Returns the anchor if the link has any.
java.lang.String	firstRawParameter(java.lang.String parameter) Returns the String representation of the first occurrence of the given parameter.
boolean	hasParameter(java.lang.String parameter) Checks if a specific parameter is present in the Link.
java.util.Set<java.util.Locale>	hrefLang() Return an iterator of all hreflang parameters present in the link.
java.net.URI	link() Returns the actual link of this Link object.
ContentType	mediaType() Returns the media-type of the link target.
java.util.Set<java.lang.String>	rawParameter(java.lang.String parameter) Returns the String representations of all occurrence of the given parameter.
java.util.Set<java.lang.String>	relationTypes() Returns the set of relation types of this link.
java.util.Set<java.lang.String>	reverseRelationTypes()
java.lang.String	title() Returns the value of the title parameter, if there is any or null if there is none.

Method Detail

link

java.net.URI link()

Returns the actual link of this Link object.

Returns:

hasParameter

boolean hasParameter(java.lang.String parameter)

Checks if a specific parameter is present in the Link.

Parameters:

parameter - The parameter to check.

Returns:

true if the parameter is present, false otherwise.

firstRawParameter

java.lang.String firstRawParameter(java.lang.String parameter)

Returns the String representation of the first occurrence of the given parameter. The returned value may still contain any quotes.

Returns:

The value or null if the parameter is not present.

rawParameter

java.util.Set<java.lang.String> rawParameter(java.lang.String parameter)

Returns the String representations of all occurrence of the given parameter. The returned values may still contain any quotes.

Returns:

A Set of Strings, may be empty if the parameter is not present.

anchor

java.net.URI anchor()

Returns the anchor if the link has any.

Returns:

The anchor URI or null if there is no anchor.

hrefLang

java.util.Set<java.util.Locale> hrefLang()

Return an iterator of all hreflang parameters present in the link.

Returns:

A Set of Locales, may be empty, never null.

title

java.lang.String title()

Returns the value of the title parameter, if there is any or null if there is none.

Returns:

mediaType

ContentType mediaType()

Returns the media-type of the link target.

Returns:

A ContentType or null if there is no media-type parameter.

relationTypes

java.util.Set<java.lang.String> relationTypes()

Returns the set of relation types of this link.

Note: According to RFC 5988, Section 5 relation types can be Strings or URIs. This implementation returns all relation types as strings, since it's mostly used as an opaque token.

Returns:

reverseRelationTypes

java.util.Set<java.lang.String> reverseRelationTypes()