Object/Trait

grizzled.readline

Readline

Related Docs: trait Readline | package readline

Permalink

object Readline

Companion factory object, used to instantiate particular readline implementations.

Deprecated

Use JLine <https://github.com/jline/jline2>

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Readline
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

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. object ReadlineType extends Enumeration

    Permalink

    An enumeration of the various underlying readline APIs supported by this API.

    An enumeration of the various underlying readline APIs supported by this API. Note that a given API may or may not be available on a particular machine. The following implementations are currently supported:

    - GNUReadline: The GNU Readline library. Requires the JavaReadline jar (http://java-readline.sourceforge.net/) and the GNU Readline library (http://tiswww.case.edu/php/chet/readline/rltop.html). - Editline: The Editline library, originally from BSD Unix. Requires the libjavaeditline jar and dynamic library (see http://software.clapper.org/java/javaeditline/) and the Editline library (http://www.thrysoee.dk/editline/). - Getline: The Getline library. Requires the JavaReadline jar (http://java-readline.sourceforge.net/) and the Getline library. - JLine: The JLine library. Requires the JLine jar http://jline.sourceforge.net/). - Simple: A simple, none-editing, pure Java implementation.

  5. def apply(readlineType: ReadlineType, appName: String): Readline

    Permalink

    Get the specified Readline implementation, with autoAddHistory set to true.

    Get the specified Readline implementation, with autoAddHistory set to true.

    readlineType

    the ReadlineType to use

    appName

    an arbitrary name of the calling application

    returns

    the appropriate Readline implementation.

  6. def apply(readlineType: ReadlineType, appName: String, autoAddHistory: Boolean): Readline

    Permalink

    Get the specified Readline implementation.

    Get the specified Readline implementation. This function will throw an UnsatisfiedLinkError if the underlying library cannot be found.

    readlineType

    the ReadlineType to use

    appName

    an arbitrary name of the calling application

    autoAddHistory

    whether lines read by the function should automatically be added to the history. If this parameter is false, then the caller is responsible for adding lines to the history.

    returns

    the appropriate Readline implementation.

  7. final def asInstanceOf[T0]: T0

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  9. final def eq(arg0: AnyRef): Boolean

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

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  12. def findReadline(libs: List[ReadlineType], appName: String, autoAddHistory: Boolean = true): Option[Readline]

    Permalink

    Given a list of Readline types, find and return the first one that loads.

    Given a list of Readline types, find and return the first one that loads.

    libs

    list of readline library types to try, in order

    appName

    an arbitrary name of the calling application

    autoAddHistory

    whether lines read by the function should automatically be added to the history. If this parameter is false, then the caller is responsible for adding lines to the history.

    returns

    the loaded implementation, or None.

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

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

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
  19. final def synchronized[T0](arg0: ⇒ T0): T0

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

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

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

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

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

Inherited from AnyRef

Inherited from Any

Ungrouped