AvroType

Abstract parent class of all Avro types. An AvroType wraps a corresponding type from the Scala type system.

To obtain an AvroType instance use the apply or fromType method, defined on the AvroType companion object.

import com.gensler.scalavro.types.AvroType

val avroString = AvroType[String]
avroString.schema

Linear Supertypes

CanonicalForm, JsonSchemifiable, AnyRef, Any

Known Subclasses

AvroArray, AvroBoolean, AvroBoolean, AvroByte, AvroByte, AvroBytes, AvroBytes, AvroChar, AvroChar, AvroComplexType, AvroDouble, AvroDouble, AvroEnum, AvroError, AvroFixed, AvroFloat, AvroFloat, AvroInt, AvroInt, AvroJEnum, AvroLong, AvroLong, AvroMap, AvroNamedType, AvroNull, AvroNull, AvroPrimitiveType, AvroRecord, AvroReferenceUnion, AvroSet, AvroShort, AvroShort, AvroString, AvroString, AvroUnion

Instance Constructors

new AvroType()(implicit arg0: scala.reflect.api.JavaUniverse.TypeTag[T])

Type Members

type scalaType = T

The corresponding Scala type for this Avro type.

Abstract Value Members

abstract def dependsOn(thatType: AvroType[_]): Boolean

Returns true if this type depends upon the supplied type.
abstract def isPrimitive(): Boolean

Returns true if this represents a primitive Avro type.
abstract def schema(): JsValue

Returns the JSON representation of this Avro type schema.
Returns the JSON representation of this Avro type schema.

Definition Classes
AvroType → JsonSchemifiable
abstract def selfContainedSchema(resolvedSymbols: Set[String] = mutable.Set[String]()): JsValue

Returns the fully self-describing JSON representation of this Avro type schema.
abstract def typeName(): String

Returns the Avro type name for this schema.

Concrete Value Members

final def !=(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def !=(arg0: Any): Boolean

Definition Classes
Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def ==(arg0: Any): Boolean

Definition Classes
Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def canonicalFormOrFullyQualifiedName(): JsValue

Returns the fully qualified schema name if this is an instance of AvroNamedType, or the parsing canonical form of this type schema otherwise.
Internal API
Returns the fully qualified schema name if this is an instance of AvroNamedType, or the parsing canonical form of this type schema otherwise.

Attributes
protected[com.gensler.scalavro]
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
lazy val dependentNamedTypes: Seq[AvroNamedType[_]]

Returns the sequence of named types that are required to fully specify this AvroType, including recursive/transitive type dependencies.
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final lazy val fingerprint: Array[Byte]

Returns the result of computing MD5 over this type's parsing canonical form.
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
lazy val io: AvroTypeIO[T]

Returns an AvroTypeIO instance for this AvroType.
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def parsingCanonicalForm(): JsValue

Returns the JSON schema for this type in "parsing canonical form".
Returns the JSON schema for this type in "parsing canonical form".
_X_ [PRIMITIVES] Convert primitive schemas to their simple form (e.g., int instead of {"type":"int"}).
_X_ [FULLNAMES] Replace short names with fullnames, using applicable namespaces to do so. Then eliminate namespace attributes, which are now redundant.
_X_ [STRIP] Keep only attributes that are relevant to parsing data, which are: type, name, fields, symbols, items, values, size. Strip all others (e.g., doc and aliases).
_X_ [ORDER] Order the appearance of fields of JSON objects as follows: name, type, fields, symbols, items, values, size. For example, if an object has type, name, and size fields, then the name field should appear first, followed by the type and then the size fields.
_X_ [INTEGERS] Eliminate quotes around and any leading zeros in front of JSON integer literals (which appear in the size attributes of fixed schemas).
_X_ [WHITESPACE] Eliminate all whitespace in JSON outside of string literals.

Definition Classes
AvroType → CanonicalForm
def schemaOrName(): JsValue

Returns the schema name if this is an instance of AvroNamedType, or the expanded schema otherwise.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
final val tag: scala.reflect.api.JavaUniverse.TypeTag[T]
def toString(): String

Definition Classes
AvroType → AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
def writeCanonicalForm(os: OutputStream): Unit

_X_ [STRINGS] For all JSON string literals in the schema text, replace any escaped characters (e.
_X_ [STRINGS] For all JSON string literals in the schema text, replace any escaped characters (e.g., \\uXXXX escapes) with their UTF-8 equivalents.

abstract class AvroType[T] extends JsonSchemifiable with CanonicalForm

Instance Constructors

new AvroType()(implicit arg0: scala.reflect.api.JavaUniverse.TypeTag[T])

Type Members

type scalaType = T

Abstract Value Members

abstract def dependsOn(thatType: AvroType[_]): Boolean

abstract def isPrimitive(): Boolean

abstract def schema(): JsValue

abstract def selfContainedSchema(resolvedSymbols: Set[String] = mutable.Set[String]()): JsValue

abstract def typeName(): String

Concrete Value Members

final def !=(arg0: AnyRef): Boolean

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: AnyRef): Boolean

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def canonicalFormOrFullyQualifiedName(): JsValue

Internal API

def clone(): AnyRef

lazy val dependentNamedTypes: Seq[AvroNamedType[_]]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final lazy val fingerprint: Array[Byte]

final def getClass(): Class[_]

def hashCode(): Int

lazy val io: AvroTypeIO[T]

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def parsingCanonicalForm(): JsValue

def schemaOrName(): JsValue

final def synchronized[T0](arg0: ⇒ T0): T0

final val tag: scala.reflect.api.JavaUniverse.TypeTag[T]

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

def writeCanonicalForm(os: OutputStream): Unit

Inherited from CanonicalForm

Inherited from JsonSchemifiable

Inherited from AnyRef

Inherited from Any

Ungrouped