graphql.schema.visibility

Interface GraphqlFieldVisibility

All Known Implementing Classes:

BlockedFields, DefaultGraphqlFieldVisibility, NoIntrospectionGraphqlFieldVisibility

@PublicApi
public interface GraphqlFieldVisibility

This allows you to control the visibility of graphql fields. By default graphql-java makes every defined field visible but you can implement an instance of this interface and reduce specific field visibility.

Method Summary

Modifier and Type	Method and Description
GraphQLFieldDefinition	getFieldDefinition(GraphQLFieldsContainer fieldsContainer, java.lang.String fieldName) Called to get a named field from an object type or interface
default GraphQLInputObjectField	getFieldDefinition(GraphQLInputFieldsContainer fieldsContainer, java.lang.String fieldName) Called to get a named field from an input object type
java.util.List<GraphQLFieldDefinition>	getFieldDefinitions(GraphQLFieldsContainer fieldsContainer) Called to get the list of fields from an object type or interface
default java.util.List<GraphQLInputObjectField>	getFieldDefinitions(GraphQLInputFieldsContainer fieldsContainer) Called to get the list of fields from an input object type

Method Detail

getFieldDefinitions

java.util.List<GraphQLFieldDefinition> getFieldDefinitions(GraphQLFieldsContainer fieldsContainer)

Called to get the list of fields from an object type or interface

Parameters:

fieldsContainer - the type in play

Returns:

a non null list of GraphQLFieldDefinitions

getFieldDefinition

GraphQLFieldDefinition getFieldDefinition(GraphQLFieldsContainer fieldsContainer,
                                          java.lang.String fieldName)

Called to get a named field from an object type or interface

Parameters:

fieldsContainer - the type in play

fieldName - the name of the desired field

Returns:

a GraphQLFieldDefinition or null if its not visible

getFieldDefinitions

default java.util.List<GraphQLInputObjectField> getFieldDefinitions(GraphQLInputFieldsContainer fieldsContainer)

Called to get the list of fields from an input object type

Parameters:

fieldsContainer - the type in play

Returns:

a non null list of GraphQLInputObjectFields

getFieldDefinition

default GraphQLInputObjectField getFieldDefinition(GraphQLInputFieldsContainer fieldsContainer,
                                                   java.lang.String fieldName)

Called to get a named field from an input object type

Parameters:

fieldsContainer - the type in play

fieldName - the name of the desired field

Returns:

a GraphQLInputObjectField or null if its not visible