@PublicApi public class GraphQLFieldDefinition extends Object implements GraphQLDirectiveContainer
DataFetcher
used to get data values for that field.
Fields can be thought of as functions in graphql, they have a name, take defined arguments and return a value.
Fields can also be deprecated, which indicates the consumers that a field wont be supported in the future.
See http://graphql.org/learn/queries/#fields for more details on the concept.Modifier and Type | Class and Description |
---|---|
static class |
GraphQLFieldDefinition.Builder |
Constructor and Description |
---|
GraphQLFieldDefinition(String name,
String description,
GraphQLOutputType type,
DataFetcher<?> dataFetcher,
List<GraphQLArgument> arguments,
String deprecationReason)
Deprecated.
use the
newFieldDefinition() builder pattern instead, as this constructor will be made private in a future version. |
GraphQLFieldDefinition(String name,
String description,
GraphQLOutputType type,
DataFetcherFactory dataFetcherFactory,
List<GraphQLArgument> arguments,
String deprecationReason,
List<GraphQLDirective> directives,
FieldDefinition definition)
Deprecated.
use the
newFieldDefinition() builder pattern instead, as this constructor will be made private in a future version. |
Modifier and Type | Method and Description |
---|---|
TraversalControl |
accept(TraverserContext<GraphQLType> context,
GraphQLTypeVisitor visitor)
Double-dispatch entry point.
|
GraphQLArgument |
getArgument(String name) |
List<GraphQLArgument> |
getArguments() |
List<GraphQLType> |
getChildren() |
FieldDefinition |
getDefinition() |
String |
getDeprecationReason() |
String |
getDescription() |
List<GraphQLDirective> |
getDirectives() |
String |
getName() |
GraphQLOutputType |
getType() |
boolean |
isDeprecated() |
static GraphQLFieldDefinition.Builder |
newFieldDefinition() |
static GraphQLFieldDefinition.Builder |
newFieldDefinition(GraphQLFieldDefinition existing) |
String |
toString() |
GraphQLFieldDefinition |
transform(Consumer<GraphQLFieldDefinition.Builder> builderConsumer)
This helps you transform the current GraphQLFieldDefinition into another one by starting a builder with all
the current values and allows you to transform it how you want.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
getDirective, getDirectivesByName
@Deprecated public GraphQLFieldDefinition(String name, String description, GraphQLOutputType type, DataFetcher<?> dataFetcher, List<GraphQLArgument> arguments, String deprecationReason)
newFieldDefinition()
builder pattern instead, as this constructor will be made private in a future version.name
- the namedescription
- the descriptiontype
- the field typedataFetcher
- the field data fetcherarguments
- the field argumentsdeprecationReason
- the deprecation reason@Deprecated public GraphQLFieldDefinition(String name, String description, GraphQLOutputType type, DataFetcherFactory dataFetcherFactory, List<GraphQLArgument> arguments, String deprecationReason, List<GraphQLDirective> directives, FieldDefinition definition)
newFieldDefinition()
builder pattern instead, as this constructor will be made private in a future version.name
- the namedescription
- the descriptiontype
- the field typedataFetcherFactory
- the field data fetcher factoryarguments
- the field argumentsdeprecationReason
- the deprecation reasondirectives
- the directives on this type elementdefinition
- the AST definitionpublic String getName()
getName
in interface GraphQLType
[_A-Za-z][_0-9A-Za-z]*
public GraphQLOutputType getType()
public GraphQLArgument getArgument(String name)
public List<GraphQLDirective> getDirectives()
getDirectives
in interface GraphQLDirectiveContainer
public List<GraphQLArgument> getArguments()
public String getDescription()
public FieldDefinition getDefinition()
public String getDeprecationReason()
public boolean isDeprecated()
public GraphQLFieldDefinition transform(Consumer<GraphQLFieldDefinition.Builder> builderConsumer)
builderConsumer
- the consumer code that will be given a builder to transformpublic TraversalControl accept(TraverserContext<GraphQLType> context, GraphQLTypeVisitor visitor)
GraphQLType
Node
, see accept(...) for more details about the pattern.accept
in interface GraphQLType
context
- TraverserContext bound to this graphQL type objectvisitor
- Visitor instance that performs actual processing on the types(s)public List<GraphQLType> getChildren()
getChildren
in interface GraphQLType
public static GraphQLFieldDefinition.Builder newFieldDefinition(GraphQLFieldDefinition existing)
public static GraphQLFieldDefinition.Builder newFieldDefinition()
Copyright © 2019. All rights reserved.