com.atlassian.confluence.rest.serialization.enrich

Interface RestEntityEnrichmentManager

All Known Implementing Classes:

DefaultRestEntityEnrichmentManager

@Internal
public interface RestEntityEnrichmentManager

Since:

6.12.0

Method Summary

Modifier and Type	Method and Description
Object	convertAndEnrich(Object entity, SchemaType schemaType) Converts the given entity into a RestEntity if the entity has the RestEnrichable annotation or is a PageResponse that contains RestEnrichable entities.
@NonNull Map<String,Type>	getEnrichedPropertyTypes(Type type, boolean root) Get the types of the properties that may possibly be provided by the enrichers.
boolean	isEnrichableEntity(Class entityType) Get whether an object type can be enriched using a RestEntity.
boolean	isEnrichableList(Class listType) Get whether an object type can be enriched using a RestList.

Method Detail

isEnrichableList

boolean isEnrichableList(Class listType)

Get whether an object type can be enriched using a RestList.

isEnrichableEntity

boolean isEnrichableEntity(Class entityType)

Get whether an object type can be enriched using a RestEntity.

getEnrichedPropertyTypes

@NonNull Map<String,Type> getEnrichedPropertyTypes(Type type,
                                                   boolean root)

Get the types of the properties that may possibly be provided by the enrichers. This is used to populate the graph-ql schema.

Parameters:

type - The type of the object being enriched

Returns:

A map of property names to property types

convertAndEnrich

Object convertAndEnrich(Object entity,
                        SchemaType schemaType)

Converts the given entity into a RestEntity if the entity has the RestEnrichable annotation or is a PageResponse that contains RestEnrichable entities.

Parameters:

entity - the entity to enrich

schemaType - rest or graphql

Returns:

a converted rest entity or the entity that was given