Package org.pgpainless.util

Class ArmoredOutputStreamFactory

  • public final class ArmoredOutputStreamFactory
extends java.lang.Object
    Factory to create configured ArmoredOutputStreams. The configuration entails setting custom version and comment headers.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String PGPAINLESS  

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static org.bouncycastle.bcpg.ArmoredOutputStream get​(java.io.OutputStream outputStream)
      Wrap an OutputStream inside a preconfigured ArmoredOutputStream.
      static void resetComment()
      Reset to the default of no comment headers.
      static void resetVersionInfo()
      Reset the version header to its default value of PGPAINLESS.
      static void setComment​(java.lang.String commentString)
      Set a comment header value in the ASCII armor header.
      static void setVersionInfo​(java.lang.String versionString)
      Overwrite the version header of ASCII armors with a custom value.

      • Methods inherited from class java.lang.Object

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

    • Method Detail

      • get

        public static org.bouncycastle.bcpg.ArmoredOutputStream get​(java.io.OutputStream outputStream)
        Wrap an OutputStream inside a preconfigured ArmoredOutputStream.
        Parameters:
        outputStream - inner stream
        Returns:
        armored output stream

      • setVersionInfo

        public static void setVersionInfo​(java.lang.String versionString)
        Overwrite the version header of ASCII armors with a custom value. Newlines in the version info string result in multiple version header entries.
        Parameters:
        versionString - version string

      • resetVersionInfo

        public static void resetVersionInfo()
        Reset the version header to its default value of PGPAINLESS.

      • setComment

        public static void setComment​(java.lang.String commentString)
        Set a comment header value in the ASCII armor header. If the comment contains newlines, it will be split into multiple header entries.
        Parameters:
        commentString - comment

      • resetComment

        public static void resetComment()
        Reset to the default of no comment headers.