mirror of
https://github.com/pgpainless/pgpainless.git
synced 2024-06-27 22:14:50 +02:00
Add javadoc to getMetadata() and getResult()
This commit is contained in:
parent
33d9a784bb
commit
70cca563d7
|
@ -8,8 +8,21 @@ import java.io.InputStream;
|
||||||
|
|
||||||
public abstract class DecryptionStream extends InputStream {
|
public abstract class DecryptionStream extends InputStream {
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Return {@link MessageMetadata metadata} about the decrypted / verified message.
|
||||||
|
* The {@link DecryptionStream} MUST be closed via {@link #close()} before the metadata object can be accessed.
|
||||||
|
*
|
||||||
|
* @return message metadata
|
||||||
|
*/
|
||||||
public abstract MessageMetadata getMetadata();
|
public abstract MessageMetadata getMetadata();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Return a {@link OpenPgpMetadata} object containing information about the decrypted / verified message.
|
||||||
|
* The {@link DecryptionStream} MUST be closed via {@link #close()} before the metadata object can be accessed.
|
||||||
|
*
|
||||||
|
* @return message metadata
|
||||||
|
* @deprecated use {@link #getMetadata()} instead.
|
||||||
|
*/
|
||||||
@Deprecated
|
@Deprecated
|
||||||
public OpenPgpMetadata getResult() {
|
public OpenPgpMetadata getResult() {
|
||||||
return getMetadata().toLegacyMetadata();
|
return getMetadata().toLegacyMetadata();
|
||||||
|
|
Loading…
Reference in a new issue