graphql.execution

Class MergedFields

java.lang.Object

graphql.execution.MergedFields

@PublicApi
public class MergedFields
extends java.lang.Object

This represent all Fields in query which overlap and are merged into one. This means they all represent the same field actually when the query is executed. Example query with more than one Field merged together:

 

      query Foo {
          bar
          ...BarFragment
      }

      fragment BarFragment on Query {
          bar
      }
 
 

Another example:

 
     {
          me{fistName}
          me{lastName}
     }
 
 

Here the me field is merged together including the sub selections. A third example with different directives:

 
     {
          foo @someDirective
          foo @anotherDirective
     }
 
 

These examples make clear that you need to consider all merged fields together to have the full picture. The actual logic when fields can successfully merged together is implemented in {#graphql.validation.rules.OverlappingFieldsCanBeMerged}

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MergedFields.Builder

Constructor Summary

Constructors

Constructor and Description
MergedFields(java.util.List<Field> fields)

Method Summary

Modifier and Type	Method and Description
java.util.List<Argument>	getArguments() All merged fields share the same arguments.
java.util.List<Field>	getFields() All merged fields
java.lang.String	getName() All merged fields have the same name.
Field	getSingleField() The first of the merged fields.
static MergedFields.Builder	newMergedFields()
static MergedFields.Builder	newMergedFields(Field field)
static MergedFields.Builder	newMergedFields(java.util.List<Field> fields)
MergedFields	transform(java.util.function.Consumer<MergedFields.Builder> builderConsumer)

Methods inherited from class java.lang.Object

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

Constructor Detail

MergedFields

public MergedFields(java.util.List<Field> fields)

Method Detail

getName

public java.lang.String getName()

All merged fields have the same name. WARNING: This is not always the key in the execution result, because of possible aliases.

Returns:

the name of of the merged fields.

getSingleField

public Field getSingleField()

The first of the merged fields. Because all fields are almost identically often only one of the merged fields are used.

Returns:

the fist of the merged Fields

getArguments

public java.util.List<Argument> getArguments()

All merged fields share the same arguments.

Returns:

getFields

public java.util.List<Field> getFields()

All merged fields

Returns:

all merged fields

newMergedFields

public static MergedFields.Builder newMergedFields()

newMergedFields

public static MergedFields.Builder newMergedFields(Field field)

newMergedFields

public static MergedFields.Builder newMergedFields(java.util.List<Field> fields)

transform

public MergedFields transform(java.util.function.Consumer<MergedFields.Builder> builderConsumer)