graphql.schema

Interface GraphQLNamedSchemaElement

All Superinterfaces:

GraphQLSchemaElement

All Known Subinterfaces:

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

All Known Implementing Classes:

GraphQLAppliedDirective, GraphQLAppliedDirectiveArgument, 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
@Nullable Node	getDefinition() The AST Node this schema element is based on.
@Nullable java.lang.String	getDescription()
@NotNull java.lang.String	getName()

Methods inherited from interface graphql.schema.GraphQLSchemaElement

accept, copy, equals, getChildren, getChildrenWithTypeReferences, hashCode, withNewChildren

Method Detail

getName

@NotNull
@NotNull java.lang.String getName()

Returns:

the name of this element. This cant be null

getDescription

@Nullable
@Nullable java.lang.String getDescription()

Returns:

the description of this element. This can be null

getDefinition

@Nullable
@Nullable 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.