Package graphql.schema

Class GraphQLList

java.lang.Object

graphql.schema.GraphQLList

All Implemented Interfaces:

GraphQLInputSchemaElement, GraphQLInputType, GraphQLModifiedType, GraphQLNullableType, GraphQLOutputType, GraphQLSchemaElement, GraphQLType

@PublicApi
@NullMarked
public class GraphQLList
extends Object
implements GraphQLType, GraphQLInputType, GraphQLOutputType, GraphQLModifiedType, GraphQLNullableType

A modified type that indicates there is a list of the underlying wrapped type, eg a list of strings or a list of booleans.

See https://graphql.org/learn/schema/#lists-and-non-null for more details on the concept

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CHILD_WRAPPED_TYPE

Constructor Summary

Constructors

Constructor	Description
GraphQLList(GraphQLType wrappedType)

Method Summary

Modifier and Type	Method	Description
TraversalControl	accept(TraverserContext<GraphQLSchemaElement> context, GraphQLTypeVisitor visitor)
GraphQLSchemaElement	copy()	Each GraphQLSchemaElement should make a copy of itself when this is called.
final boolean	equals(Object o)	No GraphQLSchemaElement implements `equals` because we need object identity to treat a GraphQLSchema as an abstract graph.
List<GraphQLSchemaElement>	getChildren()
SchemaElementChildrenContainer	getChildrenWithTypeReferences()
GraphQLType	getOriginalWrappedType()
GraphQLType	getWrappedType()
final int	hashCode()	No GraphQLSchemaElement implements `equals/hashCode` because we need object identity to treat a GraphQLSchema as an abstract graph.
boolean	isEqualTo(@Nullable Object o)
static GraphQLList	list(GraphQLType wrappedType)	A factory method for creating list types so that when used with static imports allows more readable code such as .type(list(GraphQLString))
String	toString()
GraphQLSchemaElement	withNewChildren(SchemaElementChildrenContainer newChildren)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

CHILD_WRAPPED_TYPE

public static final String CHILD_WRAPPED_TYPE

See Also:

• Constant Field Values

Constructor Details

GraphQLList

public GraphQLList(GraphQLType wrappedType)

Method Details

list

public static GraphQLList list(GraphQLType wrappedType)

A factory method for creating list types so that when used with static imports allows more readable code such as .type(list(GraphQLString))

Parameters:

wrappedType - the type to wrap as being a list

Returns:

a GraphQLList of that wrapped type

getWrappedType

public GraphQLType getWrappedType()

Specified by:

getWrappedType in interface GraphQLModifiedType

getOriginalWrappedType

public GraphQLType getOriginalWrappedType()

isEqualTo

public boolean isEqualTo(@Nullable Object o)

accept

public TraversalControl accept(TraverserContext<GraphQLSchemaElement> context,
 GraphQLTypeVisitor visitor)

Specified by:

accept in interface GraphQLSchemaElement

getChildren

public List<GraphQLSchemaElement> getChildren()

Specified by:

getChildren in interface GraphQLSchemaElement

getChildrenWithTypeReferences

public SchemaElementChildrenContainer getChildrenWithTypeReferences()

Specified by:

getChildrenWithTypeReferences in interface GraphQLSchemaElement

withNewChildren

public GraphQLSchemaElement withNewChildren(SchemaElementChildrenContainer newChildren)

Specified by:

withNewChildren in interface GraphQLSchemaElement

copy

public GraphQLSchemaElement copy()

Description copied from interface: GraphQLSchemaElement

Each GraphQLSchemaElement should make a copy of itself when this is called. The copy should be included its current contents as they currently exist into a new object.

Specified by:

copy in interface GraphQLSchemaElement

Returns:

a copy of this element

toString

public String toString()

Overrides:

toString in class Object

equals

public final boolean equals(Object o)

No GraphQLSchemaElement implements `equals` because we need object identity to treat a GraphQLSchema as an abstract graph.

Specified by:

equals in interface GraphQLSchemaElement

Overrides:

equals in class Object

Parameters:

o - the reference object with which to compare.

Returns:

true if this object is the same as the obj argument; false otherwise.

hashCode

public final int hashCode()

No GraphQLSchemaElement implements `equals/hashCode` because we need object identity to treat a GraphQLSchema as an abstract graph.

Specified by:

hashCode in interface GraphQLSchemaElement

Overrides:

hashCode in class Object

Returns:

a hash code value for this object.