org.jclouds.openstack.v2_0.domain
Class Link

java.lang.Object
  extended by org.jclouds.openstack.v2_0.domain.Link

public class Link
extends Object

For convenience, resources contain links to themselves. This allows a api to easily obtain a resource URIs rather than to construct them.

Author:
AdrianCole
See Also:

Nested Class Summary
static class Link.Builder
           
static class Link.Relation
          Relations associated with resources.
 
Constructor Summary
protected Link(Link.Relation relation, com.google.common.base.Optional<String> type, URI href)
           
 
Method Summary
static Link.Builder builder()
           
static Link create(Link.Relation relation, String type, URI href)
           
static Link create(Link.Relation relation, URI href)
           
 boolean equals(Object obj)
           
 URI getHref()
           
 Link.Relation getRelation()
          There are three kinds of link relations associated with resources.
 com.google.common.base.Optional<String> getType()
           
 int hashCode()
           
protected  com.google.common.base.Objects.ToStringHelper string()
           
 Link.Builder toBuilder()
           
 String toString()
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Link

@ConstructorProperties(value={"rel","type","href"})
protected Link(Link.Relation relation,
                                          com.google.common.base.Optional<String> type,
                                          URI href)
Method Detail

create

public static Link create(Link.Relation relation,
                          URI href)

create

public static Link create(Link.Relation relation,
                          String type,
                          URI href)

builder

public static Link.Builder builder()

toBuilder

public Link.Builder toBuilder()

getRelation

public Link.Relation getRelation()
There are three kinds of link relations associated with resources. A self link contains a versioned link to the resource. These links should be used in cases where the link will be followed immediately. A bookmark link provides a permanent link to a resource that is appropriate for long term storage. An alternate link can contain an alternate representation of the resource. For example, an OpenStack Compute image may have an alternate representation in the OpenStack Image service. Note that the type attribute here is used to provide a hint as to the type of representation to expect when following the link.

Returns:
the relation of the resource in the current OpenStack deployment

getType

public com.google.common.base.Optional<String> getType()
Returns:
the type of the resource or null if not specified

getHref

public URI getHref()
Returns:
the href of the resource

hashCode

public int hashCode()
Overrides:
hashCode in class Object

equals

public boolean equals(Object obj)
Overrides:
equals in class Object

string

protected com.google.common.base.Objects.ToStringHelper string()

toString

public String toString()
Overrides:
toString in class Object


Copyright © 2009-2013 The Apache Software Foundation. All Rights Reserved.