Package net.morimekta.providence.graphql.gql

Enum GQLDirective

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<GQLDirective>
    public enum GQLDirective
extends java.lang.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 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

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static GQLDirective findByName​(java.lang.String name)
      Find directive by the name, not including the '@'.
      static GQLDirective valueOf​(java.lang.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​(java.lang.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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null

      • findByName

        public static GQLDirective findByName​(java.lang.String name)
        Find directive by the name, not including the '@'.
        Parameters:
        name - The directive name.
        Returns:
        The directive, or null if not found.