Package com.graphql_java_generator.plugin.language

Interface Directive

All Known Implementing Classes:
DirectiveImpl
public interface Directive
Contains getter for the attributes of a GraphQL directive definition.
Author:
etienne-sf

  • Method Summary

    Modifier and Type
    Method
    Description
    default Field
    getArgument(String argumentName)
    Returns the argument that matches the given argument name
    List<Field>
    getArguments()
    A directive may have arguments.
    List<String>
    getComments()
    Returns the comments that have been found before this object, in the provided GraphQL schema
    Description
    getDescription()
    Returns the description for this object, in the provided GraphQL schema
    List<DirectiveLocation>
    getDirectiveLocations()
    Returns the list of location that this directive may have
    String
    getName()
    The name of the directive
    boolean
    isStandard()
    Returns true if this directive is a standard GraphQL directive, or if it has been defined in the GraphQL schema

  • Method Details

    • getName

      String getName()
      The name of the directive

    • getArguments

      List<Field> getArguments()
      A directive may have arguments. An argument is actually a field.

    • getArgument

      default Field getArgument(String argumentName) throws NoSuchFieldException
      Returns the argument that matches the given argument name
      Parameters:
      argumentName -
      Returns:
      Throws:
      NoSuchFieldException - If the directive has no such argument
      NullPointerException - If argumentName is null

    • getComments

      List<String> getComments()
      Returns the comments that have been found before this object, in the provided GraphQL schema

    • getDescription

      Description getDescription()
      Returns the description for this object, in the provided GraphQL schema

    • getDirectiveLocations

      List<DirectiveLocation> getDirectiveLocations()
      Returns the list of location that this directive may have

    • isStandard

      boolean isStandard()
      Returns true if this directive is a standard GraphQL directive, or if it has been defined in the GraphQL schema