Package com.azure.storage.common

Class StorageOutputStream

  • All Implemented Interfaces:
    Closeable, Flushable, AutoCloseable
    public abstract class StorageOutputStream
extends OutputStream
    StorageOutputStream allows for uploading data to an Azure Storage service using stream concepts.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected IOException lastError
      Holds the last exception this stream encountered.

    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      protected void checkStreamState()
      Helper function to check if the stream is faulted, if it is it surfaces the exception.
      void close()
      Closes this output stream and releases any system resources associated with this stream.
      protected abstract Mono<Void> dispatchWrite​(byte[] data, int writeLength, long offset)
      Dispatches a write operation to the Storage service.
      void flush()
      Flushes this output stream and forces any buffered output bytes to be written out.
      void write​(byte[] data)
      Writes b.length bytes from the specified byte array to this output stream.
      void write​(byte[] data, int offset, int length)
      Writes length bytes from the specified byte array starting at offset to this output stream.
      void write​(int byteVal)
      Writes the specified byte to this output stream.
      protected void writeInternal​(byte[] data, int offset, int length)
      Writes the data to the buffer and triggers writes to the service as needed.

    • Field Detail

      • lastError

        protected volatile IOException lastError
        Holds the last exception this stream encountered.

    • Constructor Detail

      • StorageOutputStream

        protected StorageOutputStream​(int writeThreshold)
        Creates a new instance of StorageOutputStream.
        Parameters:
        writeThreshold - How many bytes the output will retain before it initiates a write to the Storage service.

    • Method Detail

      • dispatchWrite

        protected abstract Mono<Void> dispatchWrite​(byte[] data,
                                            int writeLength,
                                            long offset)
        Dispatches a write operation to the Storage service.
        Parameters:
        data - The data to send.
        writeLength - Length of the data.
        offset - The offset to write the data.
        Returns:
        A reactive response that indicates completion.

      • writeInternal

        protected void writeInternal​(byte[] data,
                             int offset,
                             int length)
        Writes the data to the buffer and triggers writes to the service as needed.
        Parameters:
        data - A byte array which represents the data to write.
        offset - An int which represents the start offset in the data.
        length - An int which represents the number of bytes to write.

      • checkStreamState

        protected void checkStreamState()
        Helper function to check if the stream is faulted, if it is it surfaces the exception.
        Throws:
        RuntimeException - If an I/O error occurs. In particular, an IOException may be thrown if the output stream has been closed.

      • flush

        public void flush()
        Flushes this output stream and forces any buffered output bytes to be written out. If any data remains in the buffer it is committed to the service.
        Specified by:
        flush in interface Flushable
        Overrides:
        flush in class OutputStream

      • write

        public void write​(@NonNull
                  byte[] data)
        Writes b.length bytes from the specified byte array to this output stream.
        Overrides:
        write in class OutputStream
        Parameters:
        data - A byte array which represents the data to write.

      • write

        public void write​(@NonNull
                  byte[] data,
                  int offset,
                  int length)
        Writes length bytes from the specified byte array starting at offset to this output stream.
        Overrides:
        write in class OutputStream
        Parameters:
        data - A byte array which represents the data to write.
        offset - An int which represents the start offset in the data.
        length - An int which represents the number of bytes to write.
        Throws:
        IndexOutOfBoundsException - when access the bytes out of the bound.

      • write

        public void write​(int byteVal)
        Writes the specified byte to this output stream. The general contract for write is that one byte is written to the output stream. The byte to be written is the eight low-order bits of the argument b. The 24 high-order bits of b are ignored.

        true is acceptable for you.

        Specified by:
        write in class OutputStream
        Parameters:
        byteVal - An int which represents the byte value to write.

      • close

        public void close()
           throws IOException
        Closes this output stream and releases any system resources associated with this stream. If any data remains in the buffer it is committed to the service.
        Specified by:
        close in interface AutoCloseable
        Specified by:
        close in interface Closeable
        Overrides:
        close in class OutputStream
        Throws:
        IOException - If an I/O error occurs.