grackle-docs
0.24.0
API
Generated with
grackle-docs/grackle/Mapping/TypeMappings

TypeMappings

grackle.Mapping.TypeMappings
See theTypeMappings companion object
final class TypeMappings

Attributes

Companion
object
Source
mapping.scala
Graph
Supertypes
class Object
trait Matchable
class Any

Members list

Value members

Concrete methods

def ancestralFieldMapping(context: Context, fieldName: String): Option[FieldMapping]

Yields the FieldMapping directly or ancestrally associated with fieldName in context, if any.

Yields the FieldMapping directly or ancestrally associated with fieldName in context, if any.

Attributes

Source
mapping.scala
def fieldMapping(context: Context, fieldName: String): Option[FieldMapping]

Yields the FieldMapping associated with fieldName in context, if any.

Yields the FieldMapping associated with fieldName in context, if any.

Attributes

Source
mapping.scala
def fieldMapping(parent: Cursor, fieldName: String): Result[Option[(Cursor, FieldMapping)]]

Yields the FieldMapping associated with fieldName in the runtime context determined by the given Cursor, if any.

Yields the FieldMapping associated with fieldName in the runtime context determined by the given Cursor, if any.

Attributes

Source
mapping.scala
def objectMapping(context: Context): Option[ObjectMapping]

Yields the ObjectMapping associated with the provided context, if any.

Yields the ObjectMapping associated with the provided context, if any.

Attributes

Source
mapping.scala
def rawFieldMapping(context: Context, fieldName: String): Option[FieldMapping]

Yields the unexpanded FieldMapping associated with fieldName in context, if any.

Yields the unexpanded FieldMapping associated with fieldName in context, if any.

Attributes

Source
mapping.scala
def typeMapping(context: Context): Option[TypeMapping]

Yields the TypeMapping associated with the provided context, if any.

Yields the TypeMapping associated with the provided context, if any.

Attributes

Source
mapping.scala
def unsafeValidate(severity: Severity): Unit

Validate this Mapping, throwing a ValidationException if there are any failures of severity equal to or greater than the specified Severity.

Validate this Mapping, throwing a ValidationException if there are any failures of severity equal to or greater than the specified Severity.

Attributes

Source
mapping.scala
def validate(severity: Severity): List[ValidationFailure]

Validatate this Mapping, yielding a list of ValidationFailures of severity equal to or greater than the specified Severity.

Validatate this Mapping, yielding a list of ValidationFailures of severity equal to or greater than the specified Severity.

Attributes

Source
mapping.scala
def validateInto[G[_]](severity: Severity)(implicit ev: ApplicativeError[G, Throwable]): G[Unit]

Validate this mapping, raising a ValidationException in F if there are any failures of severity equal to or greater than the specified Severity.

Validate this mapping, raising a ValidationException in F if there are any failures of severity equal to or greater than the specified Severity.

Attributes

Source
mapping.scala

Concrete fields

val mappings: Seq[TypeMapping]

Attributes

Source
mapping.scala
Generated with