com.gensler.scalavro.types

AvroNamedType

abstract class AvroNamedType[T] extends AvroComplexType[T]

Parent class of all "named types". As of version 1.7.5 of the Avro specification, the named types are Record, Enum, and Fixed.

Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. AvroNamedType
  2. AvroComplexType
  3. SelfDescribingSchemaHelpers
  4. AvroType
  5. CanonicalForm
  6. JsonSchemifiable
  7. AnyRef
  8. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

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

Type Members

  1. type scalaType = T

    The corresponding Scala type for this Avro type.

    The corresponding Scala type for this Avro type.

    Definition Classes
    AvroType

Abstract Value Members

  1. abstract def name(): String

  2. abstract def namespace(): Option[String]

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

    Returns the fully self-describing JSON representation of this Avro type schema.

    Returns the fully self-describing JSON representation of this Avro type schema.

    Definition Classes
    AvroType
  4. abstract def typeName(): String

    Returns the Avro type name for this schema.

    Returns the Avro type name for this schema.

    Definition Classes
    AvroType

Concrete Value Members

  1. final def !=(arg0: AnyRef): Boolean

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

    Definition Classes
    Any
  3. final def ##(): Int

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

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

    Definition Classes
    Any
  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  7. final 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.

    Definition Classes
    AvroNamedTypeAvroType
  8. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  9. def compactSchema(): JsValue

    Returns the the schema of this Avro type in its most compact form.

    Returns the the schema of this Avro type in its most compact form. That is, with all named types represented as their fully qualified name.

    Definition Classes
    AvroType
  10. def computeDependencies(previouslyEncounteredTypes: Set[AvroType[_]] = Set[AvroType[_]]()): Seq[AvroNamedType[_]]

    Helper method for dependentNamedTypes to short-circuit infinite recursion in case of cyclic type dependency graphs.

    Internal API

    Helper method for dependentNamedTypes to short-circuit infinite recursion in case of cyclic type dependency graphs.

    Attributes
    protected[com.gensler.scalavro]
    Definition Classes
    AvroType
  11. lazy val dependentNamedTypes: Seq[AvroNamedType[_]]

    Returns the sequence of named types that are required to fully specify this AvroType, including recursive/transitive type dependencies.

    Returns the sequence of named types that are required to fully specify this AvroType, including recursive/transitive type dependencies.

    Definition Classes
    AvroType
  12. final def dependsOn(thatType: AvroType[_]): Boolean

    Returns true if this type depends upon the supplied type.

    Returns true if this type depends upon the supplied type.

    Definition Classes
    AvroComplexTypeAvroType
  13. final def eq(arg0: AnyRef): Boolean

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

    Definition Classes
    AnyRef → Any
  15. def finalize(): Unit

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

    Returns the result of computing MD5 over this type's parsing canonical form.

    Returns the result of computing MD5 over this type's parsing canonical form.

    Definition Classes
    AvroType
  17. final def fullyQualifiedName(): String

  18. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  19. def hashCode(): Int

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

    Returns an AvroTypeIO instance for this AvroType.

    Returns an AvroTypeIO instance for this AvroType.

    Definition Classes
    AvroType
  21. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  22. final val isPrimitive: Boolean(false)

    Returns true if this represents a primitive Avro type.

    Returns true if this represents a primitive Avro type.

    Definition Classes
    AvroComplexTypeAvroType
  23. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  24. final def notify(): Unit

    Definition Classes
    AnyRef
  25. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  26. final 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".

    Definition Classes
    AvroComplexTypeAvroTypeCanonicalForm
  27. def schema(): JsValue

    Returns the JSON representation of this Avro type schema.

    Returns the JSON representation of this Avro type schema.

    Definition Classes
    AvroComplexTypeAvroTypeJsonSchemifiable
  28. def schemaOrName(): JsValue

    Returns the schema name if this is an instance of AvroNamedType, or the expanded schema otherwise.

    Returns the schema name if this is an instance of AvroNamedType, or the expanded schema otherwise.

    Definition Classes
    AvroType
  29. def schemaToParsingCanonicalForm(schema: JsValue): JsValue

    Attributes
    protected[com.gensler.scalavro]
    Definition Classes
    SelfDescribingSchemaHelpers
  30. def selfContainedSchemaOrFullyQualifiedName(avroType: AvroType[_], resolvedSymbols: Set[String] = mutable.Set[String]()): JsValue

    Attributes
    protected[com.gensler.scalavro]
    Definition Classes
    SelfDescribingSchemaHelpers
  31. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  32. final val tag: scala.reflect.api.JavaUniverse.TypeTag[T]

    Definition Classes
    AvroType
  33. def toString(): String

    Definition Classes
    AvroComplexTypeAvroType → AnyRef → Any
  34. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  37. def withoutDocOrAliases(json: JsValue): JsValue

    Attributes
    protected
    Definition Classes
    AvroComplexType
  38. 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.

    Definition Classes
    AvroType

Inherited from AvroComplexType[T]

Inherited from AvroType[T]

Inherited from CanonicalForm

Inherited from JsonSchemifiable

Inherited from AnyRef

Inherited from Any

Ungrouped