com.atlassian.confluence.api.model.content

Class Reference.EmptyReference<T>

java.lang.Object

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

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

All Implemented Interfaces:

java.lang.Iterable<T>

Enclosing class:

Reference<T>

public static class Reference.EmptyReference<T>
extends Reference<T>

Nested Class Summary

Nested classes/interfaces inherited from class com.atlassian.confluence.api.model.content.Reference

Reference.CollapsedReference<T>, Reference.EmptyReference<T>, Reference.ExpandedReference<T>

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Reference.EmptyReference(java.lang.Class<T> referentClass)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	exists()
T	get()
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.
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.
java.util.Iterator<T>	iterator()
java.lang.Class<? extends T>	referrentClass()

Methods inherited from class com.atlassian.confluence.api.model.content.Reference

collapsed, collapsed, empty, getIdProperty, to

Methods inherited from class java.lang.Object

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

Constructor Detail

Reference.EmptyReference

protected Reference.EmptyReference(java.lang.Class<T> referentClass)

Method Detail

get

public T get()

Specified by:

get in class Reference<T>

Returns:

the reference object or null if the object does not exist

exists

public boolean exists()

Specified by:

exists in class Reference<T>

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 boolean isExpanded()

Description copied from class: Reference

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.

Specified by:

isExpanded in class Reference<T>

Returns:

getIdProperties

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

Description copied from class: Reference

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.

Specified by:

getIdProperties in class Reference<T>

Returns:

a map of id properties keyed by idProperty enum

referrentClass

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

Specified by:

referrentClass in class Reference<T>

Returns:

the class of the referent object.

iterator

public java.util.Iterator<T> iterator()