graphql.schema

Interface GraphQLNamedSchemaElement

All Superinterfaces:

GraphQLSchemaElement

All Known Subinterfaces:

GraphQLCompositeType, GraphQLDirectiveContainer, GraphQLFieldsContainer, GraphQLInputFieldsContainer, GraphQLInputValueDefinition, GraphQLNamedInputType, GraphQLNamedOutputType, GraphQLNamedType, GraphQLUnmodifiedType

All Known Implementing Classes:

GraphQLArgument, GraphQLDirective, GraphQLEnumType, GraphQLEnumValueDefinition, GraphQLFieldDefinition, GraphQLInputObjectField, GraphQLInputObjectType, GraphQLInterfaceType, GraphQLObjectType, GraphQLScalarType, GraphQLTypeReference, GraphQLUnionType

@PublicApi
public interface GraphQLNamedSchemaElement
extends GraphQLSchemaElement

A Schema element which has a name and also a description and AST Node which it is based on.

Method Summary

Modifier and Type	Method and Description
Node	getDefinition() The AST Node this schema element is based on.
java.lang.String	getDescription()
java.lang.String	getName()

Methods inherited from interface graphql.schema.GraphQLSchemaElement

accept, getChildren, getChildrenWithTypeReferences, withNewChildren

Method Detail

getName

java.lang.String getName()

getDescription

java.lang.String getDescription()

getDefinition

Node getDefinition()

The AST Node this schema element is based on. Is null if the GraphQLSchema is not based on a SDL document. Some elements also have additional extension Nodes. See for example GraphQLObjectType.getExtensionDefinitions()

Returns:

Node which this element is based on. Can be null.