Package uk.org.esciencelab.researchobjectservice.serialization

Class StreamWithDigests

  • All Implemented Interfaces:
    java.io.Closeable, java.io.Flushable, java.lang.AutoCloseable
    public class StreamWithDigests
extends java.io.OutputStream
    A class to wrap an OutputStream and compute a set of digests whilst writing.

    • Constructor Summary

      Constructors 
      Constructor Description
      StreamWithDigests​(java.io.OutputStream out, java.lang.String[] algorithms)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void close()  
      void flush()  
      java.lang.String getDigest​(java.lang.String algorithm)
      Return the digest (as a hex string) for the given algorithm.
      long getLength()
      Return the number of bytes that were written.
      void write​(byte[] b)  
      void write​(byte[] b, int off, int len)  
      void write​(int i)  

      • Methods inherited from class java.io.OutputStream

        nullOutputStream

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • StreamWithDigests

        public StreamWithDigests​(java.io.OutputStream out,
                         java.lang.String[] algorithms)
                  throws java.security.NoSuchAlgorithmException
        Parameters:
        out - The actual output stream being wrapped.
        algorithms - An array of algorithm names.
        Throws:
        java.security.NoSuchAlgorithmException

    • Method Detail

      • write

        public void write​(byte[] b,
                  int off,
                  int len)
           throws java.io.IOException
        Overrides:
        write in class java.io.OutputStream
        Throws:
        java.io.IOException

      • write

        public void write​(int i)
           throws java.io.IOException
        Specified by:
        write in class java.io.OutputStream
        Throws:
        java.io.IOException

      • write

        public void write​(byte[] b)
           throws java.io.IOException
        Overrides:
        write in class java.io.OutputStream
        Throws:
        java.io.IOException

      • flush

        public void flush()
           throws java.io.IOException
        Specified by:
        flush in interface java.io.Flushable
        Overrides:
        flush in class java.io.OutputStream
        Throws:
        java.io.IOException

      • close

        public void close()
           throws java.io.IOException
        Specified by:
        close in interface java.lang.AutoCloseable
        Specified by:
        close in interface java.io.Closeable
        Overrides:
        close in class java.io.OutputStream
        Throws:
        java.io.IOException

      • getDigest

        public java.lang.String getDigest​(java.lang.String algorithm)
        Return the digest (as a hex string) for the given algorithm.
        Parameters:
        algorithm - The name of the algorithm.

      • getLength

        public long getLength()
        Return the number of bytes that were written.