Class/Object

com.twitter.app

Flaggable

Related Docs: object Flaggable | package app

Permalink

abstract class Flaggable[T] extends AnyRef

A type class providing evidence for parsing type T as a flag value.

Any class that is to be provided as a flaggable value must have an accompanying implicit Flaggable (contained within a companion object of the class in question) for converting a string to an object of that type. For instance, to make a hypothetical type called Foo flaggable:

class Foo {
  ...
}

object Foo {
  implicit val flagOfFoo = new Flaggable[Foo] {
    def parse(v: String): Foo = {
      ...
    }
  }
}

For simple implicit definitions based on existing String => T functions, use the Flaggable.mandatory function:

object Foo {
  def parse(v: String): Foo = {
     ...
  }

  implicit val ofFoo = Flaggable.mandatory(Foo.parse(_))
}

[1] http://en.wikipedia.org/wiki/Type_class

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Flaggable
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Flaggable()

    Permalink

Abstract Value Members

  1. abstract def parse(s: String): T

    Permalink

    Parse a string (i.e.

    Parse a string (i.e. a value set on the command line) into an object of type T.

Concrete Value Members

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

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. def default: Option[T]

    Permalink

    An optional default value for the Flaggable.

  7. final def eq(arg0: AnyRef): Boolean

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

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. final def getClass(): Class[_]

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

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
  16. def show(t: T): String

    Permalink

    Create a string-representation of an object of type T.

    Create a string-representation of an object of type T. Used in Flag.toString.

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  19. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped