Uses of Class
com.atlassian.confluence.api.model.reference.Reference

Packages that use Reference

Package	Description
com.atlassian.confluence.api.impl.service.content.factory
com.atlassian.confluence.api.model.content
com.atlassian.confluence.api.model.people
com.atlassian.confluence.api.model.permissions	Model objects for user and group permission and validation checks, for use with OperationService.
com.atlassian.confluence.api.model.reference
com.atlassian.confluence.api.model.search
com.atlassian.confluence.api.model.watch
com.atlassian.confluence.api.nav
com.atlassian.confluence.api.testsupport.matchers.model.reference
com.atlassian.confluence.api.testsupport.model.watch
com.atlassian.confluence.dmz.service.content
com.atlassian.confluence.plugins.contentproperty
com.atlassian.confluence.plugins.rest.navigation.v2.impl

Uses of Reference in com.atlassian.confluence.api.impl.service.content.factory

Methods in com.atlassian.confluence.api.impl.service.content.factory that return Reference

Modifier and Type	Method	Description
Reference<Content>	ContentFactory.buildRef(ContentEntityObject entity, Fauxpansions fauxpansions)
Reference<History>	HistoryFactory.buildRef(ContentEntityObject entity, Reference<Content> contentReference, List<ConfluenceUser> editContributors, Fauxpansions fauxpansions, ContentFactory contentFactory)
Reference<Version>	VersionFactory.buildRef(ContentEntityObject entity, Fauxpansions fauxpansions, ContentFactory contentFactory)

Methods in com.atlassian.confluence.api.impl.service.content.factory that return types with arguments of type Reference

Modifier and Type	Method	Description
Map<ContentEntityObject,Reference<History>>	HistoryFactory.buildReferences(Iterable<ContentEntityObject> ceos, Fauxpansions historyExpansions, ContentFactory contentFactory)

Methods in com.atlassian.confluence.api.impl.service.content.factory with parameters of type Reference

Modifier and Type	Method	Description
Reference<History>	HistoryFactory.buildRef(ContentEntityObject entity, Reference<Content> contentReference, List<ConfluenceUser> editContributors, Fauxpansions fauxpansions, ContentFactory contentFactory)

Uses of Reference in com.atlassian.confluence.api.model.content

Fields in com.atlassian.confluence.api.model.content declared as Reference

Modifier and Type	Field	Description
protected Reference<WebResourceDependencies>	FormattedBody.BaseFormattedBodyBuilder.webresource

Methods in com.atlassian.confluence.api.model.content that return Reference

Modifier and Type	Method	Description
static Reference<Content>	Content.buildReference(ContentSelector selector)
static Reference<Content>	Content.buildReference(ContentId id)	Deprecated. since 5.10.
static Reference<History>	History.buildReference(Reference<Content> contentParent)
static Reference<JsonContentProperty>	JsonContentProperty.buildReference(@Nullable JsonContentPropertyId id)	Creates a collapsed reference to a JsonContentProperty with the given id, or an empty reference, if none was given.
static Reference<Space>	Space.buildReference(String spaceKey)	builds a collapsed reference to the space with the given spaceKey
static Reference<Version>	Version.buildReference(int number)
static Reference<Version>	Version.buildReference(Reference<Content> contentRef, int number)	Deprecated. since 5.6 use Version.buildReference(int)
Reference<? extends Container>	Content.getContainerRef()
Reference<Content>	History.getContentParentRef()
Reference<Content>	ContentBody.getContentRef()
Reference<Content>	JsonContentProperty.getContentRef()
Reference<Content>	Version.getContentRef()
Reference<Contributors>	History.getContributors()
Reference<History>	Content.getHistoryRef()
Reference<Content>	Space.getHomepageRef()
Reference<Icon>	Space.getIconRef()
Reference<Version>	History.getLastUpdatedRef()	Get information about the latest published non-draft version of the content.
Reference<Version>	History.getNextVersionRef()	Get the next version, if this is not the newest version.
static Reference<Content>	History.getParentReference(Reference<History> historyReference)
Reference<SpacePermissionContainer>	Space.getPermissions()
Reference<Version>	History.getPreviousVersionRef()	Get the previous version, if this is not the oldest version.
Reference<ContributorUsers>	Contributors.getPublishers()
Reference<RelevantViewRestrictions>	Content.getRelevantViewRestrictions()	Returns a Map of relevant View restrictions present on the given Content including direct inherited View restrictions
Reference<Space>	Content.getSpaceRef()
Reference<Space>	JsonSpaceProperty.getSpaceRef()
Reference<Version>	Content.getVersionRef()

Methods in com.atlassian.confluence.api.model.content that return types with arguments of type Reference

Modifier and Type	Method	Description
Map<ContentRepresentation,Reference<FormattedBody>>	Space.getDescriptionRefs()	Deprecated. Since 5.5.1 Use Space.getDescription().

Methods in com.atlassian.confluence.api.model.content with parameters of type Reference

Modifier and Type	Method	Description
static Reference<History>	History.buildReference(Reference<Content> contentParent)
static Reference<Version>	Version.buildReference(Reference<Content> contentRef, int number)	Deprecated. since 5.6 use Version.buildReference(int)
Content.ContentBuilder	Content.ContentBuilder.container(Reference<? extends Container> container)
ContentBody.ContentBodyBuilder	ContentBody.ContentBodyBuilder.content(@NonNull Reference<Content> contentRef)
History.HistoryBuilder	History.HistoryBuilder.content(Reference<Content> content)
JsonContentProperty.ContentPropertyBuilder	JsonContentProperty.ContentPropertyBuilder.content(Reference<Content> contentRef)
Version.VersionBuilder	Version.VersionBuilder.content(Reference<Content> content)
History.HistoryBuilder	History.HistoryBuilder.contributors(Reference<Contributors> contributors)
Space.SpaceBuilder	Space.SpaceBuilder.description(ContentRepresentation representation, Reference<FormattedBody> formattedBody)	Deprecated. since 5.6 use Space.SpaceBuilder.description(ContentRepresentation, FormattedBody)
static ContentBody	ContentBody.emptyBody(ContentRepresentation representation, Reference<Content> contentReference)
static ContentId	Content.getContentId(Reference<Content> contentRef)	Deprecated. since 5.10.
static Reference<Content>	History.getParentReference(Reference<History> historyReference)
static ContentSelector	Content.getSelector(Reference<Content> contentRef)	Get the selector from a Content Reference.
static String	Space.getSpaceKey(Reference<Space> reference)
static int	Version.getVersionNumber(Reference<Version> versionRef)
Content.ContentBuilder	Content.ContentBuilder.history(Reference<History> history)
Space.SpaceBuilder	Space.SpaceBuilder.homepage(Reference<Content> homepageRef)
Space.SpaceBuilder	Space.SpaceBuilder.icon(Reference<Icon> iconRef)
History.HistoryBuilder	History.HistoryBuilder.lastUpdated(Reference<Version> lastUpdated)
History.HistoryBuilder	History.HistoryBuilder.nextVersion(Reference<Version> nextVersion)
Space.SpaceBuilder	Space.SpaceBuilder.permissions(Reference<SpacePermissionContainer> spacePermissions)
History.HistoryBuilder	History.HistoryBuilder.previousVersion(Reference<Version> previousVersion)
Contributors.Builder	Contributors.Builder.publishers(Reference<ContributorUsers> publishers)
Content.ContentBuilder	Content.ContentBuilder.relevantViewRestrictionsReference(Reference<RelevantViewRestrictions> relevantViewRestrictions)
Space.SpaceBuilder	Space.SpaceBuilder.retentionPolicy(Reference<SpaceRetentionPolicy> retentionPolicyRef)
Content.ContentBuilder	Content.ContentBuilder.space(Reference<Space> space)
JsonSpaceProperty.SpacePropertyBuilder	JsonSpaceProperty.SpacePropertyBuilder.space(Reference<Space> space)
Content.ContentBuilder	Content.ContentBuilder.version(Reference<Version> version)
JsonContentProperty.ContentPropertyBuilder	JsonContentProperty.ContentPropertyBuilder.version(Reference<Version> version)
T	FormattedBody.BaseFormattedBodyBuilder.webresource(@NonNull Reference<WebResourceDependencies> webresource)

Constructors in com.atlassian.confluence.api.model.content with parameters of type Reference

Modifier	Constructor	Description
	ContentBody(ContentRepresentation representation, String value, Reference<Content> contentReference)	Deprecated. since 5.9 , use ContentBody.contentBodyBuilder()
	ContentBody(ContentRepresentation representation, String value, Reference<Content> contentReference, Reference<WebResourceDependencies> webresource)	Deprecated. since 5.9 , use ContentBody.contentBodyBuilder()

Uses of Reference in com.atlassian.confluence.api.model.people

Fields in com.atlassian.confluence.api.model.people declared as Reference

Modifier and Type	Field	Description
protected Reference<Icon>	Person.PersonBuilder.profilePicture

Methods in com.atlassian.confluence.api.model.people that return Reference

Modifier and Type	Method	Description
Reference<String>	KnownUser.getLastLoginRef()
Reference<UserStatus>	KnownUser.getStatusRef()

Constructors in com.atlassian.confluence.api.model.people with parameters of type Reference

Modifier	Constructor	Description
	Anonymous(Reference<Icon> profilePicture, String displayName)
	KnownUser(Reference<Icon> profilePicture, String username, String displayName, String userKey)
protected	Person(Reference<Icon> profilePicture, String displayName)
	UnknownUser(Reference<Icon> profilePicture, String username, String displayName, String userKey)
	User(Reference<Icon> profilePicture, String username, String displayName, String userKey)
	User(String username, String displayName, com.atlassian.sal.api.user.UserKey userKey, Reference<Icon> profilePicture)

Uses of Reference in com.atlassian.confluence.api.model.permissions

Methods in com.atlassian.confluence.api.model.permissions that return Reference

Modifier and Type	Method	Description
static Reference<RelevantViewRestrictions>	RelevantViewRestrictions.buildReference(Navigation.Builder builder)
Reference<Content>	ContentRestriction.getContent()

Methods in com.atlassian.confluence.api.model.permissions with parameters of type Reference

Modifier and Type	Method	Description
ContentRestriction.ContentRestrictionBuilder	ContentRestriction.ContentRestrictionBuilder.content(Reference<Content> content)
static Navigation.Builder	RelevantViewRestrictions.getNavigationBuilder(Reference<RelevantViewRestrictions> historyReference)

Uses of Reference in com.atlassian.confluence.api.model.reference

Subclasses of Reference in com.atlassian.confluence.api.model.reference

Modifier and Type	Class	Description
final class	ExpandedReference<T>	An expanded reference has a value, call get() will return that referent value.

Methods in com.atlassian.confluence.api.model.reference that return Reference

Modifier and Type	Method	Description
static <T> Reference<T>	Reference.collapsed(Class<T> objClass)
static <T> Reference<T>	Reference.collapsed(Class<T> objClass, Map idProperties)
static <T> Reference<T>	Reference.collapsed(T obj)	Create a collapse reference to the given object.
static <T> Reference<T>	Reference.empty(Class<T> referrentClass)	Create an empty reference to the given class.
static <T> Reference<T>	Reference.orEmpty(Reference<T> reference, Class<T> referentClass)
static <T> Reference<T>	Reference.orEmpty(T entity, Class<T> referentClass)
static <T> Reference<T>	Reference.to(T value)	Create an expanded reference to the referent value.

Methods in com.atlassian.confluence.api.model.reference with parameters of type Reference

Modifier and Type	Method	Description
static <T> Reference<T>	Reference.orEmpty(Reference<T> reference, Class<T> referentClass)

Uses of Reference in com.atlassian.confluence.api.model.search

Methods in com.atlassian.confluence.api.model.search that return Reference

Modifier and Type	Method	Description
Reference<Content>	ContentSearchResult.getEntityRef()
protected final Reference<T>	SearchResult.Builder.getEntityRef()
abstract Reference<T>	SearchResult.getEntityRef()
Reference<Space>	SpaceSearchResult.getEntityRef()
Reference<User>	UserSearchResult.getEntityRef()
Reference<ContainerSummary>	SearchResult.getResultGlobalContainerRef()
Reference<ContainerSummary>	SearchResult.getResultParentRef()

Uses of Reference in com.atlassian.confluence.api.model.watch

Methods in com.atlassian.confluence.api.model.watch with parameters of type Reference

Modifier and Type	Method	Description
ContentWatch.ContentWatchBuilder	ContentWatch.ContentWatchBuilder.content(Reference<Content> content)
SpaceWatch.SpaceWatchBuilder	SpaceWatch.SpaceWatchBuilder.space(Reference<Space> space)

Constructors in com.atlassian.confluence.api.model.watch with parameters of type Reference

Modifier	Constructor	Description
	SpaceWatch(@NonNull User watcher, @NonNull Reference<Space> space, List<ContentType> contentTypes)

Uses of Reference in com.atlassian.confluence.api.nav

Methods in com.atlassian.confluence.api.nav with parameters of type Reference

Modifier and Type	Method	Description
Navigation.ContentNav	Navigation.content(Reference<Content> contentReference)	create a content nav builder to reference a piece of content
Navigation.ExperimentalContentNav	Navigation.ExperimentalNav.content(Reference<Content> contentReference)	create a content nav builder to reference a piece of content
Navigation.Builder	Navigation.fromReference(Reference<?> reference)
Navigation.SpaceNav	Navigation.space(Reference<Space> spaceReference)	create a space nav builder to reference the given space
Navigation.SpacePermissionNav	Navigation.spacePermission(Reference<SpacePermissionContainer> spacePermissions)	create a space permission nav builder to reference all the permissions of the given space restriction

Uses of Reference in com.atlassian.confluence.api.testsupport.matchers.model.reference

Methods in com.atlassian.confluence.api.testsupport.matchers.model.reference that return types with arguments of type Reference

Modifier and Type	Method	Description
static org.hamcrest.Matcher<Reference<?>>	ReferenceMatchers.isCollapsedReferenceWithOrWithoutProperties(Class<?> expectedReferentClass)	Matches collapsed references to the specified class, even if they are non-specific ones without properties set for generating navigation links
static org.hamcrest.Matcher<Reference<?>>	ReferenceMatchers.isCollapsedReferenceWithProperties(Class<?> expectedReferentClass)	Matches collapsed references to the specified class, and checks they have properties set for generating navigation links

Uses of Reference in com.atlassian.confluence.api.testsupport.model.watch

Constructors in com.atlassian.confluence.api.testsupport.model.watch with parameters of type Reference

Modifier	Constructor	Description
	ExtendedSpaceWatch(String name, User watcher, Reference<Space> space, List<ContentType> contentTypes)

Uses of Reference in com.atlassian.confluence.dmz.service.content

Methods in com.atlassian.confluence.dmz.service.content that return Reference

Modifier and Type	Method	Description
Reference<WebResourceDependencies>	ContentBodyConversionManager.ConversionResult.dependenciesRef()	Returns the value of the dependenciesRef record component.

Constructors in com.atlassian.confluence.dmz.service.content with parameters of type Reference

Modifier	Constructor	Description
	ConversionResult(String convertedContentBody, Reference<WebResourceDependencies> dependenciesRef)	Creates an instance of a ConversionResult record class.

Uses of Reference in com.atlassian.confluence.plugins.contentproperty

Methods in com.atlassian.confluence.plugins.contentproperty that return Reference

Modifier and Type	Method	Description
Reference<Version>	JsonPropertyFactory.makeVersion(ContentEntityObject entity, boolean expanded)

Uses of Reference in com.atlassian.confluence.plugins.rest.navigation.v2.impl

Methods in com.atlassian.confluence.plugins.rest.navigation.v2.impl with parameters of type Reference

Modifier and Type	Method	Description
Navigation.ContentNav	RestNavigationImpl.content(Reference<Content> contentReference)
Navigation.Builder	RestNavigationImpl.fromReference(Reference reference)
Navigation.SpaceNav	RestNavigationImpl.space(Reference<Space> space)
Navigation.SpacePermissionNav	RestNavigationImpl.spacePermission(Reference<SpacePermissionContainer> spacePermissions)