Class/Object

emblem.emblematic

Emblem

Related Docs: object Emblem | package emblematic

Permalink

case class Emblem[A] extends Reflective[A] with Product with Serializable

a reflective signature for a type. provides name information, properties, and a tool used to build new instances. the underlying type is treated as immutable, so each property provides a setter that returns a new instance. new instances can be built using a InstanceBuilder returned by method builder.

A

the type that this emblem reflects upon

Source
Emblem.scala
Linear Supertypes
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Emblem
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. Reflective
  7. AnyRef
  8. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. class InstanceBuilder extends AnyRef

    Permalink

    a builder of instances of the type represented by this emblem

  2. type PropType[B, C] = EmblemProp[B, C]

    Permalink

    the kind of reflective property this reflective has.

    the kind of reflective property this reflective has. either an EmblemProp or a UnionProp

    Definition Classes
    EmblemReflective

Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from Emblem[A] to any2stringadd[Emblem[A]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (Emblem[A], B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from Emblem[A] to ArrowAssoc[Emblem[A]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  6. def apply(name: String): PropType[A, _]

    Permalink

    retrieves a reflective property by name

    retrieves a reflective property by name

    Definition Classes
    Reflective
  7. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  8. def basicPropPaths(emblematic: Emblematic): Seq[EmblematicPropPath[A, _]]

    Permalink

    returns a sequence of all the basic emblematic prop paths that compose this emblem.

    returns a sequence of all the basic emblematic prop paths that compose this emblem. these prop paths are ordered by their (depth-first) appearance in the emblem.

    emblematic

    the emblematic to use in the recursive descent

    Exceptions thrown

    emblem.exceptions.EmblemNotComposedOfBasicsException if the emblem recursively contains any unions or collections

  9. def builder(): InstanceBuilder

    Permalink

    creates and returns a new builder for constructing new instances

  10. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  11. val creator: (Map[String, Any]) ⇒ A

    Permalink

    a function used by the builder to instantiate the new object

  12. lazy val debugInfo: String

    Permalink

    a string describing the reflective in full detail

    a string describing the reflective in full detail

    Definition Classes
    Reflective
  13. def ensuring(cond: (Emblem[A]) ⇒ Boolean, msg: ⇒ Any): Emblem[A]

    Permalink
    Implicit information
    This member is added by an implicit conversion from Emblem[A] to Ensuring[Emblem[A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: (Emblem[A]) ⇒ Boolean): Emblem[A]

    Permalink
    Implicit information
    This member is added by an implicit conversion from Emblem[A] to Ensuring[Emblem[A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. def ensuring(cond: Boolean, msg: ⇒ Any): Emblem[A]

    Permalink
    Implicit information
    This member is added by an implicit conversion from Emblem[A] to Ensuring[Emblem[A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. def ensuring(cond: Boolean): Emblem[A]

    Permalink
    Implicit information
    This member is added by an implicit conversion from Emblem[A] to Ensuring[Emblem[A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  17. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  18. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  19. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from Emblem[A] to StringFormat[Emblem[A]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  20. val fullname: String

    Permalink

    the fully qualified type name

    the fully qualified type name

    Definition Classes
    Reflective
  21. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  22. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  23. val name: String

    Permalink

    the unqualified type name

    the unqualified type name

    Definition Classes
    Reflective
  24. val namePrefix: String

    Permalink

    a dot-separated identifier of the enclosing scope of the type

    a dot-separated identifier of the enclosing scope of the type

    Definition Classes
    Reflective
  25. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  26. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  27. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  28. def prop[B](name: String)(implicit arg0: TypeKey[B]): PropType[A, B]

    Permalink

    retrieves the reflective property with the specified property type by name

    retrieves the reflective property with the specified property type by name

    Definition Classes
    Reflective
  29. val propMap: Map[String, PropType[A, _]]

    Permalink

    a map of the props, keyed by name

    a map of the props, keyed by name

    Definition Classes
    Reflective
  30. val props: Seq[EmblemProp[A, _]]

    Permalink

    the emblem properties

    Definition Classes
    EmblemReflective
  31. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  32. def toString(): String

    Permalink
    Definition Classes
    EmblemReflective → AnyRef → Any
  33. val typeKey: TypeKey[A]

    Permalink

    a type key for the type that this emblem reflects upon

    a type key for the type that this emblem reflects upon

    Definition Classes
    EmblemReflective
  34. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  37. def [B](y: B): (Emblem[A], B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from Emblem[A] to ArrowAssoc[Emblem[A]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Reflective[A]

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from Emblem[A] to any2stringadd[Emblem[A]]

Inherited by implicit conversion StringFormat from Emblem[A] to StringFormat[Emblem[A]]

Inherited by implicit conversion Ensuring from Emblem[A] to Ensuring[Emblem[A]]

Inherited by implicit conversion ArrowAssoc from Emblem[A] to ArrowAssoc[Emblem[A]]

Ungrouped