net.morimekta.providence.graphql.gql

Class GQLField

java.lang.Object

net.morimekta.providence.graphql.gql.GQLField

All Implemented Interfaces:

GQLSelection

@Immutable
public class GQLField
extends Object
implements GQLSelection

Representation of a field in the response JSON. This is called a 'field' as it references a field of data in the JSON response, unrelated to message fields. This may represent a message field or a method call, but not both. And may always have an alias. If the type of the field, or return type of the message is a message or collection of messages, it may have a selection set.

Constructor Summary

Constructors

Constructor and Description
GQLField(net.morimekta.providence.descriptor.PField field) Make a simple field selection based on a message field.
GQLField(net.morimekta.providence.descriptor.PField field, List<GQLSelection> selectionSet) Make a simple field selection based on a message field.
GQLField(net.morimekta.providence.descriptor.PField field, String alias, net.morimekta.providence.PMessage<?> arguments, List<GQLSelection> selectionSet) Make a full field selection definition.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getAlias()
<M extends net.morimekta.providence.PMessage<M>> M	getArguments()
net.morimekta.providence.descriptor.PField	getField()
List<GQLSelection>	getSelectionSet()
int	hashCode()
boolean	representing(net.morimekta.providence.descriptor.PField inf) Check if the input field is represented with this field selection.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.morimekta.providence.graphql.gql.GQLSelection

getSelection, hasSelection, hasSelectionPath

Constructor Detail

GQLField

public GQLField(@Nonnull
                net.morimekta.providence.descriptor.PField field)

Make a simple field selection based on a message field.

Parameters:

field - The field to be represented.

GQLField

public GQLField(@Nonnull
                net.morimekta.providence.descriptor.PField field,
                @Nullable
                List<GQLSelection> selectionSet)

Make a simple field selection based on a message field.

Parameters:

field - The field to be represented.

selectionSet - SelectionSet for sub-field selection.

GQLField

public GQLField(@Nonnull
                net.morimekta.providence.descriptor.PField field,
                @Nullable
                String alias,
                @Nullable
                net.morimekta.providence.PMessage<?> arguments,
                @Nullable
                List<GQLSelection> selectionSet)

Make a full field selection definition.

Parameters:

field - The field to be represented.

alias - The alias to be used in the JSON output.

arguments - Arguments used for field mutators.

selectionSet - SelectionSet for sub-field selection.

Method Detail

representing

public boolean representing(net.morimekta.providence.descriptor.PField inf)

Check if the input field is represented with this field selection. It will match if it is the same field as this, or if it is the same field as what this field is overriding (from implementing interface).

E.g. if 'A' is an interface field, and 'B' and 'C' are the equivalent field in two different messages, and this selection is for 'B', then it is representing 'A', and 'B', but not 'C'. But if this is a selection for 'A', then all three will match.

Parameters:

inf - The field to check.

Returns:

If the field is represented by this selection.

getAlias

@Nullable
public String getAlias()

Returns:

The output field alias.

getField

@Nonnull
public net.morimekta.providence.descriptor.PField getField()

Returns:

The message field to be represented.

getArguments

@Nullable
public <M extends net.morimekta.providence.PMessage<M>> M getArguments()

Type Parameters:

M - The argument message type.

Returns:

The argument struct. If no arguments or params then null.

getSelectionSet

@Nullable
public List<GQLSelection> getSelectionSet()

Specified by:

getSelectionSet in interface GQLSelection

Returns:

The field's selection set, or null if none.

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object