# Index

B C D E F G H I K L M N O P Q R S T V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

## B

build() - Method in class org.apache.sling.graphql.helpers.GenericConnection.Builder
  Build the Connection - can only be called once.
Builder(Iterator<T>, Function<T, String>) - Constructor for class org.apache.sling.graphql.helpers.GenericConnection.Builder
  Builder for a Connection that will output the supplied data, optionally skipping items at the beginning and considering a set maximum of items.

## C

cacheQuery(String, String, String) - Method in interface org.apache.sling.graphql.api.cache.GraphQLCacheProvider
  Stores the `query` into the cache, potentially overriding a previous value.
clear() - Method in class org.apache.sling.graphql.helpers.lazyloading.LazyLoadingMap
computeAllThrowsException(boolean) - Method in class org.apache.sling.graphql.helpers.lazyloading.LazyLoadingMap
  Optionally throw a RuntimeException if computeAll is called
computeValueOnRemove(boolean) - Method in class org.apache.sling.graphql.helpers.lazyloading.LazyLoadingMap
  Optionally compute the value on remove, so that it doesn't return null
Connection<T> - Interface in org.apache.sling.graphql.api.pagination
  The `Connection` interface provides support for implementing the Connection Types, according to the specification from https://relay.dev/graphql/connections.htm#sec-Connection-Types.
contains(String) - Method in interface org.apache.sling.graphql.api.SelectionSet
  Returns `true` if the selection set contains the field identified by `qualifiedName`.
containsKey(Object) - Method in class org.apache.sling.graphql.helpers.lazyloading.LazyLoadingMap
containsValue(Object) - Method in class org.apache.sling.graphql.helpers.lazyloading.LazyLoadingMap
  Calls computeAll - should be avoided if possible
Cursor - Class in org.apache.sling.graphql.api.pagination
  This class provides a Base64-encoded cursor which is used for paginated results, according to the specification from https://relay.dev/graphql/connections.htm#sec-Cursor.
Cursor(String) - Constructor for class org.apache.sling.graphql.api.pagination.Cursor
  Creates a cursor from a `String`.

## D

DEFAULT_LIMIT - Static variable in class org.apache.sling.graphql.helpers.GenericConnection

## E

Edge<T> - Interface in org.apache.sling.graphql.api.pagination
  The `Edge` interface provides support for implementing the Edge Types, according to the specification from https://relay.dev/graphql/connections.htm#sec-Edge-Types.
entrySet() - Method in class org.apache.sling.graphql.helpers.lazyloading.LazyLoadingMap
  Calls computeAll - should be avoided if possible
equals(Object) - Method in class org.apache.sling.graphql.api.pagination.Cursor
equals(Object) - Method in class org.apache.sling.graphql.helpers.lazyloading.LazyLoadingMap
  Calls computeAll - should be avoided if possible
execute(String, Map<String, Object>, Resource, String[]) - Method in interface org.apache.sling.graphql.api.engine.QueryExecutor
  Executes the passed `query`.

## F

fromEncodedString(String) - Static method in class org.apache.sling.graphql.api.pagination.Cursor
  Generates a new cursor based on an `encoded` value obtained via the same encoding mechanism `this` class uses.

## G

GenericConnection<T> - Class in org.apache.sling.graphql.helpers
  As per https://relay.dev/graphql/connections.htm a "connection" is a page of results for a paginated query.
GenericConnection.Builder<T> - Class in org.apache.sling.graphql.helpers
get() - Method in class org.apache.sling.graphql.helpers.lazyloading.LazyLoadingField
get(SlingDataFetcherEnvironment) - Method in interface org.apache.sling.graphql.api.SlingDataFetcher
get(Object) - Method in class org.apache.sling.graphql.helpers.lazyloading.LazyLoadingMap
get(String) - Method in interface org.apache.sling.graphql.api.SelectionSet
  Returns the fields identified by `qualifiedName` or `null`.
getAlias() - Method in interface org.apache.sling.graphql.api.SelectedField
getArgument(String) - Method in interface org.apache.sling.graphql.api.SlingDataFetcherEnvironment
getArgument(String, T) - Method in interface org.apache.sling.graphql.api.SlingDataFetcherEnvironment
getArguments() - Method in interface org.apache.sling.graphql.api.SlingDataFetcherEnvironment
getCurrentResource() - Method in interface org.apache.sling.graphql.api.SlingDataFetcherEnvironment
getCurrentResource() - Method in interface org.apache.sling.graphql.api.SlingTypeResolverEnvironment
getCursor() - Method in interface org.apache.sling.graphql.api.pagination.Edge
getEdges() - Method in interface org.apache.sling.graphql.api.pagination.Connection
getEdges() - Method in class org.apache.sling.graphql.helpers.GenericConnection
getEncoded() - Method in class org.apache.sling.graphql.api.pagination.Cursor
getEndCursor() - Method in interface org.apache.sling.graphql.api.pagination.PageInfo
getEndCursor() - Method in class org.apache.sling.graphql.helpers.GenericConnection
getErrors() - Method in interface org.apache.sling.graphql.api.engine.ValidationResult
  Returns a list of errors encountered while validating the query.
getFetcherOptions() - Method in interface org.apache.sling.graphql.api.SlingDataFetcherEnvironment
getFetcherSource() - Method in interface org.apache.sling.graphql.api.SlingDataFetcherEnvironment
getFields() - Method in interface org.apache.sling.graphql.api.SelectionSet
  Returns a list of the immediate fields in the selection.
getFirstSubSelectedFieldByName(String) - Method in interface org.apache.sling.graphql.api.SelectedField
getFullyQualifiedName() - Method in interface org.apache.sling.graphql.api.SelectedField
getLevel() - Method in interface org.apache.sling.graphql.api.SelectedField
getName() - Method in interface org.apache.sling.graphql.api.SelectedField
getNode() - Method in interface org.apache.sling.graphql.api.pagination.Edge
getObject() - Method in interface org.apache.sling.graphql.api.SlingTypeResolverEnvironment
getObjectType(String) - Method in interface org.apache.sling.graphql.api.SlingTypeResolverEnvironment
getObjectTypeNames() - Method in interface org.apache.sling.graphql.api.SelectedField
  The Object Type Name is taken from the Normalized Field from GraphQL Java and denotes any inlined fragment type that field can be part of
getPageInfo() - Method in interface org.apache.sling.graphql.api.pagination.Connection
getPageInfo() - Method in class org.apache.sling.graphql.helpers.GenericConnection
getParentObject() - Method in interface org.apache.sling.graphql.api.SlingDataFetcherEnvironment
getQualifiedName() - Method in interface org.apache.sling.graphql.api.SelectedField
getQuery(String, String, String) - Method in interface org.apache.sling.graphql.api.cache.GraphQLCacheProvider
  Attempts to retrieve a previously persisted query from the cache.
getRawValue() - Method in class org.apache.sling.graphql.api.pagination.Cursor
getResolverOptions() - Method in interface org.apache.sling.graphql.api.SlingTypeResolverEnvironment
getResolverSource() - Method in interface org.apache.sling.graphql.api.SlingTypeResolverEnvironment
getResultKey() - Method in interface org.apache.sling.graphql.api.SelectedField
  The result key is either the field query alias OR the field name in that preference order
getSchema(Resource, String[]) - Method in interface org.apache.sling.graphql.api.SchemaProvider
  Get a GraphQL Schema definition for the given resource and optional selectors
getSelectionSet() - Method in interface org.apache.sling.graphql.api.SlingDataFetcherEnvironment
getStartCursor() - Method in interface org.apache.sling.graphql.api.pagination.PageInfo
getStartCursor() - Method in class org.apache.sling.graphql.helpers.GenericConnection
getStats() - Method in class org.apache.sling.graphql.helpers.lazyloading.LazyLoadingMap
  Return statistics on our suppliers, for metrics etc.
getSubSelectedField(String) - Method in interface org.apache.sling.graphql.api.SelectedField
  Deprecated.
  Please use getSubSelectedFieldByName() or getSubSelectedFieldByFQN() instead
getSubSelectedFieldByFQN(String) - Method in interface org.apache.sling.graphql.api.SelectedField
getSubSelectedFieldByName(String) - Method in interface org.apache.sling.graphql.api.SelectedField
getSubSelectedFields() - Method in interface org.apache.sling.graphql.api.SelectedField
getSuppliersCallCount() - Method in class org.apache.sling.graphql.helpers.lazyloading.LazyLoadingMap.Stats
getType(SlingTypeResolverEnvironment) - Method in interface org.apache.sling.graphql.api.SlingTypeResolver
getUnusedSuppliersCount() - Method in class org.apache.sling.graphql.helpers.lazyloading.LazyLoadingMap.Stats
GraphQLCacheProvider - Interface in org.apache.sling.graphql.api.cache
  A `GraphQLCacheProvider` is responsible for caching GraphQL queries, in order to provide support for persisted queries for the `GraphQLServlet`.

## H

hasDuplicateFieldByName(String) - Method in interface org.apache.sling.graphql.api.SelectedField
  Checks if there are more than one field with the same name
hashCode() - Method in class org.apache.sling.graphql.api.pagination.Cursor
hashCode() - Method in class org.apache.sling.graphql.helpers.lazyloading.LazyLoadingMap
hasSubSelectedFields(String...) - Method in interface org.apache.sling.graphql.api.SelectedField
  Deprecated.
  Use hasDuplicateFieldByName(), hasSubSelectedFieldsByName() or hasSubSelectedFieldsByFQN
hasSubSelectedFieldsByFQN(String...) - Method in interface org.apache.sling.graphql.api.SelectedField
hasSubSelectedFieldsByName(String...) - Method in interface org.apache.sling.graphql.api.SelectedField

## I

isConditional() - Method in interface org.apache.sling.graphql.api.SelectedField
isEmpty() - Method in class org.apache.sling.graphql.helpers.lazyloading.LazyLoadingMap
isHasNextPage() - Method in interface org.apache.sling.graphql.api.pagination.PageInfo
isHasNextPage() - Method in class org.apache.sling.graphql.helpers.GenericConnection
isHasPreviousPage() - Method in interface org.apache.sling.graphql.api.pagination.PageInfo
isHasPreviousPage() - Method in class org.apache.sling.graphql.helpers.GenericConnection
isInline() - Method in interface org.apache.sling.graphql.api.SelectedField
  Deprecated.
  There are no more inlined fragments anymore so this is always false
isValid() - Method in interface org.apache.sling.graphql.api.engine.ValidationResult
  Provides a simple way check if a query is valid or not.

## K

keySet() - Method in class org.apache.sling.graphql.helpers.lazyloading.LazyLoadingMap

## L

LazyLoadingField<T> - Class in org.apache.sling.graphql.helpers.lazyloading
  Helper for a single lazy-loading value
LazyLoadingField(Supplier<T>) - Constructor for class org.apache.sling.graphql.helpers.lazyloading.LazyLoadingField
LazyLoadingMap<K,T> - Class in org.apache.sling.graphql.helpers.lazyloading
  A `HashMap` that optionally uses Suppliers to provide its values.
LazyLoadingMap() - Constructor for class org.apache.sling.graphql.helpers.lazyloading.LazyLoadingMap
LazyLoadingMap.Stats - Class in org.apache.sling.graphql.helpers.lazyloading
  Statistics on Supplier usage

## M

MAX_LIMIT - Static variable in class org.apache.sling.graphql.helpers.GenericConnection
  We might make this configurable but for now let's stay on the safe side

## N

NAME_SERVICE_PROPERTY - Static variable in interface org.apache.sling.graphql.api.SlingDataFetcher
  Defines the service registration property with which all `SlingDataFetcher` services have to be registered.
NAME_SERVICE_PROPERTY - Static variable in interface org.apache.sling.graphql.api.SlingScalarConverter
NAME_SERVICE_PROPERTY - Static variable in interface org.apache.sling.graphql.api.SlingTypeResolver
  Defines the service registration property with which all `SlingTypeResolver` services have to be registered.

## O

org.apache.sling.graphql.api - package org.apache.sling.graphql.api
  This package contains APIs which are independent of a specific implementation of the underlying graphQL engine.
org.apache.sling.graphql.api.cache - package org.apache.sling.graphql.api.cache
org.apache.sling.graphql.api.engine - package org.apache.sling.graphql.api.engine
org.apache.sling.graphql.api.pagination - package org.apache.sling.graphql.api.pagination
  This package contains APIs which are independent of a specific implementation of the underlying graphQL engine.
org.apache.sling.graphql.helpers - package org.apache.sling.graphql.helpers
  This package contains APIs which are independent of a specific implementation of the underlying graphQL engine.
org.apache.sling.graphql.helpers.lazyloading - package org.apache.sling.graphql.helpers.lazyloading
  This package contains helpers which are independent of a specific implementation of the underlying graphQL engine.

## P

PageInfo - Interface in org.apache.sling.graphql.api.pagination
  The `PageInfo` interface provides support for implementing the identically named type from https://relay.dev/graphql/connections.htm#sec-Connection-Types.Fields.PageInfo.
parseValue(X) - Method in interface org.apache.sling.graphql.api.SlingScalarConverter
  Parse an external value (a query argument for example) into its internal representation
put(K, Supplier<T>) - Method in class org.apache.sling.graphql.helpers.lazyloading.LazyLoadingMap
  Adds a Supplier that provides a lazy loaded value.

## Q

QueryExecutor - Interface in org.apache.sling.graphql.api.engine
  A `QueryExecutor` service allows consumers to validate and execute GraphQL queries directly.

## R

remove(Object) - Method in class org.apache.sling.graphql.helpers.lazyloading.LazyLoadingMap
  Unless `LazyLoadingMap.computeValueOnRemove(boolean)` is set to true, this returns null to avoid calling a supplier "for nothing".

## S

ScalarConversionException - Exception in org.apache.sling.graphql.api
  Exception thrown by Scalar converters
ScalarConversionException(String) - Constructor for exception org.apache.sling.graphql.api.ScalarConversionException
ScalarConversionException(String, Throwable) - Constructor for exception org.apache.sling.graphql.api.ScalarConversionException
SchemaProvider - Interface in org.apache.sling.graphql.api
SelectedField - Interface in org.apache.sling.graphql.api
  Interface to wrap information from GraphQL SelectedField.
SelectionSet - Interface in org.apache.sling.graphql.api
  Interface to wrap information from GraphQL DataFetchingFieldSelectionSet.
serialize(T) - Method in interface org.apache.sling.graphql.api.SlingScalarConverter
  Serialize an internal value (provided by a `SlingDataFetcher` into its external representation.
size() - Method in class org.apache.sling.graphql.helpers.lazyloading.LazyLoadingMap
SlingDataFetcher<T> - Interface in org.apache.sling.graphql.api
  Retrieves data for a given GraphQL field.
SlingDataFetcherEnvironment - Interface in org.apache.sling.graphql.api
  Provides contextual information to the {#link SlingDataFetcher}
SlingGraphQLException - Exception in org.apache.sling.graphql.api
  The `SlingGraphQLException` defines the class of errors that can be thrown by the `org.apache.sling.graphql.core` bundle.
SlingGraphQLException(String) - Constructor for exception org.apache.sling.graphql.api.SlingGraphQLException
  Creates a `SlingGraphQLException` without a known cause.
SlingGraphQLException(String, Throwable) - Constructor for exception org.apache.sling.graphql.api.SlingGraphQLException
  Creates a `SlingGraphQLException` with a known cause.
SlingScalarConverter<T,X> - Interface in org.apache.sling.graphql.api
  A service that parses and serializes a custom GraphQL Scalar by converting between an eXternal type X an an inTernal one T.
SlingTypeResolver<T> - Interface in org.apache.sling.graphql.api
  Resolves the GraphQL object type of a given result item.
SlingTypeResolverEnvironment<T> - Interface in org.apache.sling.graphql.api
  Provides contextual information to the `SlingTypeResolver`
Stats() - Constructor for class org.apache.sling.graphql.helpers.lazyloading.LazyLoadingMap.Stats

## T

toString() - Method in class org.apache.sling.graphql.api.pagination.Cursor

## V

validate(String, Map<String, Object>, Resource, String[]) - Method in interface org.apache.sling.graphql.api.engine.QueryExecutor
  Validates the passed `query` and `variables`, by checking if the query obeys the known schemas.
ValidationResult - Interface in org.apache.sling.graphql.api.engine
  The `ValidationResult` interface defines the result returned by `QueryExecutor.validate(String, Map, Resource, String[])` and helps additional services to pre-validate a GraphQL query without executing it.
values() - Method in class org.apache.sling.graphql.helpers.lazyloading.LazyLoadingMap
  Calls computeAll - should be avoided if possible

## W

withLimit(int) - Method in class org.apache.sling.graphql.helpers.GenericConnection.Builder
  Set a limit on the number of items returned by the connection.
withNextPage(boolean) - Method in class org.apache.sling.graphql.helpers.GenericConnection.Builder
  Force the "has next page" value, in case the supplied data doesn't expose that but a new query would find it
withPreviousPage(boolean) - Method in class org.apache.sling.graphql.helpers.GenericConnection.Builder
  Force the "has previous page" value, in case the supplied data doesn't expose that but a new query would find it.
withStartAfter(Cursor) - Method in class org.apache.sling.graphql.helpers.GenericConnection.Builder
  If set, the connection will skip to the first item after the `c` `Cursor`.

B C D E F G H I K L M N O P Q R S T V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form