org.jclouds.vcloud.director.v1_5.domain
Class Reference

java.lang.Object
  extended by org.jclouds.vcloud.director.v1_5.domain.Reference
Direct Known Subclasses:
CatalogReference, Link, RoleReference, VAppReference

public class Reference
extends Object

A reference to a resource. Contains an href attribute and optional name and type attributes.

 <xs:complexType name="ReferenceType">
 

Author:
grkvlt@apache.org

Nested Class Summary
static class Reference.Builder<B extends Reference.Builder<B>>
           
 
Field Summary
protected static Logger logger
           
 
Constructor Summary
protected Reference()
           
protected Reference(Reference.Builder<?> builder)
           
protected Reference(URI href, String id, String name, String type)
           
 
Method Summary
static Reference.Builder<?> builder()
           
 boolean equals(Object o)
           
 URI getHref()
          Contains the URI to the entity.
 String getId()
          The resource identifier, expressed in URN format.
 String getName()
          Contains the name of the the entity.
 String getType()
          Contains the type of the the entity.
 int hashCode()
           
protected  com.google.common.base.Objects.ToStringHelper string()
           
 Reference toAdminReference(String endpoint)
           
 Reference.Builder<?> toBuilder()
           
 String toString()
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

logger

protected static Logger logger
Constructor Detail

Reference

protected Reference(Reference.Builder<?> builder)

Reference

protected Reference(URI href,
                    String id,
                    String name,
                    String type)

Reference

protected Reference()
Method Detail

builder

public static Reference.Builder<?> builder()

toBuilder

public Reference.Builder<?> toBuilder()

getHref

public URI getHref()
Contains the URI to the entity.

An object reference, expressed in URL format. Because this URL includes the object identifier portion of the id attribute value, it uniquely identifies the object, persists for the life of the object, and is never reused. The value of the href attribute is a reference to a view of the object, and can be used to access a representation of the object that is valid in a particular context. Although URLs have a well-known syntax and a well-understood interpretation, a api should treat each href as an opaque string. The rules that govern how the server constructs href strings might change in future releases.

Returns:
an opaque reference and should never be parsed

getId

public String getId()
The resource identifier, expressed in URN format.

The value of this attribute uniquely identifies the resource, persists for the life of the resource, and is never reused.


getName

public String getName()
Contains the name of the the entity.

The object type, specified as a MIME content type, of the object that the link references. This attribute is present only for links to objects. It is not present for links to actions.

Returns:
type definition, type, expressed as an HTTP Content-Type

getType

public String getType()
Contains the type of the the entity.

The object type, specified as a MIME content type, of the object that the link references. This attribute is present only for links to objects. It is not present for links to actions.

Returns:
type definition, type, expressed as an HTTP Content-Type

equals

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

hashCode

public int hashCode()
Overrides:
hashCode in class Object

toString

public String toString()
Overrides:
toString in class Object

string

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

toAdminReference

public Reference toAdminReference(String endpoint)


Copyright © 2009-2012 jclouds. All Rights Reserved.