mirror of
https://codeberg.org/PGPainless/sop-java.git
synced 2024-09-27 10:39:32 +02:00
42 lines
1.5 KiB
Java
42 lines
1.5 KiB
Java
|
// SPDX-FileCopyrightText: 2021 Paul Schaub <vanitasvitae@fsfe.org>
|
||
|
//
|
||
|
// SPDX-License-Identifier: Apache-2.0
|
||
|
|
||
|
package sop;
|
||
|
|
||
|
import java.io.ByteArrayOutputStream;
|
||
|
import java.io.IOException;
|
||
|
import java.io.OutputStream;
|
||
|
|
||
|
import sop.exception.SOPGPException;
|
||
|
|
||
|
public abstract class ReadyWithResult<T> {
|
||
|
|
||
|
/**
|
||
|
* Write the data e.g. decrypted plaintext to the provided output stream and return the result of the
|
||
|
* processing operation.
|
||
|
*
|
||
|
* @param outputStream output stream
|
||
|
* @return result, eg. signatures
|
||
|
*
|
||
|
* @throws IOException in case of an IO error
|
||
|
* @throws SOPGPException.NoSignature if there are no valid signatures found
|
||
|
*/
|
||
|
public abstract T writeTo(OutputStream outputStream) throws IOException, SOPGPException.NoSignature;
|
||
|
|
||
|
/**
|
||
|
* Return the data as a {@link ByteArrayAndResult}.
|
||
|
* Calling {@link ByteArrayAndResult#getBytes()} will give you access to the data as byte array, while
|
||
|
* {@link ByteArrayAndResult#getResult()} will grant access to the appended result.
|
||
|
*
|
||
|
* @return byte array and result
|
||
|
* @throws IOException in case of an IO error
|
||
|
* @throws SOPGPException.NoSignature if there are no valid signatures found
|
||
|
*/
|
||
|
public ByteArrayAndResult<T> toByteArrayAndResult() throws IOException, SOPGPException.NoSignature {
|
||
|
ByteArrayOutputStream bytes = new ByteArrayOutputStream();
|
||
|
T result = writeTo(bytes);
|
||
|
return new ByteArrayAndResult<>(bytes.toByteArray(), result);
|
||
|
}
|
||
|
}
|