Document

sangria.ast.Document
See theDocument companion object
case class Document(definitions: Vector[Definition], trailingComments: Vector[Comment], location: Option[AstLocation], sourceMapper: Option[SourceMapper]) extends AstNode with WithTrailingComments

A complete GraphQL request operated on by a GraphQL service.

Attributes

definitions

The definitions, which primarily constitute the document.

See also:
Companion:
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait AstNode
class Object
trait Matchable
class Any

Members list

Concise view

Value members

Concrete methods

def +(other: Document): Document

An alias for merge

An alias for merge

Attributes

override def canEqual(other: Any): Boolean

Attributes

Definition Classes
override def equals(other: Any): Boolean

Compares the receiver object (this) with the argument object (that) for equivalence.

Compares the receiver object (this) with the argument object (that) for equivalence.

Any implementation of this method should be an equivalence relation:

  • It is reflexive: for any instance x of type Any, x.equals(x) should return true.
  • It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any instances x, y, and z of type Any if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.

If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is usually necessary to override hashCode to ensure that objects which are "equal" (o1.equals(o2) returns true) hash to the same scala.Int. (o1.hashCode.equals(o2.hashCode)).

Attributes

that

the object to compare against this object for equality.

Returns:

true if the receiver object is equivalent to the argument; false otherwise.

Definition Classes
Equals -> Any
override def hashCode(): Int

Calculate a hash code value for the object.

Calculate a hash code value for the object.

The default hashing algorithm is platform dependent.

Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.

Attributes

Returns:

the hash code value for this object.

Definition Classes
Any
def merge(other: Document): Document

Merges two documents. The sourceMappers are combined.

Merges two documents. The sourceMappers are combined.

Attributes

Return the operation for the given name.

Return the operation for the given name.

Attributes

Returns:

None, if no operations are defined or if the given name is ambiguous

Inherited methods

Attributes

Inherited from:
AstNode

Attributes

Inherited from:
Product

Attributes

Inherited from:
Product

Concrete fields

Map of fragment name to its definition.

Map of fragment name to its definition.

Attributes

Map of operation name to its definition.

Map of operation name to its definition.

Attributes

lazy val source: Option[String]