Package org.pgpainless.util
Class ArmoredOutputStreamFactory
java.lang.Object
org.pgpainless.util.ArmoredOutputStreamFactory
Factory to create configured
ArmoredOutputStreams
.
The configuration entails setting custom version and comment headers.-
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionstatic org.bouncycastle.bcpg.ArmoredOutputStream
get
(OutputStream outputStream) Wrap anOutputStream
inside a preconfiguredArmoredOutputStream
.static org.bouncycastle.bcpg.ArmoredOutputStream
get
(OutputStream outputStream, ProducerOptions options) static void
Reset to the default of no comment headers.static void
Reset the version header to its default value ofPGPAINLESS
.static void
setComment
(String commentString) Set a comment header value in the ASCII armor header.static void
setVersionInfo
(String versionString) Overwrite the version header of ASCII armors with a custom value.
-
Field Details
-
PGPAINLESS
- See Also:
-
-
Method Details
-
get
Wrap anOutputStream
inside a preconfiguredArmoredOutputStream
.- Parameters:
outputStream
- inner stream- Returns:
- armored output stream
-
get
public static org.bouncycastle.bcpg.ArmoredOutputStream get(OutputStream outputStream, ProducerOptions options) -
setVersionInfo
Overwrite the version header of ASCII armors with a custom value. Newlines in the version info string result in multiple version header entries. If this is set tonull
, then the version header is omitted altogether.- Parameters:
versionString
- version string
-
resetVersionInfo
public static void resetVersionInfo()Reset the version header to its default value ofPGPAINLESS
. -
setComment
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- See Also:
-
resetComment
public static void resetComment()Reset to the default of no comment headers.
-