Class PrintCommandListener

  • All Implemented Interfaces:
    java.util.EventListener, ProtocolCommandListener

    public class PrintCommandListener
    extends java.lang.Object
    implements ProtocolCommandListener
    This is a support class for some example programs. It is a sample implementation of the ProtocolCommandListener interface which just prints out to a specified stream all command/reply traffic.
    Since:
    2.0
    • Constructor Summary

      Constructors 
      Constructor Description
      PrintCommandListener​(java.io.PrintStream printStream)
      Constructs an instance which prints everything using the default Charset.
      PrintCommandListener​(java.io.PrintStream printStream, boolean suppressLogin)
      Constructs an instance which optionally suppresses login command text and indicates where the EOL starts with the specified character.
      PrintCommandListener​(java.io.PrintStream printStream, boolean suppressLogin, char eolMarker)
      Constructs an instance which optionally suppresses login command text and indicates where the EOL starts with the specified character.
      PrintCommandListener​(java.io.PrintStream printStream, boolean suppressLogin, char eolMarker, boolean showDirection)
      Constructs an instance which optionally suppresses login command text and indicates where the EOL starts with the specified character.
      PrintCommandListener​(java.io.PrintWriter writer)
      Constructs the default instance which prints everything.
      PrintCommandListener​(java.io.PrintWriter writer, boolean suppressLogin)
      Constructs an instance which optionally suppresses login command text.
      PrintCommandListener​(java.io.PrintWriter writer, boolean suppressLogin, char eolMarker)
      Constructs an instance which optionally suppresses login command text and indicates where the EOL starts with the specified character.
      PrintCommandListener​(java.io.PrintWriter writer, boolean suppressLogin, char eolMarker, boolean showDirection)
      Constructs an instance which optionally suppresses login command text and indicates where the EOL starts with the specified character.
    • Field Detail

      • writer

        private final java.io.PrintWriter writer
      • nologin

        private final boolean nologin
      • eolMarker

        private final char eolMarker
      • directionMarker

        private final boolean directionMarker
    • Constructor Detail

      • PrintCommandListener

        public PrintCommandListener​(java.io.PrintStream printStream)
        Constructs an instance which prints everything using the default Charset.
        Parameters:
        printStream - where to write the commands and responses e.g. System.out
        Since:
        3.0
      • PrintCommandListener

        public PrintCommandListener​(java.io.PrintStream printStream,
                                    boolean suppressLogin)
        Constructs an instance which optionally suppresses login command text and indicates where the EOL starts with the specified character.
        Parameters:
        printStream - where to write the commands and responses
        suppressLogin - if true, only print command name for login
        Since:
        3.0
      • PrintCommandListener

        public PrintCommandListener​(java.io.PrintStream printStream,
                                    boolean suppressLogin,
                                    char eolMarker)
        Constructs an instance which optionally suppresses login command text and indicates where the EOL starts with the specified character.
        Parameters:
        printStream - where to write the commands and responses
        suppressLogin - if true, only print command name for login
        eolMarker - if non-zero, add a marker just before the EOL.
        Since:
        3.0
      • PrintCommandListener

        public PrintCommandListener​(java.io.PrintStream printStream,
                                    boolean suppressLogin,
                                    char eolMarker,
                                    boolean showDirection)
        Constructs an instance which optionally suppresses login command text and indicates where the EOL starts with the specified character.
        Parameters:
        printStream - where to write the commands and responses
        suppressLogin - if true, only print command name for login
        eolMarker - if non-zero, add a marker just before the EOL.
        showDirection - if true, add "> " or "< " as appropriate to the output
        Since:
        3.0
      • PrintCommandListener

        public PrintCommandListener​(java.io.PrintWriter writer)
        Constructs the default instance which prints everything.
        Parameters:
        writer - where to write the commands and responses
      • PrintCommandListener

        public PrintCommandListener​(java.io.PrintWriter writer,
                                    boolean suppressLogin)
        Constructs an instance which optionally suppresses login command text.
        Parameters:
        writer - where to write the commands and responses
        suppressLogin - if true, only print command name for login
        Since:
        3.0
      • PrintCommandListener

        public PrintCommandListener​(java.io.PrintWriter writer,
                                    boolean suppressLogin,
                                    char eolMarker)
        Constructs an instance which optionally suppresses login command text and indicates where the EOL starts with the specified character.
        Parameters:
        writer - where to write the commands and responses
        suppressLogin - if true, only print command name for login
        eolMarker - if non-zero, add a marker just before the EOL.
        Since:
        3.0
      • PrintCommandListener

        public PrintCommandListener​(java.io.PrintWriter writer,
                                    boolean suppressLogin,
                                    char eolMarker,
                                    boolean showDirection)
        Constructs an instance which optionally suppresses login command text and indicates where the EOL starts with the specified character.
        Parameters:
        writer - where to write the commands and responses
        suppressLogin - if true, only print command name for login
        eolMarker - if non-zero, add a marker just before the EOL.
        showDirection - if true, add "> " or "< " as appropriate to the output
        Since:
        3.0