com.scvngr.levelup.core.util

Class LinkHeaderParser

java.lang.Object

com.scvngr.levelup.core.util.LinkHeaderParser

@LevelUpApi(contract=INTERNAL)
public final class LinkHeaderParser
extends Object

A regular expression -based parser implementing RFC5988.

This does not check the parameters against the list defined in the RFC. Instead it treats all parameters as key/value pairs, allowing both quoted and unquoted values according to the grammar outlined in the RFC.

See Also:

RFC5988

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LinkHeaderParser.LinkHeader An immutable representation of a "Link:" header.
static class	LinkHeaderParser.MalformedLinkHeaderException This is thrown if there is an error parsing the link.

Field Summary

Fields

Modifier and Type	Field and Description
static String	PARAMETER_ANCHOR Link anchor.
static String	PARAMETER_HREFLANG The language of the link.
static String	PARAMETER_MEDIA The media type, similar to \@media in CSS.
static String	PARAMETER_REL Relation.
static String	PARAMETER_REV A reverse relation.
static String	PARAMETER_TITLE The title of the resource.
static String	PARAMETER_TITLE_STAR The extended title of the resource.
static String	PARAMETER_TYPE The MIME type of the resource.

Method Summary

Modifier and Type	Method and Description
static LinkHeaderParser.LinkHeader	parseLinkHeader(String headerValue) Parses the header value and extracts the link and its parameters.
static LinkHeaderParser.LinkHeader	parseLinkHeader(Uri context, String headerValue) Parses the header value and extracts the link and its parameters, resolving the link relative to the supplied context.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PARAMETER_REL

public static final String PARAMETER_REL

Relation. Value should be a single quoted or unquoted relation type, or a quoted list of space-separated relation types.

See Also:

Constant Field Values

PARAMETER_ANCHOR

public static final String PARAMETER_ANCHOR

Link anchor. Value should be a quoted URI reference.

See Also:

Constant Field Values

PARAMETER_REV

public static final String PARAMETER_REV

A reverse relation. The acceptable values are the same as PARAMETER_REL.

See Also:

Constant Field Values

PARAMETER_HREFLANG

public static final String PARAMETER_HREFLANG

The language of the link.

See Also:

Constant Field Values

PARAMETER_MEDIA

public static final String PARAMETER_MEDIA

The media type, similar to \@media in CSS.

See Also:

Constant Field Values

PARAMETER_TITLE

public static final String PARAMETER_TITLE

The title of the resource.

See Also:

Constant Field Values

PARAMETER_TITLE_STAR

public static final String PARAMETER_TITLE_STAR

The extended title of the resource.

See Also:

Constant Field Values

PARAMETER_TYPE

public static final String PARAMETER_TYPE

The MIME type of the resource.

See Also:

Constant Field Values

Method Detail

parseLinkHeader

public static LinkHeaderParser.LinkHeader parseLinkHeader(String headerValue)
                                                   throws LinkHeaderParser.MalformedLinkHeaderException

Parses the header value and extracts the link and its parameters. This is the equivalent of passing context=null to parseLinkHeader(Uri, String).

Parameters:

headerValue - the input header value. This is the portion after "Link:".

Returns:

a LinkHeaderParser.LinkHeader representing the results of the parse.

Throws:

LinkHeaderParser.MalformedLinkHeaderException - if the header could not be parsed.

parseLinkHeader

public static LinkHeaderParser.LinkHeader parseLinkHeader(Uri context,
                                                          String headerValue)
                                                   throws LinkHeaderParser.MalformedLinkHeaderException

Parses the header value and extracts the link and its parameters, resolving the link relative to the supplied context. Typically the context is the URL of the HTTP request.

Parameters:

context - the URI that any relative URIs will be resolved against. This can be null to disable relative URI resolution.

headerValue - the input header value. This is the portion after "Link:".

Returns:

a LinkHeaderParser.LinkHeader representing the results of the parse.

Throws:

LinkHeaderParser.MalformedLinkHeaderException - if the header could not be parsed.