Package graphql.schema.visibility

Class DefaultGraphqlFieldVisibility

java.lang.Object

graphql.schema.visibility.DefaultGraphqlFieldVisibility

All Implemented Interfaces:

GraphqlFieldVisibility

@PublicApi
public class DefaultGraphqlFieldVisibility
extends Object
implements GraphqlFieldVisibility

The default field visibility of graphql-java is that everything is visible

Field Summary

Fields

Modifier and Type	Field	Description
static final DefaultGraphqlFieldVisibility	DEFAULT_FIELD_VISIBILITY

Constructor Summary

Constructors

Constructor	Description
DefaultGraphqlFieldVisibility()

Method Summary

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

DEFAULT_FIELD_VISIBILITY

public static final DefaultGraphqlFieldVisibility DEFAULT_FIELD_VISIBILITY

Constructor Details

DefaultGraphqlFieldVisibility

public DefaultGraphqlFieldVisibility()

Method Details

getFieldDefinitions

public List<GraphQLFieldDefinition> getFieldDefinitions(GraphQLFieldsContainer fieldsContainer)

Description copied from interface: GraphqlFieldVisibility

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

Specified by:

getFieldDefinitions in interface GraphqlFieldVisibility

Parameters:

fieldsContainer - the type in play

Returns:

a non null list of GraphQLFieldDefinitions

getFieldDefinition

public GraphQLFieldDefinition getFieldDefinition(GraphQLFieldsContainer fieldsContainer,
 String fieldName)

Description copied from interface: GraphqlFieldVisibility

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

Specified by:

getFieldDefinition in interface GraphqlFieldVisibility

Parameters:

fieldsContainer - the type in play

fieldName - the name of the desired field

Returns:

a GraphQLFieldDefinition or null if it's not visible

getFieldDefinitions

public List<GraphQLInputObjectField> getFieldDefinitions(GraphQLInputFieldsContainer fieldsContainer)

Description copied from interface: GraphqlFieldVisibility

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

Specified by:

getFieldDefinitions in interface GraphqlFieldVisibility

Parameters:

fieldsContainer - the type in play

Returns:

a non null list of GraphQLInputObjectFields

getFieldDefinition

public GraphQLInputObjectField getFieldDefinition(GraphQLInputFieldsContainer fieldsContainer,
 String fieldName)

Description copied from interface: GraphqlFieldVisibility

Called to get a named field from an input object type

Specified by:

getFieldDefinition in interface GraphqlFieldVisibility

Parameters:

fieldsContainer - the type in play

fieldName - the name of the desired field

Returns:

a GraphQLInputObjectField or null if it's not visible