com.atlassian.confluence.plugins.restapi.metadata.content

Class LabelsModelMetadataProvider

java.lang.Object

com.atlassian.confluence.plugins.restapi.metadata.content.LabelsModelMetadataProvider

All Implemented Interfaces:

ModelMetadataProvider

public class LabelsModelMetadataProvider
extends Object
implements ModelMetadataProvider

Provides content metadata pertaining to labels on a Content entity.

Constructor Summary

Constructors

Constructor and Description
LabelsModelMetadataProvider(ContentLabelService contentLabelService, RestNavigationService navigationService)

Method Summary

Modifier and Type	Method and Description
Map<Object,Map<String,?>>	getMetadataForAll(Iterable<Object> entities, Expansions expansions) Fetches metadata for a list of entities, returning a map of maps of metadata.
List<String>	getMetadataProperties() Get the list of properties that this ModelMetadataProvider provides metadata for.
List<MetadataProperty>	getProperties() Get the type hierarchy of the fields and their types provided by this ModelMetadataProvider.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.confluence.api.extension.ModelMetadataProvider

getMetadata

Constructor Detail

LabelsModelMetadataProvider

public LabelsModelMetadataProvider(ContentLabelService contentLabelService,
                                   RestNavigationService navigationService)

Method Detail

getMetadataForAll

public Map<Object,Map<String,?>> getMetadataForAll(Iterable<Object> entities,
                                                   Expansions expansions)

Description copied from interface: ModelMetadataProvider

Fetches metadata for a list of entities, returning a map of maps of metadata. Initially keyed by the entity, and then by the metadata property. Implementors should attempt to fetch the metadata efficiently and try to avoid performing an individual query per entity.

Specified by:

getMetadataForAll in interface ModelMetadataProvider

Parameters:

entities - - a list of entities to fetch the metadata for

expansions - - indicating which metadata (and at which depth) should be fetched for each entity

Returns:

a map of maps of metadata, keyed by entity.

getMetadataProperties

public List<String> getMetadataProperties()

Description copied from interface: ModelMetadataProvider

Get the list of properties that this ModelMetadataProvider provides metadata for.

Specified by:

getMetadataProperties in interface ModelMetadataProvider

getProperties

public List<MetadataProperty> getProperties()

Description copied from interface: ModelMetadataProvider

Get the type hierarchy of the fields and their types provided by this ModelMetadataProvider. This is used by graph-ql to contribute to the graph schema.

Specified by:

getProperties in interface ModelMetadataProvider