Class RestListLinkEnricher
- java.lang.Object
-
- com.atlassian.confluence.plugins.restapi.enrich.AbstractLinkEnricher
-
- com.atlassian.confluence.plugins.restapi.enrich.model.RestListLinkEnricher
-
- All Implemented Interfaces:
CollectionEnricher,RestObjectEnricher
public class RestListLinkEnricher extends AbstractLinkEnricher implements CollectionEnricher
Enricher which populates extra links inContentRestrictionsPageResponses At the moment of creation it did not enrich any otherRestLists.
-
-
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 RestListLinkEnricher(RestNavigationService navigationService, GraphQL graphql)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidenrich(RestList enrich, SchemaType schemaType)@NonNull Map<String,Type>getEnrichedPropertyTypes(@NonNull Type type)Get the types of the properties that may possibly be provided by this enricher.booleanisRecursive()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
-
RestListLinkEnricher
public RestListLinkEnricher(RestNavigationService navigationService, GraphQL graphql)
-
-
Method Detail
-
isRecursive
public boolean isRecursive()
Description copied from interface:RestObjectEnricherGet whether the enricher applies to the root object only, or recursively to all objects in the tree.- Specified by:
isRecursivein interfaceRestObjectEnricher
-
getEnrichedPropertyTypes
public @NonNull Map<String,Type> getEnrichedPropertyTypes(@NonNull Type type)
Description copied from interface:RestObjectEnricherGet the types of the properties that may possibly be provided by this enricher. This is used to populate the graph-ql schema.- Specified by:
getEnrichedPropertyTypesin interfaceRestObjectEnricher- Parameters:
type- The type of the object being enriched- Returns:
- A map of property names to property types
-
enrich
public void enrich(RestList enrich, SchemaType schemaType)
- Specified by:
enrichin interfaceCollectionEnricher
-
-