Package com.cloudbees.jenkins.support.util

Interface WrapperOutputStream

All Known Implementing Classes:

IgnoreCloseOutputStream, OutputStreamSelector

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public interface WrapperOutputStream

Allows for nested OutputStream wrappers and getting access to the unwrapped stream.

Since:

TODO

Method Summary

Modifier and Type	Method	Description
OutputStream	unwrap()	Unwraps this stream, potentially forcing unwritten data to be flushed.
default OutputStream	unwrapRecursively()	Unwraps this stream, recursively descending through any further WrapperOutputStream instances.

Method Details

unwrap

@NonNull
OutputStream unwrap()
             throws IOException

Unwraps this stream, potentially forcing unwritten data to be flushed.

Returns:

the underlying stream being wrapped

Throws:

IOException - if an exception occurs preparing the unwrapped reference

IllegalStateException - if this stream is closed

unwrapRecursively

@NonNull
default OutputStream unwrapRecursively()
                                throws IOException

Unwraps this stream, recursively descending through any further WrapperOutputStream instances.

Returns:

the underlying stream being wrapped

Throws:

IOException - if an exception occurs during any unwrap stage

IllegalStateException - if this stream is closed