PrintCommandListener (Apache Commons Net 3.4 API)

org.apache.commons.net

## Class PrintCommandListener

- java.lang.Object
- - org.apache.commons.net.PrintCommandListener

- All Implemented Interfaces:
    EventListener, ProtocolCommandListener

      public class PrintCommandListener
      extends Object
      implements ProtocolCommandListener

  This is a support class for some of the 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 and Description
    `PrintCommandListener(PrintStream stream)` Create the default instance which prints everything.
    `PrintCommandListener(PrintStream stream, boolean suppressLogin)` Create an instance which optionally suppresses login command text and indicates where the EOL starts with the specified character.
    `PrintCommandListener(PrintStream stream, boolean suppressLogin, char eolMarker)` Create an instance which optionally suppresses login command text and indicates where the EOL starts with the specified character.
    `PrintCommandListener(PrintStream stream, boolean suppressLogin, char eolMarker, boolean showDirection)` Create an instance which optionally suppresses login command text and indicates where the EOL starts with the specified character.
    `PrintCommandListener(PrintWriter writer)` Create the default instance which prints everything.
    `PrintCommandListener(PrintWriter writer, boolean suppressLogin)` Create an instance which optionally suppresses login command text.
    `PrintCommandListener(PrintWriter writer, boolean suppressLogin, char eolMarker)` Create an instance which optionally suppresses login command text and indicates where the EOL starts with the specified character.
    `PrintCommandListener(PrintWriter writer, boolean suppressLogin, char eolMarker, boolean showDirection)` Create an instance which optionally suppresses login command text and indicates where the EOL starts with the specified character.

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `void` | `protocolCommandSent(ProtocolCommandEvent event)` This method is invoked by a ProtocolCommandEvent source after sending a protocol command to a server.
    `void` | `protocolReplyReceived(ProtocolCommandEvent event)` This method is invoked by a ProtocolCommandEvent source after receiving a reply from a server.

    - ### Methods inherited from class java.lang.Object

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

- - ### Constructor Detail

    - #### PrintCommandListener

          public PrintCommandListener(PrintStream stream)

      Create the default instance which prints everything.
      Parameters:
        `stream` - where to write the commands and responses e.g. System.out
      Since:
        3.0

    - #### PrintCommandListener

          public PrintCommandListener(PrintStream stream,
                              boolean suppressLogin)

      Create an instance which optionally suppresses login command text and indicates where the EOL starts with the specified character.
      Parameters:
        `stream` - where to write the commands and responses
        `suppressLogin` - if `true`, only print command name for login
      Since:
        3.0

    - #### PrintCommandListener

          public PrintCommandListener(PrintStream stream,
                              boolean suppressLogin,
                              char eolMarker)

      Create an instance which optionally suppresses login command text and indicates where the EOL starts with the specified character.
      Parameters:
        `stream` - 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(PrintStream stream,
                              boolean suppressLogin,
                              char eolMarker,
                              boolean showDirection)

      Create an instance which optionally suppresses login command text and indicates where the EOL starts with the specified character.
      Parameters:
        `stream` - 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(PrintWriter writer)

      Create the default instance which prints everything.
      Parameters:
        `writer` - where to write the commands and responses

    - #### PrintCommandListener

          public PrintCommandListener(PrintWriter writer,
                              boolean suppressLogin)

      Create 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(PrintWriter writer,
                              boolean suppressLogin,
                              char eolMarker)

      Create 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(PrintWriter writer,
                              boolean suppressLogin,
                              char eolMarker,
                              boolean showDirection)

      Create 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

  - ### Method Detail

    - #### protocolCommandSent

          public void protocolCommandSent(ProtocolCommandEvent event)

      Description copied from interface: `ProtocolCommandListener`
      This method is invoked by a ProtocolCommandEvent source after sending a protocol command to a server.
      Specified by:
        `protocolCommandSent` in interface `ProtocolCommandListener`
      Parameters:
        `event` - The ProtocolCommandEvent fired.

    - #### protocolReplyReceived

          public void protocolReplyReceived(ProtocolCommandEvent event)

      Description copied from interface: `ProtocolCommandListener`
      This method is invoked by a ProtocolCommandEvent source after receiving a reply from a server.
      Specified by:
        `protocolReplyReceived` in interface `ProtocolCommandListener`
      Parameters:
        `event` - The ProtocolCommandEvent fired.

Copyright © 2001–2015 The Apache Software Foundation. All rights reserved.