proguard.io

Interface DataEntryWriter

All Superinterfaces:

java.lang.AutoCloseable

All Known Implementing Classes:

CascadingDataEntryWriter, ClassDataEntryWriter, ClassMapDataEntryWriter, DirectoryWriter, FilteredDataEntryWriter, FixedFileWriter, JarWriter, KotlinModuleDataEntryWriter, NameFilteredDataEntryWriter, NonClosingDataEntryWriter, ParentDataEntryWriter, PrefixAddingDataEntryWriter, RenamedDataEntryWriter, RenamedParentDataEntryWriter, SignedJarWriter, ZipWriter

public interface DataEntryWriter
extends java.lang.AutoCloseable

This interface provides methods for writing data entries, such as ZIP entries or files. The implementation determines to which type of data entry the data will be written.

Method Summary

Modifier and Type	Method and Description
void	close() Finishes writing all data entries.
boolean	createDirectory(DataEntry dataEntry) Creates a directory.
java.io.OutputStream	createOutputStream(DataEntry dataEntry) Creates a new output stream for writing data.
void	println(java.io.PrintWriter pw, java.lang.String prefix) Prints out the structure of the data entry writer.
boolean	sameOutputStream(DataEntry dataEntry1, DataEntry dataEntry2) Returns whether the two given data entries would result in the same output stream.

Method Detail

createDirectory

boolean createDirectory(DataEntry dataEntry)
                 throws java.io.IOException

Creates a directory.

Parameters:

dataEntry - the data entry for which the directory is to be created.

Returns:

whether the directory has been created.

Throws:

java.io.IOException

sameOutputStream

boolean sameOutputStream(DataEntry dataEntry1,
                         DataEntry dataEntry2)
                  throws java.io.IOException

Returns whether the two given data entries would result in the same output stream.

Parameters:

dataEntry1 - the first data entry.

dataEntry2 - the second data entry.

Throws:

java.io.IOException

createOutputStream

java.io.OutputStream createOutputStream(DataEntry dataEntry)
                                 throws java.io.IOException

Creates a new output stream for writing data. The caller is responsible for closing the stream.

Parameters:

dataEntry - the data entry for which the output stream is to be created.

Returns:

the output stream. The stream may be null to indicate that the data entry should not be written.

Throws:

java.io.IOException

close

void close()
    throws java.io.IOException

Finishes writing all data entries.

Implementations typically create graphs of writers that can split and merge again, possibly even with cycles.

For splits and merges, implementations need to be idempotent; once closed, subsequent attempts to close a writer have no effect. If needed, the wrapper NonClosingDataEntryWriter can avoid closing a branch prematurely.

For cycles, implementations must perform any custom behavior, then delegate close() invocations, and only finally clean up. It is possible that delegates call createOutputStream(DataEntry) while close() is in progress.

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException

println

void println(java.io.PrintWriter pw,
             java.lang.String prefix)

Prints out the structure of the data entry writer.

Parameters:

pw - the print stream to which the structure should be printed.

prefix - a prefix for every printed line.