Trait/Object

net.katsstuff.scammander.ScammanderBase

Parameter

Related Docs: object Parameter | package ScammanderBase

Permalink

trait Parameter[A] extends AnyRef

A parameter for a command. Can convert a list of arguments into a given type.

A

The parsed value.

Annotations
@implicitNotFound( ... )
Linear Supertypes
AnyRef, Any
Known Subclasses
ProxyParameter
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Parameter
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def name: String

    Permalink

    The name of the parameter.

    The name of the parameter. Will be used in usage.

  2. abstract def parse(source: RootSender, extra: RunExtra, xs: List[RawCmdArg]): CommandStep[(List[RawCmdArg], A)]

    Permalink

    Parse a list of arguments into the type of this parameter.

    Parse a list of arguments into the type of this parameter.

    source

    The command source.

    extra

    Extra platform specific info about the command.

    xs

    The arguments for the command.

    returns

    A command step with the remaining arguments, and the parsed type.

  3. abstract def suggestions(source: RootSender, extra: TabExtra, xs: List[RawCmdArg]): Either[List[RawCmdArg], Seq[String]]

    Permalink

    Returns the suggestions for a parameter.

    Returns the suggestions for a parameter.

    source

    The command source.

    extra

    Extra platform specific info about the command.

    xs

    The arguments for the command.

    returns

    A list of the remaining arguments, and the suggestions.

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. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  7. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  8. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

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

    Permalink
    Definition Classes
    AnyRef → Any

  10. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  11. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  12. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  13. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  14. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

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

    Permalink
    Definition Classes
    AnyRef

  16. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  17. def usage(source: RootSender): String

    Permalink

    The usage for this command.

  18. final def wait(): Unit

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

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

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

  20. final def wait(arg0: Long): Unit

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

Inherited from AnyRef

Inherited from Any

Ungrouped