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

Packages that use Reference

Package	Description
com.atlassian.confluence.api.impl.service.content
com.atlassian.confluence.api.impl.service.content.factory
com.atlassian.confluence.api.model.content
com.atlassian.confluence.api.model.lookandfeel.theme
com.atlassian.confluence.api.model.people
com.atlassian.confluence.api.model.people.details
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.relations
com.atlassian.confluence.api.model.search
com.atlassian.confluence.api.model.settings
com.atlassian.confluence.api.nav
com.atlassian.confluence.api.testsupport.matchers.model.reference
com.atlassian.confluence.plugins.contentproperty
com.atlassian.confluence.plugins.rest.navigation.impl

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

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

Modifier and Type	Method and Description
Reference<WebResourceDependencies>	ContentBodyConversionResult.getWebResourceDependencies()

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

Modifier and Type	Method and Description
ContentBodyConversionResult.ContentBodyConversionResultBuilder	ContentBodyConversionResult.ContentBodyConversionResultBuilder.withWebResourceDependencies(Reference<WebResourceDependencies> webResourceDependencies)

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 and Description
default Reference<Content>	ContentModelFactory.buildRef(ContentEntityObject entity, ContentBodyConversionContext contentBodyConversionContext, Fauxpansions fauxpansions) Convenience method for building References to Confluence entities after converting them to their corresponding model type.
default Reference<Content>	ContentModelFactory.buildRef(ContentEntityObject entity, Fauxpansions fauxpansions) Convenience method for building References to Confluence entities after converting them to their corresponding model type.
Reference<Version>	VersionFactory.buildRef(ContentEntityObject entity, Fauxpansions fauxpansions, ContentModelFactory contentFactory)
Reference<History>	HistoryFactory.buildRef(ContentEntityObject entity, Reference<Content> contentReference, List<ConfluenceUser> editContributors, Fauxpansions fauxpansions, ContentModelFactory contentFactory)
protected Reference<Content>	AbstractSpaceFactory.getHomepageRef(H space, Expansions expansions)
protected Reference<Icon>	AbstractSpaceFactory.getIconIfExpanded(H space, Expansions expansions)
protected Reference<LookAndFeel>	AbstractSpaceFactory.getSpaceLookAndFeel(String spaceKey, Expansions expansions)
protected Reference<SpaceSettings>	AbstractSpaceFactory.getSpaceSettings(String spaceKey, Expansions expansions)
protected Reference<Theme>	AbstractSpaceFactory.getSpaceTheme(String spaceKey, Expansions expansions)

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

Modifier and Type	Method and Description
Map<ContentType,Reference<Boolean>>	ChildContentFactory.buildChildTypesMap(ContentConvertible parent, Fauxpansions fauxpansions) Deprecated.
Map<ContentConvertible,Map<ContentType,Reference<Boolean>>>	ChildContentFactory.buildChildTypesMap(Iterable<ContentConvertible> parents, Fauxpansions fauxpansions)
Map<ContentEntityObject,Reference<History>>	HistoryFactory.buildReferences(Iterable<ContentEntityObject> ceos, Fauxpansions historyExpansions, ContentModelFactory contentFactory)

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

Modifier and Type	Method and Description
Reference<History>	HistoryFactory.buildRef(ContentEntityObject entity, Reference<Content> contentReference, List<ConfluenceUser> editContributors, Fauxpansions fauxpansions, ContentModelFactory 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 and Description
protected Reference<WebResourceDependencies>	FormattedBody.BaseFormattedBodyBuilder.webresource

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

Modifier and Type	Method and Description
static Reference<Content>	Content.buildReference(ContentId id) Deprecated. Since 6.0. Use Content.buildReference(ContentSelector)
static Reference<Content>	Content.buildReference(ContentSelector selector)
static Reference<Version>	Version.buildReference(int number)
static Reference<JsonContentProperty>	JsonContentProperty.buildReference(JsonPropertyId id) Creates a collapsed reference to a JsonContentProperty with the given id, or an empty reference, if none was given.
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)
static Reference<Space>	Space.buildReference(String spaceKey) builds a collapsed reference to the space with the given spaceKey
Reference<ContributorUsers>	Version.getCollaboratorsRef()
Reference<? extends Container>	Content.getContainerRef()
Reference<Content>	History.getContentParentRef()
Reference<Content>	Version.getContentRef()
Reference<Content>	JsonContentProperty.getContentRef()
Reference<Content>	ContentBody.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<LookAndFeel>	Space.getLookAndFeelRef()
Reference<Version>	History.getNextVersionRef() Get the next version, if this is not the newest version.
static Reference<Content>	History.getParentReference(Reference<History> historyReference)
Reference<Version>	History.getPreviousVersionRef() Get the previous version, if this is not the oldest version.
Reference<ContributorUsers>	Contributors.getPublishers()
Reference<SpaceSettings>	Space.getSettingsRef()
Reference<Space>	JsonSpaceProperty.getSpaceRef()
Reference<Space>	Content.getSpaceRef()
Reference<Theme>	Space.getThemeRef()
Reference<Version>	Content.getVersionRef()

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

Modifier and Type	Method and Description
Map<ContentType,Reference<Boolean>>	Content.getChildTypes() Returns a map of all possibly containing child types.
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 and 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)
Version.VersionBuilder	Version.VersionBuilder.collaborators(Reference<ContributorUsers> collaborators)
Content.ContentBuilder	Content.ContentBuilder.container(Reference<? extends Container> container)
Version.VersionBuilder	Version.VersionBuilder.content(Reference<Content> content)
JsonContentProperty.ContentPropertyBuilder	JsonContentProperty.ContentPropertyBuilder.content(Reference<Content> contentRef)
History.HistoryBuilder	History.HistoryBuilder.content(Reference<Content> content)
ContentBody.ContentBodyBuilder	ContentBody.ContentBodyBuilder.content(Reference<Content> contentRef)
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)
EmbeddedContent.EmbeddedContentBuilder<T>	EmbeddedContent.EmbeddedContentBuilder.entity(Reference<T> entity)
static ContentId	Content.getContentId(Reference<Content> contentRef) Deprecated. Since 6.0. Use Content.getSelector().
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)
Space.SpaceBuilder	Space.SpaceBuilder.lookAndFeel(Reference<LookAndFeel> lookAndFeel)
History.HistoryBuilder	History.HistoryBuilder.nextVersion(Reference<Version> nextVersion)
History.HistoryBuilder	History.HistoryBuilder.previousVersion(Reference<Version> previousVersion)
Contributors.Builder	Contributors.Builder.publishers(Reference<ContributorUsers> publishers)
Space.SpaceBuilder	Space.SpaceBuilder.settings(Reference<SpaceSettings> settings)
JsonSpaceProperty.SpacePropertyBuilder	JsonSpaceProperty.SpacePropertyBuilder.space(Reference<Space> space)
Content.ContentBuilder	Content.ContentBuilder.space(Reference<Space> space)
Space.SpaceBuilder	Space.SpaceBuilder.theme(Reference<Theme> theme)
JsonContentProperty.ContentPropertyBuilder	JsonContentProperty.ContentPropertyBuilder.version(Reference<Version> version)
Content.ContentBuilder	Content.ContentBuilder.version(Reference<Version> version)
T	FormattedBody.BaseFormattedBodyBuilder.webresource(Reference<WebResourceDependencies> webresource)

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

Modifier and Type	Method and Description
Content.ContentBuilder	Content.ContentBuilder.childTypes(Map<ContentType,Reference<Boolean>> childTypes)

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

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

Uses of Reference in com.atlassian.confluence.api.model.lookandfeel.theme

Methods in com.atlassian.confluence.api.model.lookandfeel.theme that return Reference

Modifier and Type	Method and Description
static <T> Reference<T>	Theme.buildReference(Class<T> referentClass, Reference<Space> spaceRef)
Reference<Space>	Theme.getSpaceReference()
static Reference<Space>	Theme.getSpaceReference(Reference<Theme> reference)

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

Modifier and Type	Method and Description
static <T> Reference<T>	Theme.buildReference(Class<T> referentClass, Reference<Space> spaceRef)
static Reference<Space>	Theme.getSpaceReference(Reference<Theme> reference)
Theme.ThemeBuilder	Theme.ThemeBuilder.space(Reference<Space> spaceRef)

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

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

Modifier and Type	Method and Description
static com.atlassian.sal.api.user.UserKey	User.getUserKey(Reference<User> userReference)

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

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

Modifier and Type	Method and Description
UserDetails.UserDetailsBuilder	UserDetails.UserDetailsBuilder.businessDetails(Reference<BusinessDetails> businessDetails)
UserDetails.UserDetailsBuilder	UserDetails.UserDetailsBuilder.personalDetails(Reference<PersonalDetails> personalDetails)

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 and Description
Reference<Content>	ContentRestriction.getContent()

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

Modifier and Type	Method and Description
ContentRestriction.ContentRestrictionBuilder	ContentRestriction.ContentRestrictionBuilder.content(Reference<Content> content)

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

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

Modifier and Type	Class and Description
class	ExpandedReference<T> An expanded reference has a value, call get() will return that referent value.
class	ExpandedWrapperReference<T> A Reference wrapping an Object that cannot resolve navigation by itself.

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

Modifier and Type	Method and 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>	BuilderUtils.collapsedWrapperReference(Class<? extends T> referentClass, Navigation.Builder navBuilder) Create a new collapsed Reference with the supplied Navigation.Builder.
static <T> Reference<T>	Reference.empty(Class<T> referrentClass) Create an empty reference to the given class.
static <T> Reference<T>	BuilderUtils.expandedWrapperReference(T value, Navigation.Builder navBuilder) Create a new expanded Reference with the supplied Navigation.Builder.
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 and Description
static <T> Reference<T>	Reference.orEmpty(Reference<T> reference, Class<T> referentClass)

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

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

Modifier and Type	Method and Description
Reference<RelationData>	RelationInstance.getRelationDataRef()
Reference<S>	RelationInstance.getSourceRef()
Reference<T>	RelationInstance.getTargetRef()

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

Modifier and Type	Method and Description
static <S extends Relatable,T extends Relatable> RelationInstance.RelationInstanceBuilder<S,T>	RelationInstance.builder(Reference<S> sourceRef, RelationDescriptor<S,T> relationDescriptor, Reference<T> targetRef)
static <S extends Relatable,T extends Relatable> RelationInstance.RelationInstanceBuilder<S,T>	RelationInstance.builder(Reference<S> sourceRef, RelationDescriptor<S,T> relationDescriptor, Reference<T> targetRef)
RelationInstance.RelationInstanceBuilder<S,T>	RelationInstance.RelationInstanceBuilder.relationData(Reference<RelationData> data)

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

Constructor and Description
RelationInstanceBuilder(Reference<S> sourceRef, RelationDescriptor<S,T> relationDescriptor, Reference<T> targetRef)
RelationInstanceBuilder(Reference<S> sourceRef, RelationDescriptor<S,T> relationDescriptor, Reference<T> targetRef)

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 and Description
Reference<User>	UserSearchResult.getEntityRef()
Reference<Space>	SpaceSearchResult.getEntityRef()
abstract Reference<T>	SearchResult.getEntityRef()
protected Reference<T>	SearchResult.Builder.getEntityRef()
Reference<Content>	ContentSearchResult.getEntityRef()
Reference<ContainerSummary>	SearchResult.getResultGlobalContainerRef()
Reference<ContainerSummary>	SearchResult.getResultParentRef()

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

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

Modifier and Type	Method and Description
static <T> Reference<T>	SpaceSettings.buildReference(Class<T> referentClass, Reference<Space> spaceRef)
static <T> Reference<T>	LookAndFeel.buildReference(Class<T> referentClass, Reference<Space> spaceRef)
Reference<Space>	SpaceSettings.getSpaceReference()
Reference<Space>	LookAndFeel.getSpaceReference()
static Reference<Space>	LookAndFeel.getSpaceReference(Reference<LookAndFeel> reference)
static Reference<Space>	SpaceSettings.getSpaceReference(Reference<SpaceSettings> reference)

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

Modifier and Type	Method and Description
static <T> Reference<T>	SpaceSettings.buildReference(Class<T> referentClass, Reference<Space> spaceRef)
static <T> Reference<T>	LookAndFeel.buildReference(Class<T> referentClass, Reference<Space> spaceRef)
static Reference<Space>	LookAndFeel.getSpaceReference(Reference<LookAndFeel> reference)
static Reference<Space>	SpaceSettings.getSpaceReference(Reference<SpaceSettings> reference)
SpaceSettings.SpaceSettingsBuilder	SpaceSettings.SpaceSettingsBuilder.space(Reference<Space> spaceRef)
LookAndFeel.LookAndFeelBuilder	LookAndFeel.LookAndFeelBuilder.space(Reference<Space> spaceRef)

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 and 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.RelationToNav	Navigation.RelationFromNav.from(Reference<? extends Relatable> reference)
Navigation.Builder	Navigation.fromReference(Reference<?> reference)
Navigation.Builder	Navigation.SettingsNav.lookAndFeel(Reference<Space> reference)
Navigation.SpaceNav	Navigation.space(Reference<Space> spaceReference) create a space nav builder to reference the given space
Navigation.Builder	Navigation.RelationToNav.to(Reference<? extends Relatable> reference)

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 and 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.plugins.contentproperty

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

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

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

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

Modifier and Type	Method and Description
Navigation.ContentNav	RestNavigationImpl.content(Reference<Content> contentReference)
Navigation.RelationToNav	RelationNavImpl.from(Reference<? extends Relatable> reference)
Navigation.Builder	RestNavigationImpl.fromReference(Reference reference)
Navigation.SpaceNav	RestNavigationImpl.space(Reference<Space> space)
Navigation.Builder	RelationNavImpl.to(Reference<? extends Relatable> reference)
Navigation.UserNav	RestNavigationImpl.user(Reference<User> user)