GraphZen
  • Home
  • Blog
  • Documentation
  • API
  • Get Started
  • GraphZen.LanguageModel
  • DocumentSyntax
Show / Hide Table of Contents
  • GraphZen
    • DocumentValidator
    • GraphQLCanBeNullAttribute
    • GraphQLContext
    • GraphQLContextOptions
    • GraphQLContextOptions<TContext>
    • GraphQLContextOptionsBuilder
    • GraphQLContextOptionsBuilder<TContext>
    • GraphQLDeprecatedAttribute
    • GraphQLError
    • GraphQLException
    • GraphQLIgnoreAttribute
    • GraphQLListItemCanBeNullAttribute
    • GraphQLListItemNonNullAttribute
    • GraphQLNameAttribute
    • GraphQLNonNullAttribute
    • GraphQLObjectAttribute
    • GraphQLTypeAttribute
    • GraphQLUnionAttribute
    • GraphZenApplicationBuilderExtensions
    • GraphZenServiceCollectionExtensions
    • IDocumentValidator
    • IGraphQLDirective
    • PlaygroundApplicationBuilderExtensions
    • Program
  • GraphZen.CodeGen
    • CodeGenHelpers
    • CodeGenStringBuilderExtensions
    • CodeGenTasks
  • GraphZen.LanguageModel
    • ArgumentSyntax
    • ArgumentSyntaxExtensions
    • BooleanValueSyntax
    • BooleanValueSyntaxExtensions
    • Break
    • ContinueAction
    • DefinitionSyntax
    • DirectiveDefinitionSyntax
    • DirectiveDefinitionSyntaxExtensions
    • DirectiveLocation
    • DirectiveSyntax
    • DirectiveSyntaxExtensions
    • DocumentSyntax
    • DocumentSyntaxExtensions
    • EnumTypeDefinitionSyntax
    • EnumTypeDefinitionSyntaxExtensions
    • EnumTypeExtensionSyntax
    • EnumTypeExtensionSyntaxExtensions
    • EnumValueDefinitionSyntax
    • EnumValueDefinitionSyntaxExtensions
    • EnumValueSyntax
    • EnumValueSyntaxExtensions
    • ExecutableDefinitionSyntax
    • FieldDefinitionSyntax
    • FieldDefinitionSyntaxExtensions
    • FieldSyntax
    • FieldSyntaxExtensions
    • FloatValueSyntax
    • FloatValueSyntaxExtensions
    • FragmentDefinitionSyntax
    • FragmentDefinitionSyntaxExtensions
    • FragmentSpreadSyntax
    • FragmentSpreadSyntaxExtensions
    • GraphQLSyntaxVisitor
    • GraphQLSyntaxVisitor<TResult>
    • GraphQLSyntaxWalker
    • GraphQLSyntaxWalker<TResult>
    • IArgumentsNode
    • IDescribedSyntax
    • IDirectivesSyntax
    • IFieldsNode
    • IFragmentTypeConditionSyntax
    • INamedSyntax
    • InlineFragmentSyntax
    • InlineFragmentSyntaxExtensions
    • InputObjectTypeDefinitionSyntax
    • InputObjectTypeDefinitionSyntaxExtensions
    • InputObjectTypeExtensionSyntax
    • InputObjectTypeExtensionSyntaxExtensions
    • InputValueDefinitionSyntax
    • InputValueDefinitionSyntaxExtensions
    • InterfaceTypeDefinitionSyntax
    • InterfaceTypeDefinitionSyntaxExensions
    • InterfaceTypeDefinitionSyntaxExtensions
    • InterfaceTypeExtensionSyntax
    • InterfaceTypeExtensionSyntaxExtensions
    • IntValueSyntax
    • IntValueSyntaxExtensions
    • IParser
    • IPrinter
    • ISyntaxNodeLocation
    • ListTypeSyntax
    • ListTypeSyntaxExtensions
    • ListValueSyntax
    • ListValueSyntaxExtensions
    • NamedSyntaxExtensions
    • NamedTypeSyntax
    • NamedTypeSyntaxExtensions
    • NameSyntax
    • NameSyntaxExtensions
    • NonNullTypeSyntax
    • NonNullTypeSyntaxExtensions
    • NullableTypeSyntax
    • NullValueSyntax
    • NullValueSyntaxExtensions
    • ObjectFieldSyntax
    • ObjectFieldSyntaxExtensions
    • ObjectTypeDefinitionSyntax
    • ObjectTypeDefinitionSyntaxExtensions
    • ObjectTypeExtensionSyntax
    • ObjectTypeExtensionSyntaxExtensions
    • ObjectValueSyntax
    • ObjectValueSyntaxExtensions
    • OperationDefinitionSyntax
    • OperationDefinitionSyntaxExtensions
    • OperationType
    • OperationTypeDefinitionSyntax
    • OperationTypeDefinitionSyntaxExtensions
    • ParallelSyntaxWalker
    • PunctuatorSyntax
    • PunctuatorSyntaxExtensions
    • ScalarTypeDefinitionSyntax
    • ScalarTypeDefinitionSyntaxExtensions
    • ScalarTypeExtensionSyntax
    • ScalarTypeExtensionSyntaxExtensions
    • SchemaDefinitionSyntax
    • SchemaDefinitionSyntaxExtensions
    • SchemaExtensionSyntax
    • SchemaExtensionSyntaxExtensions
    • SelectionSetSyntax
    • SelectionSetSyntaxExtensions
    • SelectionSyntax
    • Skip
    • Source
    • SourceLocation
    • StringValueSyntax
    • StringValueSyntaxExtensions
    • SyntaxFactory
    • SyntaxKind
    • SyntaxLocation
    • SyntaxNode
    • SyntaxNodeExtensions
    • TypeDefinitionSyntax
    • TypeExtensionSyntax
    • TypeSyntax
    • TypeSystemDefinitionSyntax
    • TypeSystemExtensionSyntax
    • UnionTypeDefinitionSyntax
    • UnionTypeDefinitionSyntaxExtensions
    • UnionTypeExtensionSyntax
    • UnionTypeExtensionSyntaxExtensions
    • ValueSyntax
    • VariableDefinitionSyntax
    • VariableDefinitionSyntaxExtensions
    • VariableSyntax
    • VariableSyntaxExtensions
    • VisitAction
    • VistitorContext
  • GraphZen.LanguageModel.Validation
    • DocumentValidationContext
    • DocumentValidationRules
    • DocumentValidationRuleVisitor
    • ParallelValidationVisitor
    • ValidationContext
    • ValidationRule
    • ValidationRuleVisitor
  • GraphZen.LanguageModel.Validation.Rules
    • EnumTypesMustBeWellDefined
    • FieldArgsMustBeProperlyNamed
    • FieldArgumentsMustHaveInputTypes
    • InputObjectFieldsMustHaveInputTypes
    • InputObjectsMustHaveFields
    • InterfaceExtensionsShouldBeValid
    • InterfaceFieldsMustHaveOutputTypes
    • LoneSchemaDefinition
    • ObjectFieldsMustHaveOutputTypes
    • ObjectsCanOnlyImplementUniqueInterfaces
    • ObjectsMustAdhereToInterfaceTheyImplement
    • ObjectsMustHaveFields
    • SchemaMustHaveRootObjectTypes
    • UnionTypesMustBeValid
  • GraphZen.QueryEngine
    • ExecutionOptions
    • ExecutionResult
    • Executor
    • IExecutionContext
    • IExecutor
  • GraphZen.QueryEngine.Validation
    • IQueryValidator
    • QueryValidationContext
    • QueryValidationRules
    • QueryValidationRuleVisitor
    • QueryValidator
  • GraphZen.QueryEngine.Validation.Rules
    • ExecutableDefinitions
    • FieldsOnCorrectType
    • FragmentsOnCompositeTypes
    • InputDocumentNonConflictingVariableInference
    • KnownArgumentNames
    • KnownDirectives
    • KnownFragmentNames
    • KnownTypeNames
    • LoneAnonymousOperation
    • NoFragmentCycles
    • NoUndefinedVariables
    • NoUnusedFragments
    • NoUnusedVariables
    • OverlappingFieldsCanBeMerged
    • PossibleFragmentSpreads
    • ProvidedRequiredArguments
    • ScalarLeafs
    • SingleFieldSubscriptions
    • UniqueArgumentNames
    • UniqueDirectivesPerLocation
    • UniqueFragmentNames
    • UniqueInputFieldNames
    • UniqueOperationNames
    • UniqueVariableNames
    • ValuesOfCorrectType
    • VariablesAreInputTypes
    • VariablesInAllowedPosition
  • GraphZen.TypeSystem
    • AnnotatableMember
    • AnnotatableMemberDefinition
    • Argument
    • ArgumentDefinition
    • DefaultIDirectiveAnnotationSyntaxConverter
    • DeprecatedBuilderExtensions
    • Directive
    • DirectiveAnnotation
    • DirectiveBuilder<TDirective>
    • DirectiveDefinition
    • DirectiveDefinitionArgumentsAccessorExtensions
    • EnumType
    • EnumTypeBuilder<TEnum>
    • EnumTypeDefinition
    • EnumTypeDefinitionValuesAccessorExtensions
    • EnumTypeValuesAccessorExtensions
    • EnumTypeValuesByValueAccessorExtensions
    • EnumValue
    • EnumValueBuilder
    • EnumValueDefinition
    • Field
    • FieldArgumentsAccessorExtensions
    • FieldBuilder<TDeclaringType, TField, TContext>
    • FieldDefinition
    • FieldDefinitionArgumentsAccessorExtensions
    • FieldsDefinition
    • FieldsDefinitionFieldsAccessorExtensions
    • GraphQLTypeExtensions
    • GraphQLTypes
    • IAnnotableBuilder<TBuilder>
    • IArgumentsArgumentsAccessorExtensions
    • IArgumentsDefinitionBuilder<TBuilder>
    • IDirectiveBuilder<TDirective>
    • IEnumTypeBuilder<TEnumValue>
    • IEnumValueBuilder
    • IFieldBuilder<TDeclaringType, TField, TContext>
    • IFieldsDefinitionBuilder<TBuilder, TSource, TContext>
    • IInputObjectTypeBuilder<TInputObject>
    • IInterfaceTypeBuilder<TInterface, TContext>
    • InputField
    • InputFieldDefinition
    • InputObjectType
    • InputObjectTypeBuilder<TInputObject>
    • InputObjectTypeDefinition
    • InputObjectTypeDefinitionFieldsAccessorExtensions
    • InputObjectTypeFieldsAccessorExtensions
    • InputValue
    • InputValueBuilder
    • InputValueDefinition
    • InterfaceType
    • InterfaceTypeBuilder<TInterface, TContext>
    • InterfaceTypeDefinition
    • InterfaceTypeDefinitionFieldsAccessorExtensions
    • InterfaceTypeFieldsAccessorExtensions
    • Introspection
    • IObjectTypeBuilder<TObject, TContext>
    • IScalarTypeBuilder<TScalar, TValueNode>
    • ISchemaBuilder<TContext>
    • IsTypeOf<TObject, TContext>
    • ISyntaxConverter
    • IUnionTypeBuilder<TUnion, TContext>
    • LeafLiteralParser<TScalar, TValueNode>
    • LeafSerializer
    • LeafSerializer<TScalar>
    • LeafValueParser
    • LeafValueParser<TScalar>
    • ListType
    • Member
    • MemberDefinition
    • NamedType
    • NamedTypeDefinition
    • NonNullType
    • ObjectType
    • ObjectTypeBuilder<TObject, TContext>
    • ObjectTypeDefinition
    • ObjectTypeDefinitionFieldsAccessorExtensions
    • ObjectTypeFieldsAccessorExtensions
    • Resolver<TSource, TResult>
    • ScalarType
    • ScalarTypeBuilder<TScalar, TValueNode>
    • ScalarTypeDefinition
    • Schema
    • SchemaBuilder
    • SchemaBuilder<TContext>
    • SchemaBuilderExtensions
    • SchemaDefinition
    • SchemaDefinitionExtensions
    • SchemaExtensions
    • SchemaPrinter
    • SpecDirectives
    • SpecScalars
    • SyntaxConverter
    • SyntaxHelpers
    • TypeComparators
    • TypeIdentity
    • TypeKind
    • TypeKindHelpers
    • TypeReference
    • TypeResolver
    • TypeResolver<TSource, TContext>
    • UnionType
    • UnionTypeBuilder<TUnion, TContext>
    • UnionTypeDefinition
  • GraphZen.TypeSystem.Taxonomy
    • IAbstractType
    • IAbstractTypeDefinition
    • IAnnotatableDefinition
    • IArgument
    • IArgumentDefinition
    • IArguments
    • IArgumentsDefinition
    • IClrInfo
    • IClrType
    • ICompositeType
    • ICompositeTypeDefinition
    • IDeprecation
    • IDescription
    • IDirective
    • IDirectiveAnnotation
    • IDirectiveAnnotations
    • IDirectiveAnnotationsDefinition
    • IDirectiveDefinition
    • IDirectiveLocations
    • IDirectiveLocationsDefinition
    • IDirectives
    • IDirectivesDefinition
    • IEnumType
    • IEnumTypeDefinition
    • IEnumTypes
    • IEnumTypesDefinition
    • IEnumValue
    • IEnumValueDefinition
    • IEnumValues
    • IEnumValuesDefinition
    • IField
    • IFieldDefinition
    • IFields
    • IFieldsDefinition
    • IGraphQLType
    • IGraphQLTypeReference
    • IInputDefinition
    • IInputField
    • IInputFieldDefinition
    • IInputFields
    • IInputFieldsDefinition
    • IInputObjectType
    • IInputObjectTypeDefinition
    • IInputObjectTypes
    • IInputObjectTypesDefinition
    • IInputValue
    • IInputValueDefinition
    • IInterfaces
    • IInterfacesDefinition
    • IInterfaceType
    • IInterfaceTypeDefinition
    • IInterfaceTypes
    • IInterfaceTypesDefinition
    • ILeafType
    • ILeafTypeDefinition
    • IListType
    • ILiteralParser
    • ILiteralParserDefinition
    • IMember
    • IMemberDefinition
    • IMemberTypes
    • IMemberTypesDefinition
    • IMutableAbstractTypeDefinition
    • IMutableAnnotatableDefinition
    • IMutableArgumentDefinition
    • IMutableArgumentsDefinition
    • IMutableClrType
    • IMutableDefinition
    • IMutableDeprecation
    • IMutableDescription
    • IMutableDirectiveAnnotationsDefinition
    • IMutableDirectiveDefinition
    • IMutableDirectiveLocationsDefinition
    • IMutableDirectivesDefinition
    • IMutableEnumTypeDefinition
    • IMutableEnumTypesDefinition
    • IMutableEnumValueDefinition
    • IMutableEnumValuesDefinition
    • IMutableFieldDefinition
    • IMutableFieldsDefinition
    • IMutableInputFieldDefinition
    • IMutableInputFieldsDefinition
    • IMutableInputObjectTypeDefinition
    • IMutableInputObjectTypesDefinition
    • IMutableInputValueDefinition
    • IMutableInterfacesDefinition
    • IMutableInterfaceTypeDefinition
    • IMutableInterfaceTypesDefinition
    • IMutableLiteralParserDefinition
    • IMutableMemberTypesDefinition
    • IMutableMutationTypeDefinition
    • IMutableNamed
    • IMutableNamedTypeDefinition
    • IMutableObjectTypeDefinition
    • IMutableObjectTypesDefinition
    • IMutableQueryTypeDefinition
    • IMutableScalarTypeDefinition
    • IMutableScalarTypesDefinition
    • IMutableSchemaDefinition
    • IMutableSerializerDefinition
    • IMutableSubscriptionTypeDefinition
    • IMutableUnionTypeDefinition
    • IMutableUnionTypesDefinition
    • IMutableValueParserDefinition
    • IMutationType
    • IMutationTypeDefinition
    • INamed
    • INamedType
    • INamedTypeDefinition
    • INamedTypeReference
    • INonNullType
    • INullableType
    • IObjectType
    • IObjectTypeDefinition
    • IObjectTypes
    • IObjectTypesDefinition
    • IOutputDefinition
    • IQueryType
    • IQueryTypeDefinition
    • IScalarType
    • IScalarTypeDefinition
    • IScalarTypes
    • IScalarTypesDefinition
    • ISchema
    • ISchemaDefinition
    • ISerializer
    • ISerializerDefinition
    • ISubscriptionType
    • ISubscriptionTypeDefinition
    • ISyntaxConvertable
    • IUnionType
    • IUnionTypeDefinition
    • IUnionTypes
    • IUnionTypesDefinition
    • IValueParser
    • IValueParserDefinition
    • IWrappingNullableType
    • IWrappingType
  • GraphZen.Utilities
    • Helpers
    • TypeInfo

Class DocumentSyntax

A GraphQL document contains multiple definitions, either executable or representative of a GraphQL type system. http://facebook.github.io/graphql/June2018/#sec-Language.Document

Inheritance
Object
SyntaxNode
DocumentSyntax
Implements
ISyntaxNodeLocation
Inherited Members
SyntaxNode.Location
SyntaxNode.DescendantNodes()
SyntaxNode.ToSyntaxString()
Namespace: GraphZen.LanguageModel
Assembly: GraphZen.LanguageModel.dll
Syntax
public sealed class DocumentSyntax : SyntaxNode, ISyntaxNodeLocation

Constructors

DocumentSyntax(IReadOnlyList<DefinitionSyntax>, SyntaxLocation)

Declaration
public DocumentSyntax(IReadOnlyList<DefinitionSyntax> definitions, SyntaxLocation location = null)
Parameters
Type Name Description
IReadOnlyList<DefinitionSyntax> definitions
SyntaxLocation location

Properties

Children

Declaration
public override IEnumerable<SyntaxNode> Children { get; }
Property Value
Type Description
IEnumerable<SyntaxNode>
Overrides
SyntaxNode.Children

Definitions

Declaration
public IReadOnlyList<DefinitionSyntax> Definitions { get; }
Property Value
Type Description
IReadOnlyList<DefinitionSyntax>

EmptyList

Empty, read-only list of DocumentSyntax nodes.

Declaration
public static IReadOnlyList<DocumentSyntax> EmptyList { get; }
Property Value
Type Description
IReadOnlyList<DocumentSyntax>

Kind

Declaration
public override SyntaxKind Kind { get; }
Property Value
Type Description
SyntaxKind
Overrides
SyntaxNode.Kind

Methods

Equals(Object)

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
Object obj
Returns
Type Description
Boolean
Overrides
Object.Equals(Object)

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
Int32
Overrides
Object.GetHashCode()

GetInputTypeDefinitions()

Declaration
public IReadOnlyList<TypeDefinitionSyntax> GetInputTypeDefinitions()
Returns
Type Description
IReadOnlyList<TypeDefinitionSyntax>

GetOutputTypeDefinitions()

Declaration
public IReadOnlyList<TypeDefinitionSyntax> GetOutputTypeDefinitions()
Returns
Type Description
IReadOnlyList<TypeDefinitionSyntax>

IsTypeSubTypeOf(TypeSyntax, TypeSyntax)

Declaration
public bool IsTypeSubTypeOf(TypeSyntax maybeSubType, TypeSyntax superType)
Parameters
Type Name Description
TypeSyntax maybeSubType
TypeSyntax superType
Returns
Type Description
Boolean

VisitEnter(GraphQLSyntaxVisitor)

Called when a GraphQLSyntaxVisitor enters a DocumentSyntax node.

Declaration
public override void VisitEnter(GraphQLSyntaxVisitor visitor)
Parameters
Type Name Description
GraphQLSyntaxVisitor visitor
Overrides
SyntaxNode.VisitEnter(GraphQLSyntaxVisitor)

VisitEnter<TResult>(GraphQLSyntaxVisitor<TResult>)

Called when a GraphQLSyntaxVisitor<TResult> enters a DocumentSyntax node.

Declaration
public override TResult VisitEnter<TResult>(GraphQLSyntaxVisitor<TResult> visitor)
Parameters
Type Name Description
GraphQLSyntaxVisitor<TResult> visitor
Returns
Type Description
TResult
Type Parameters
Name Description
TResult
Overrides
GraphZen.LanguageModel.SyntaxNode.VisitEnter<TResult>(GraphZen.LanguageModel.GraphQLSyntaxVisitor<TResult>)

VisitLeave(GraphQLSyntaxVisitor)

Called when a GraphQLSyntaxVisitor leaves a DocumentSyntax node.

Declaration
public override void VisitLeave(GraphQLSyntaxVisitor visitor)
Parameters
Type Name Description
GraphQLSyntaxVisitor visitor
Overrides
SyntaxNode.VisitLeave(GraphQLSyntaxVisitor)

VisitLeave<TResult>(GraphQLSyntaxVisitor<TResult>)

Called when a GraphQLSyntaxVisitor<TResult> leaves a DocumentSyntax node.

Declaration
public override TResult VisitLeave<TResult>(GraphQLSyntaxVisitor<TResult> visitor)
Parameters
Type Name Description
GraphQLSyntaxVisitor<TResult> visitor
Returns
Type Description
TResult
Type Parameters
Name Description
TResult
Overrides
GraphZen.LanguageModel.SyntaxNode.VisitLeave<TResult>(GraphZen.LanguageModel.GraphQLSyntaxVisitor<TResult>)

WithFilteredDefinitions(Func<DefinitionSyntax, Boolean>)

Declaration
public DocumentSyntax WithFilteredDefinitions(Func<DefinitionSyntax, bool> predicate)
Parameters
Type Name Description
Func<DefinitionSyntax, Boolean> predicate
Returns
Type Description
DocumentSyntax

Implements

ISyntaxNodeLocation

Extension Methods

DocumentSyntaxExtensions.WithSpecDefinitions(DocumentSyntax)
DocumentSyntaxExtensions.WithoutSpecDefinitions(DocumentSyntax)
DocumentSyntaxExtensions.WithoutIntrospectionTypes(DocumentSyntax)
DocumentSyntaxExtensions.WithoutBuiltInDefinitions(DocumentSyntax)
DocumentSyntaxExtensions.WithDefinitionsAdded(DocumentSyntax, IEnumerable<DefinitionSyntax>)
DocumentSyntaxExtensions.WithDefinitionsAdded(DocumentSyntax, DefinitionSyntax[])
DocumentSyntaxExtensions.WithSortedChildren(DocumentSyntax)
Back to top Copyright © 2017-2019 GraphZen LLC