net.grinder.tools.tcpproxy.CommentSource Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of grinder-http Show documentation

The Grinder HTTP plugin.

There is a newer version: 4.0.0

// Copyright (C) 2007 Venelin Mitov
// Copyright (C) 2007 Philip Aston
// All rights reserved.
//
// This file is part of The Grinder software distribution. Refer to
// the file LICENSE which is part of The Grinder distribution for
// licensing details. The Grinder distribution is available on the
// Internet at http://grinder.sourceforge.net/
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
// FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
// COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
// INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
// (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
// SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
// HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
// STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
// OF THE POSSIBILITY OF SUCH DAMAGE.

package net.grinder.tools.tcpproxy;


/**
 * Interface for passing comments, inserted by the user during a capture with
 * the TCPProxy, to the TCPProxyFilters.
 *
 * @author Venelin Mitov
 */
public interface CommentSource {

  /**
   * Get the comments added by the user since the previous call to getComments()
   * until now. The returned comments are excluded from the underlying
   * collection and will not be returned in subsequent calls.
   *
   * @return An array of all the comments inserted after the previous call to
   *         getComments() up to now. If no comments have been inserted an empty
   *         array is returned.
   */
  String[] getComments();
}