Package org.fcrepo.client

Class FcrepoLink

java.lang.Object

org.fcrepo.client.FcrepoLink

public class FcrepoLink
extends Object

A class representing the value of an HTTP Link header

Author:

Aaron Coburn, bbpennel

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FcrepoLink.Builder	Builder class for link headers represented as FcrepoLinks

Constructor Summary

Constructors

Constructor	Description
FcrepoLink(String link)	Create a representation of a Link header.

Method Summary

Modifier and Type	Method	Description
static List<FcrepoLink>	fromHeader(String headerValue)	Parser which converts a link header containing one or more links into a list of FcrepoLink objects.
static FcrepoLink.Builder	fromUri(String uri)	Create a new builder instance initialized from an existing URI represented as a string.
static FcrepoLink.Builder	fromUri(URI uri)	Create a new builder instance initialized from an existing URI.
String	getParam(String name)	Retrieve a parameter from the link header
Map<String,String>	getParams()	Retrieve a map of parameters from the link header
String	getRel()	Retrieve the REL portion of the link
String	getType()	Retrieve the type portion of the link
URI	getUri()	Retrieve the URI of the link
String	toString()
static FcrepoLink	valueOf(String link)	Simple parser to convert a link header containing a single link into an FcrepoLink object.

Methods inherited from class java.lang.Object

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

Constructor Detail

FcrepoLink

public FcrepoLink(String link)

Create a representation of a Link header.

Parameters:

link - the value for a Link header

Method Detail

getUri

public URI getUri()

Retrieve the URI of the link

Returns:

the URI portion of a Link header

getRel

public String getRel()

Retrieve the REL portion of the link

Returns:

the "rel" portion of a Link header

getType

public String getType()

Retrieve the type portion of the link

Returns:

the "type" parameter of the header

getParam

public String getParam(String name)

Retrieve a parameter from the link header

Parameters:

name - name of the parameter in the link header

Returns:

the value of the parameter or null if not present.

getParams

public Map<String,String> getParams()

Retrieve a map of parameters from the link header

Returns:

map of parameters

toString

public String toString()

Overrides:

toString in class Object

fromUri

public static FcrepoLink.Builder fromUri(String uri)

Create a new builder instance initialized from an existing URI represented as a string.

Parameters:

uri - URI which will be used to initialize the builder

Returns:

a new link builder.

Throws:

IllegalArgumentException - if uri is null.

fromUri

public static FcrepoLink.Builder fromUri(URI uri)

Create a new builder instance initialized from an existing URI.

Parameters:

uri - URI which will be used to initialize the builder

Returns:

a new link builder.

Throws:

IllegalArgumentException - if uri is null.

valueOf

public static FcrepoLink valueOf(String link)

Simple parser to convert a link header containing a single link into an FcrepoLink object.

Parameters:

link - link header value.

Returns:

FcrepoLink representing the link

fromHeader

public static List<FcrepoLink> fromHeader(String headerValue)

Parser which converts a link header containing one or more links into a list of FcrepoLink objects.

Parameters:

headerValue - link header value.

Returns:

List containing an FcrepoLink for each link in the header value.