com.atlassian.marketplace.client.model

Class Link

java.lang.Object

com.atlassian.marketplace.client.model.Link

public final class Link
extends Object

A resource/web hyperlink in the HAL-JSON format used by the Marketplace version 2 API. A HAL link can be either a URI or a a UriTemplate.

Constructor Summary

Constructors

Constructor and Description
Link(com.atlassian.fugue.Either<UriTemplate,URI> templateOrUri, com.atlassian.fugue.Option<String> type)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object other)
static Link	fromUri(URI uri, com.atlassian.fugue.Option<String> type)
static Link	fromUriTemplate(UriTemplate ut, com.atlassian.fugue.Option<String> type)
com.atlassian.fugue.Either<UriTemplate,URI>	getTemplateOrUri()
com.atlassian.fugue.Option<String>	getType() Returns the optional "type" attribute, indicating the media type of the linked resource.
URI	getUri() Returns the link URI (the "href" attribute) if it is a URI; if it is a template, converts it to a URI by removing all variable parameters.
com.atlassian.fugue.Option<UriTemplate>	getUriTemplate() Returns the link URI template if it is a template, or Option.none() if it is a normal URI.
int	hashCode()
boolean	matchType(com.atlassian.fugue.Option<String> desiredType)
String	stringValue() Returns the link URI or link template as a string.

Methods inherited from class java.lang.Object

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

Constructor Detail

Link

public Link(com.atlassian.fugue.Either<UriTemplate,URI> templateOrUri,
    com.atlassian.fugue.Option<String> type)

Method Detail

fromUri

public static Link fromUri(URI uri,
           com.atlassian.fugue.Option<String> type)

fromUriTemplate

public static Link fromUriTemplate(UriTemplate ut,
                   com.atlassian.fugue.Option<String> type)

getUri

public URI getUri()

Returns the link URI (the "href" attribute) if it is a URI; if it is a template, converts it to a URI by removing all variable parameters.

getUriTemplate

public com.atlassian.fugue.Option<UriTemplate> getUriTemplate()

Returns the link URI template if it is a template, or Option.none() if it is a normal URI.

getTemplateOrUri

public com.atlassian.fugue.Either<UriTemplate,URI> getTemplateOrUri()

getType

public com.atlassian.fugue.Option<String> getType()

Returns the optional "type" attribute, indicating the media type of the linked resource. If this is Option.none(), assume that the resource contains JSON.

matchType

public boolean matchType(com.atlassian.fugue.Option<String> desiredType)

stringValue

public String stringValue()

Returns the link URI or link template as a string.

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object