proguard.io

Interface DataEntryWriter

All Known Implementing Classes:

CascadingDataEntryWriter, ClassDataEntryWriter, ClassMapDataEntryWriter, DirectoryWriter, ExtraDataEntryWriter, FilteredDataEntryWriter, JarWriter, NameFilteredDataEntryWriter, ParentDataEntryWriter, PrefixAddingDataEntryWriter, RenamedDataEntryWriter, RenamedParentDataEntryWriter

public interface DataEntryWriter

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.

Author:

Eric Lafortune

Method Summary

Modifier and Type	Method and Description
void	close() Finishes writing all data entries.
boolean	createDirectory(DataEntry dataEntry) Creates a directory.
OutputStream	createOutputStream(DataEntry dataEntry) Creates a new output stream for writing data.
void	println(PrintWriter pw, 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 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:

IOException

sameOutputStream

boolean sameOutputStream(DataEntry dataEntry1,
                         DataEntry dataEntry2)
                  throws 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:

IOException

createOutputStream

OutputStream createOutputStream(DataEntry dataEntry)
                         throws 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:

IOException

close

void close()
    throws IOException

Finishes writing all data entries.

Throws:

IOException

println

void println(PrintWriter pw,
             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.