Module com.github.rvesse.airline.prompts
Package com.github.rvesse.airline.prompts.console

Class StreamPrompt

  • All Implemented Interfaces:
    PromptProvider
    Direct Known Subclasses:
    StdIOPrompt
    public class StreamPrompt
extends java.lang.Object
implements PromptProvider
    Creates a new prompt backed by arbitrary streams

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private java.io.OutputStream rawOutput  
      private java.io.BufferedReader reader  
      private java.io.PrintWriter writer  

    • Constructor Summary

      Constructors 
      Constructor Description
      StreamPrompt​(java.io.OutputStream output, java.io.InputStream input)
      Creates a new stream prompt

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.io.PrintWriter getPromptWriter()
      Gets the writer to which prompts should be written
      int readKey()
      Reads a single key from the prompts source
      java.lang.String readLine()
      Reads a line from the prompts source
      char[] readSecureLine()
      Reads a line from the prompts source in a secure manner
      boolean supportsSecureReads()
      Whether the provider supports secured reads

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • rawOutput

        private final java.io.OutputStream rawOutput

      • writer

        private final java.io.PrintWriter writer

      • reader

        private final java.io.BufferedReader reader

    • Constructor Detail

      • StreamPrompt

        public StreamPrompt​(java.io.OutputStream output,
                    java.io.InputStream input)
        Creates a new stream prompt
        Parameters:
        output - Output stream
        input - Input stream

    • Method Detail

      • getPromptWriter

        public java.io.PrintWriter getPromptWriter()
        Description copied from interface: PromptProvider
        Gets the writer to which prompts should be written
        Specified by:
        getPromptWriter in interface PromptProvider
        Returns:
        Prompt writer

      • readLine

        public java.lang.String readLine()
        Description copied from interface: PromptProvider
        Reads a line from the prompts source
        Specified by:
        readLine in interface PromptProvider
        Returns:
        Line (or null if unable to read a line)

      • readKey

        public int readKey()
        Description copied from interface: PromptProvider
        Reads a single key from the prompts source
        Specified by:
        readKey in interface PromptProvider
        Returns:
        Key code (or -1 if unable to read a key)

      • supportsSecureReads

        public boolean supportsSecureReads()
        Description copied from interface: PromptProvider
        Whether the provider supports secured reads
        Specified by:
        supportsSecureReads in interface PromptProvider
        Returns:
        True if supported, false otherwise

      • readSecureLine

        public char[] readSecureLine()
        Description copied from interface: PromptProvider
        Reads a line from the prompts source in a secure manner
        Specified by:
        readSecureLine in interface PromptProvider
        Returns:
        Line (or null if unable to read a line)