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.EventObject; 58 59 /*** 60 * A CopyStreamEvent is triggered after every write performed by a 61 * stream copying operation. The event stores the number of bytes 62 * transferred by the write triggering the event as well as the total 63 * number of bytes transferred so far by the copy operation. 64 * <p> 65 * <p> 66 * @see CopyStreamListener 67 * @see CopyStreamAdapter 68 * @see Util 69 * @author <a href="mailto:savarese@apache.org">Daniel F. Savarese</a> 70 * @version $Id: CopyStreamEvent.java,v 1.6 2003/01/26 04:33:32 brekke Exp $ 71 */ 72 public class CopyStreamEvent extends EventObject 73 { 74 /*** 75 * Constant used to indicate the stream size is unknown. 76 */ 77 public static final long UNKNOWN_STREAM_SIZE = -1; 78 79 private int bytesTransferred; 80 private long totalBytesTransferred; 81 private long streamSize; 82 83 /*** 84 * Creates a new CopyStreamEvent instance. 85 * @param source The source of the event. 86 * @param totalBytesTransferred The total number of bytes transferred so 87 * far during a copy operation. 88 * @param bytesTransferred The number of bytes transferred during the 89 * write that triggered the CopyStreamEvent. 90 * @param streamSize The number of bytes in the stream being copied. 91 * This may be set to <code>UNKNOWN_STREAM_SIZE</code> if the 92 * size is unknown. 93 */ 94 public CopyStreamEvent(Object source, long totalBytesTransferred, 95 int bytesTransferred, long streamSize) 96 { 97 super(source); 98 this.bytesTransferred = bytesTransferred; 99 this.totalBytesTransferred = totalBytesTransferred; 100 this.streamSize = streamSize; 101 } 102 103 /*** 104 * Returns the number of bytes transferred by the write that triggered 105 * the event. 106 * @return The number of bytes transferred by the write that triggered 107 * the vent. 108 */ 109 public int getBytesTransferred() 110 { 111 return bytesTransferred; 112 } 113 114 /*** 115 * Returns the total number of bytes transferred so far by the copy 116 * operation. 117 * @return The total number of bytes transferred so far by the copy 118 * operation. 119 */ 120 public long getTotalBytesTransferred() 121 { 122 return totalBytesTransferred; 123 } 124 125 /*** 126 * Returns the size of the stream being copied. 127 * This may be set to <code>UNKNOWN_STREAM_SIZE</code> if the 128 * size is unknown. 129 * @return The size of the stream being copied. 130 */ 131 public long getStreamSize() 132 { 133 return streamSize; 134 } 135 }

This page was automatically generated by Maven