net.morimekta.providence.graphql.gql

Enum GQLDirective

java.lang.Object

java.lang.Enum<GQLDirective>

net.morimekta.providence.graphql.gql.GQLDirective

All Implemented Interfaces:

Serializable, Comparable<GQLDirective>

public enum GQLDirective
extends Enum<GQLDirective>

A directive represents some modification on a GQL field. It can for the most part be handled in-line, as the query and arguments are parsed, but may be (some time in the future) required to be kept along the field selection.

Enum Constant Summary

Enum Constants

Enum Constant and Description
include @include(if: $var) Include the field only if 'if' resolves to true.
skip @include(if: $var) Include the field only if 'if' resolves to false.

Method Summary

Modifier and Type	Method and Description
static GQLDirective	findByName(String name) Find directive by the name, not including the '@'.
static GQLDirective	valueOf(String name) Returns the enum constant of this type with the specified name.
static GQLDirective[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

include

public static final GQLDirective include

@include(if: $var) Include the field only if 'if' resolves to true.

skip

public static final GQLDirective skip

@include(if: $var) Include the field only if 'if' resolves to false.

Method Detail

values

public static GQLDirective[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (GQLDirective c : GQLDirective.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static GQLDirective valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

findByName

public static GQLDirective findByName(String name)

Find directive by the name, not including the '@'.

Parameters:

name - The directive name.

Returns:

The directive, or null if not found.