Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  /*
   * Licensed to the Apache Software Foundation (ASF) under one or more
   * contributor license agreements.  See the NOTICE file distributed with
   * this work for additional information regarding copyright ownership.
   * The ASF licenses this file to You under the Apache License, Version 2.0
   * (the "License"); you may not use this file except in compliance with
   * the License.  You may obtain a copy of the License at
   *
   *      http://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
 
 package org.apache.commons.net.io;
 
A CopyStreamEvent is triggered after every write performed by a stream copying operation. The event stores the number of bytes transferred by the write triggering the event as well as the total number of bytes transferred so far by the copy operation.

Version:
$Id: CopyStreamEvent.java 1299238 2012-03-10 17:12:28Z sebb $
See also:
CopyStreamListener
CopyStreamAdapter
Util
 
 public class CopyStreamEvent extends EventObject
 {
     private static final long serialVersionUID = -964927635655051867L;

    
Constant used to indicate the stream size is unknown.
 
     public static final long UNKNOWN_STREAM_SIZE = -1;
 
     private final int bytesTransferred;
     private final long totalBytesTransferred;
     private final long streamSize;

    
Creates a new CopyStreamEvent instance.

Parameters:
source The source of the event.
totalBytesTransferred The total number of bytes transferred so far during a copy operation.
bytesTransferred The number of bytes transferred during the write that triggered the CopyStreamEvent.
streamSize The number of bytes in the stream being copied. This may be set to UNKNOWN_STREAM_SIZE if the size is unknown.
 
     public CopyStreamEvent(Object sourcelong totalBytesTransferred,
                            int bytesTransferredlong streamSize)
     {
         super(source);
         this. = bytesTransferred;
         this. = totalBytesTransferred;
         this. = streamSize;
     }

    
Returns the number of bytes transferred by the write that triggered the event.

Returns:
The number of bytes transferred by the write that triggered the vent.
 
     public int getBytesTransferred()
     {
         return ;
     }

    
Returns the total number of bytes transferred so far by the copy operation.

Returns:
The total number of bytes transferred so far by the copy operation.
 
     public long getTotalBytesTransferred()
     {
         return ;
     }

    
Returns the size of the stream being copied. This may be set to UNKNOWN_STREAM_SIZE if the size is unknown.

Returns:
The size of the stream being copied.
 
     public long getStreamSize()
     {
         return ;
     }

    

Since:
3.0
    @Override
    public String toString(){
        return getClass().getName() + "[source=" + 
        + ", total=" + 
        + ", bytes=" + 
        + ", size=" + 
        + "]";
    }
New to GrepCode? Check out our FAQ X