PGPainless/pgpainless
PGPainless/pgpainless
1
0
Fork 0
mirror of https://github.com/pgpainless/pgpainless.git synced 2024-11-23 12:52:07 +01:00
Code Issues Releases Wiki Activity

Add documentation to ArmoredOutputStreamFactory

Browse source
This commit is contained in:
Paul Schaub 2021-08-15 13:41:07 +02:00
parent fd867bbfbe
commit 66293bf333
Signed by: vanitasvitae
GPG key ID: 62BEE9264BF17311
1 changed files with 7 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
pgpainless-core/src/main/java/org/pgpainless/util/ArmoredOutputStreamFactory.java
View file

@ -21,6 +21,7 @@ import org.bouncycastle.bcpg.ArmoredOutputStream;
/**
* Factory to create configured {@link ArmoredOutputStream ArmoredOutputStreams}.
* The configuration entails setting custom version and comment headers.
*/
public class ArmoredOutputStreamFactory {
@ -28,6 +29,12 @@ public class ArmoredOutputStreamFactory {
private static String VERSION = PGPAINLESS;
public static String[] COMMENT = new String[0];
/**
* Wrap an {@link OutputStream} inside a preconfigured {@link ArmoredOutputStream}.
*
* @param outputStream inner stream
* @return armored output stream
*/
public static ArmoredOutputStream get(OutputStream outputStream) {
ArmoredOutputStream armoredOutputStream = new ArmoredOutputStream(outputStream);
armoredOutputStream.setHeader(ArmorUtils.HEADER_VERSION, VERSION);