Package 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
All Methods Instance Methods Abstract Methods Modifier and Type Method Description @Nullable NodegetDefinition()The ASTNodethis schema element is based on.@Nullable java.lang.StringgetDescription()@NonNull java.lang.StringgetName()-
Methods inherited from interface graphql.schema.GraphQLSchemaElement
accept, copy, equals, getChildren, getChildrenWithTypeReferences, hashCode, withNewChildren
-
-
-
-
Method Detail
-
getName
@NonNull java.lang.String getName()
- Returns:
- the name of this element. This cant be null
-
getDescription
@Nullable java.lang.String getDescription()
- Returns:
- the description of this element. This can be null
-
getDefinition
@Nullable Node getDefinition()
The ASTNodethis 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 exampleGraphQLObjectType.getExtensionDefinitions()- Returns:
- Node which this element is based on. Can be null.
-
-