com.atlassian.confluence.api.model.content

Class Reference<T>

java.lang.Object

com.atlassian.confluence.api.model.content.Reference<T>

Type Parameters:

T - - the type of the Referent object

All Implemented Interfaces:

java.lang.Iterable<T>

Direct Known Subclasses:

Reference.CollapsedReference, Reference.EmptyReference, Reference.ExpandedReference

public abstract class Reference<T>
extends java.lang.Object
implements java.lang.Iterable<T>

A reference to a model object. References can be either expanded or collapsed. The object that a reference points to can either exist or not. If a reference both exists and is expanded then call to get() will return the referenced object. Collapsed References provide id properties that give just enough information to identify the referenced object. Model object that wish to be able to have references generated for them need to provide an enum named IdProperties. This enum must have values that match the name of the fields in the object that comprise it's ID.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Reference.CollapsedReference<T>
static class	Reference.EmptyReference<T>
static class	Reference.ExpandedReference<T>

Constructor Summary

Constructors

Constructor and Description
Reference()

Method Summary

Methods

Modifier and Type	Method and Description
static <T> Reference<T>	collapsed(java.lang.Class objClass, java.util.Map idProperties)
static <T> Reference<T>	collapsed(T obj) create a collapse reference to the given object
static <T> Reference<T>	empty(java.lang.Class<T> referrentClass)
abstract boolean	exists()
abstract T	get()
abstract java.util.Map<java.lang.Object,java.lang.Object>	getIdProperties() A map of properties key by the idProperty enum in the model class for the referent object.
java.lang.Object	getIdProperty(java.lang.Enum key)
abstract boolean	isExpanded() indicates a reference is expanded and can be resolved to an object by calling get, or whether the reference is collapsed and calling get will return null.
abstract java.lang.Class<? extends T>	referrentClass()
static <T> Reference<T>	to(T obj) create an exanded reference to the referent object

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

iterator

Constructor Detail

Reference

public Reference()

Method Detail

get

public abstract T get()

Returns:

the reference object or null if the object does not exist

exists

public abstract boolean exists()

Returns:

true if the object is expanded and exists, or is collapsed and has enough information to identify itself, false if the object does not exist (is empty)

isExpanded

public abstract boolean isExpanded()

indicates a reference is expanded and can be resolved to an object by calling get, or whether the reference is collapsed and calling get will return null.

Returns:

getIdProperties

public abstract java.util.Map<java.lang.Object,java.lang.Object> getIdProperties()

A map of properties key by the idProperty enum in the model class for the referent object. The map contains properties sufficient to identify the referent object.

Returns:

a map of id properties keyed by idProperty enum

getIdProperty

public java.lang.Object getIdProperty(java.lang.Enum key)

referrentClass

public abstract java.lang.Class<? extends T> referrentClass()

Returns:

the class of the referent object.

empty

public static <T> Reference<T> empty(java.lang.Class<T> referrentClass)

collapsed

public static <T> Reference<T> collapsed(T obj)

create a collapse reference to the given object

Parameters:

obj -

Returns:

collapsed

public static <T> Reference<T> collapsed(java.lang.Class objClass,
                         java.util.Map idProperties)

to

public static <T> Reference<T> to(T obj)

create an exanded reference to the referent object

Parameters:

obj -

Returns: