    View Javadoc
    1   package org.apache.commons.net.io;
    2
    3   /* ====================================================================
    4    * The Apache Software License, Version 1.1
    5    *
    6    * Copyright (c) 2001 The Apache Software Foundation.  All rights
    7    * reserved.
    8    *
    9    * Redistribution and use in source and binary forms, with or without
    10   * modification, are permitted provided that the following conditions
    11   * are met:
    12   *
    13   * 1. Redistributions of source code must retain the above copyright
    14   *    notice, this list of conditions and the following disclaimer.
    15   *
    16   * 2. Redistributions in binary form must reproduce the above copyright
    17   *    notice, this list of conditions and the following disclaimer in
    18   *    the documentation and/or other materials provided with the
    19   *    distribution.
    20   *
    21   * 3. The end-user documentation included with the redistribution,
    22   *    if any, must include the following acknowledgment:
    23   *       "This product includes software developed by the
    24   *        Apache Software Foundation (http://www.apache.org/)."
    25   *    Alternately, this acknowledgment may appear in the software itself,
    26   *    if and wherever such third-party acknowledgments normally appear.
    27   *
    28   * 4. The names "Apache" and "Apache Software Foundation" and
    29   *    "Apache Commons" must not be used to endorse or promote products
    30   *    derived from this software without prior written permission. For
    31   *    written permission, please contact apache@apache.org.
    32   *
    33   * 5. Products derived from this software may not be called "Apache",
    34   *    nor may "Apache" appear in their name, without
    35   *    prior written permission of the Apache Software Foundation.
    36   *
    37   * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
    38   * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
    39   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
    40   * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
    41   * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
    42   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
    43   * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
    44   * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
    45   * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
    46   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
    47   * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
    48   * SUCH DAMAGE.
    49   * ====================================================================
    50   *
    51   * This software consists of voluntary contributions made by many
    52   * individuals on behalf of the Apache Software Foundation.  For more
    53   * information on the Apache Software Foundation, please see
    54   * <http://www.apache.org/>;.
    55   */
    56
    57  import java.util.EventListener;
    58
    59  /***
    60   * The CopyStreamListener class can accept CopyStreamEvents to keep track
    61   * of the progress of a stream copying operation.  However, it is currently
    62   * not used that way within NetComponents for performance reasons.  Rather
    63   * the bytesTransferred(long, int) method is called directly rather than
    64   * passing an event to bytesTransferred(CopyStreamEvent), saving the creation
    65   * of a CopyStreamEvent instance.  Also, the only place where
    66   * CopyStreamListener is currently used within NetComponents is in the
    67   * static methods of the uninstantiable org.apache.commons.io.Util class, which
    68   * would preclude the use of addCopyStreamListener and
    69   * removeCopyStreamListener methods.  However, future additions may use the
    70   * JavaBean event model, which is why the hooks have been included from the
    71   * beginning.
    72   * <p>
    73   * <p>
    74   * @see CopyStreamEvent
    75   * @see CopyStreamAdapter
    76   * @see Util
    77   * @author <a href="mailto:savarese@apache.org">Daniel F. Savarese</a>
    78   * @version $Id: CopyStreamListener.java,v 1.6 2003/01/26 04:33:32 brekke Exp $
    79   */
    80  public interface CopyStreamListener extends EventListener
    81  {
    82      /***
    83       * This method is invoked by a CopyStreamEvent source after copying
    84       * a block of bytes from a stream.  The CopyStreamEvent will contain
    85       * the total number of bytes transferred so far and the number of bytes
    86       * transferred in the last write.
    87       * @param event The CopyStreamEvent fired by the copying of a block of
    88       *              bytes.
    89       */
    90      public void bytesTransferred(CopyStreamEvent event);
    91
    92
    93      /***
    94       * This method is not part of the JavaBeans model and is used by the
    95       * static methods in the org.apache.commons.io.Util class for efficiency.
    96       * It is invoked after a block of bytes to inform the listener of the
    97       * transfer.
    98       * @param totalBytesTransferred  The total number of bytes transferred
    99       *         so far by the copy operation.
    100      * @param bytesTransferred  The number of bytes copied by the most recent
    101      *          write.
    102      * @param streamSize The number of bytes in the stream being copied.
    103      *        This may be equal to CopyStreamEvent.UNKNOWN_STREAM_SIZE if
    104      *        the size is unknown.
    105      */
    106     public void bytesTransferred(long totalBytesTransferred,
    107                                  int bytesTransferred,
    108                                  long streamSize);
    109 }

This page was automatically generated by Maven