Package no.sikt.graphitron.definitions.interfaces

Interface FieldSpecification

All Known Subinterfaces:
GenerationField
All Known Implementing Classes:
AbstractField, ArgumentField, EnumField, GenerationSourceField, InputField, ObjectField, OperationField, OrderByEnumField, VirtualSourceField
public interface FieldSpecification
Specifies that this Java object represents a GraphQL field.

  • Method Details

    • isID

      boolean isID()
      Returns:
      Is this field an ID?

    • hasNodeID

      boolean hasNodeID()
      Returns:
      Does this field have the @nodeId directive?

    • getNodeIdTypeName

      String getNodeIdTypeName()
      Returns:
      The type name configured in the @nodeId directive

    • getName

      String getName()
      Returns:
      The name of the object as specified in the schema.

    • getTypeName

      String getTypeName()
      Returns:
      The name of the field's underlying data type.

    • getTypeClass

      TypeName getTypeClass()
      Returns:
      TypeName for this field's type.

    • getContainerTypeName

      String getContainerTypeName()
      Returns:
      The name of the field's container schema type.

    • isIterableWrapped

      boolean isIterableWrapped()
      Returns:
      Is this field wrapped in a list?

    • getMappingFromSchemaName

      MethodMapping getMappingFromSchemaName()
      Returns:
      Schema-side method name mappings based on the GraphQL equivalent of this field.

    • isNullable

      boolean isNullable()
      Returns:
      Is this field optional/nullable?

    • isNonNullable

      boolean isNonNullable()
      Returns:
      Is this field required/non-nullable?

    • getUpperCaseName

      String getUpperCaseName()
      Returns:
      The database equivalent name of this field. Defaults to field name.

    • hasSetFieldOverride

      boolean hasSetFieldOverride()
      Returns:
      Does this field use the GenerationDirective.FIELD directive?

    • getMappingFromFieldOverride

      MethodMapping getMappingFromFieldOverride()
      Returns:
      DB-side method name mappings based on the database equivalent of this field.

    • isRootField

      boolean isRootField()
      Returns:
      Is this object field a Query or Mutation root field?