Class SpaceEnricher
- java.lang.Object
-
- com.atlassian.confluence.plugins.restapi.enrich.AbstractLinkEnricher
-
- com.atlassian.confluence.plugins.restapi.enrich.model.SpaceEnricher
-
- All Implemented Interfaces:
EntityEnricher
,RestObjectEnricher
public class SpaceEnricher extends AbstractLinkEnricher implements EntityEnricher
-
-
Field Summary
-
Fields inherited from class com.atlassian.confluence.plugins.restapi.enrich.AbstractLinkEnricher
graphql, navigationService, ORIGINAL_LINKS_PROPERTY, SELF_LINK
-
-
Constructor Summary
Constructors Constructor Description SpaceEnricher(RestNavigationService navigationService, GraphQL graphql)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
enrich(@NonNull RestEntity entity, @NonNull SchemaType schemaType)
@NonNull Map<String,Type>
getEnrichedPropertyTypes(@NonNull Type type)
Get the types of the properties that may possibly be provided by this enricher.boolean
isRecursive()
Get whether the enricher applies to the root object only, or recursively to all objects in the tree.-
Methods inherited from class com.atlassian.confluence.plugins.restapi.enrich.AbstractLinkEnricher
enrichLinks, enrichWithLink, getEnrichedPropertyTypes, navigation
-
-
-
-
Constructor Detail
-
SpaceEnricher
public SpaceEnricher(RestNavigationService navigationService, GraphQL graphql)
-
-
Method Detail
-
isRecursive
public boolean isRecursive()
Description copied from interface:RestObjectEnricher
Get whether the enricher applies to the root object only, or recursively to all objects in the tree.- Specified by:
isRecursive
in interfaceRestObjectEnricher
-
getEnrichedPropertyTypes
public @NonNull Map<String,Type> getEnrichedPropertyTypes(@NonNull Type type)
Description copied from interface:RestObjectEnricher
Get the types of the properties that may possibly be provided by this enricher. This is used to populate the graph-ql schema.- Specified by:
getEnrichedPropertyTypes
in interfaceRestObjectEnricher
- Parameters:
type
- The type of the object being enriched- Returns:
- A map of property names to property types
-
enrich
public void enrich(@NonNull RestEntity entity, @NonNull SchemaType schemaType)
- Specified by:
enrich
in interfaceEntityEnricher
-
-