Package org.jboss.netty.handler.stream

Class ChunkedFile

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private int chunkSize  
      private long endOffset  
      private java.io.RandomAccessFile file  
      private long offset  
      private long startOffset  

    • Constructor Summary

      Constructors 
      Constructor Description
      ChunkedFile​(java.io.File file)
      Creates a new instance that fetches data from the specified file.
      ChunkedFile​(java.io.File file, int chunkSize)
      Creates a new instance that fetches data from the specified file.
      ChunkedFile​(java.io.RandomAccessFile file)
      Creates a new instance that fetches data from the specified file.
      ChunkedFile​(java.io.RandomAccessFile file, int chunkSize)
      Creates a new instance that fetches data from the specified file.
      ChunkedFile​(java.io.RandomAccessFile file, long offset, long length, int chunkSize)
      Creates a new instance that fetches data from the specified file.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void close()
      Releases the resources associated with the stream.
      long getCurrentOffset()
      Returns the offset in the file where the transfer is happening currently.
      long getEndOffset()
      Returns the offset in the file where the transfer will end.
      long getStartOffset()
      Returns the offset in the file where the transfer began.
      boolean hasNextChunk()
      Returns true if and only if there is any data left in the stream.
      boolean isEndOfInput()
      Return true if and only if there is no data left in the stream and the stream has reached at its end.
      java.lang.Object nextChunk()
      Fetches a chunked data from the stream.

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • file

        private final java.io.RandomAccessFile file

      • startOffset

        private final long startOffset

      • endOffset

        private final long endOffset

      • chunkSize

        private final int chunkSize

      • offset

        private long offset

    • Constructor Detail

      • ChunkedFile

        public ChunkedFile​(java.io.File file)
            throws java.io.IOException
        Creates a new instance that fetches data from the specified file.
        Throws:
        java.io.IOException

      • ChunkedFile

        public ChunkedFile​(java.io.File file,
                   int chunkSize)
            throws java.io.IOException
        Creates a new instance that fetches data from the specified file.
        Parameters:
        chunkSize - the number of bytes to fetch on each nextChunk() call
        Throws:
        java.io.IOException

      • ChunkedFile

        public ChunkedFile​(java.io.RandomAccessFile file)
            throws java.io.IOException
        Creates a new instance that fetches data from the specified file.
        Throws:
        java.io.IOException

      • ChunkedFile

        public ChunkedFile​(java.io.RandomAccessFile file,
                   int chunkSize)
            throws java.io.IOException
        Creates a new instance that fetches data from the specified file.
        Parameters:
        chunkSize - the number of bytes to fetch on each nextChunk() call
        Throws:
        java.io.IOException

      • ChunkedFile

        public ChunkedFile​(java.io.RandomAccessFile file,
                   long offset,
                   long length,
                   int chunkSize)
            throws java.io.IOException
        Creates a new instance that fetches data from the specified file.
        Parameters:
        offset - the offset of the file where the transfer begins
        length - the number of bytes to transfer
        chunkSize - the number of bytes to fetch on each nextChunk() call
        Throws:
        java.io.IOException

    • Method Detail

      • getStartOffset

        public long getStartOffset()
        Returns the offset in the file where the transfer began.

      • getEndOffset

        public long getEndOffset()
        Returns the offset in the file where the transfer will end.

      • getCurrentOffset

        public long getCurrentOffset()
        Returns the offset in the file where the transfer is happening currently.

      • hasNextChunk

        public boolean hasNextChunk()
                     throws java.lang.Exception
        Description copied from interface: ChunkedInput
        Returns true if and only if there is any data left in the stream. Please note that false does not necessarily mean that the stream has reached at its end. In a slow stream, the next chunk might be unavailable just momentarily.
        Specified by:
        hasNextChunk in interface ChunkedInput
        Throws:
        java.lang.Exception

      • isEndOfInput

        public boolean isEndOfInput()
                     throws java.lang.Exception
        Description copied from interface: ChunkedInput
        Return true if and only if there is no data left in the stream and the stream has reached at its end.
        Specified by:
        isEndOfInput in interface ChunkedInput
        Throws:
        java.lang.Exception

      • close

        public void close()
           throws java.lang.Exception
        Description copied from interface: ChunkedInput
        Releases the resources associated with the stream.
        Specified by:
        close in interface ChunkedInput
        Throws:
        java.lang.Exception

      • nextChunk

        public java.lang.Object nextChunk()
                           throws java.lang.Exception
        Description copied from interface: ChunkedInput
        Fetches a chunked data from the stream. The returned chunk is usually a ChannelBuffer, but you could extend an existing implementation to convert the ChannelBuffer into a different type that your handler or encoder understands. Once this method returns the last chunk and thus the stream has reached at its end, any subsequent ChunkedInput.isEndOfInput() call must return false.
        Specified by:
        nextChunk in interface ChunkedInput
        Returns:
        the fetched chunk, which is usually ChannelBuffer. null if there is no data left in the stream. Please note that null does not necessarily mean that the stream has reached at its end. In a slow stream, the next chunk might be unavailable just momentarily.
        Throws:
        java.lang.Exception