proguard.io

Class ExtraDataEntryWriter

java.lang.Object

proguard.io.ExtraDataEntryWriter

All Implemented Interfaces:

DataEntryWriter

public class ExtraDataEntryWriter
extends Object
implements DataEntryWriter

This DataEntryWriter writes out all data entries to a delegate DataEntryWriter, inserting additional data entries that are attached to the written data entry. The output stream of the additional data entry is not used.

Author:

Eric Lafortune

Constructor Summary

Constructors

Constructor and Description
ExtraDataEntryWriter(MultiValueMap<String,String> extraEntryNameMap, DataEntryWriter dataEntryWriter, DataEntryWriter extraDataEntryWriter, String entrySuffix) Creates a new ExtraDataEntryWriter.
ExtraDataEntryWriter(String extraEntryName, DataEntryWriter dataEntryWriter) Creates a new ExtraDataEntryWriter that writes one given extra data entry together with the first data entry that is written.
ExtraDataEntryWriter(String extraEntryName, DataEntryWriter dataEntryWriter, DataEntryWriter extraDataEntryWriter) Creates a new ExtraDataEntryWriter that writes one given extra data entry together with the first data entry that is written.

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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ExtraDataEntryWriter

public ExtraDataEntryWriter(String extraEntryName,
                            DataEntryWriter dataEntryWriter)

Creates a new ExtraDataEntryWriter that writes one given extra data entry together with the first data entry that is written.

Parameters:

extraEntryName - the name of the extra data entry.

dataEntryWriter - the writer to which the entries are written, including the extra data entry.

ExtraDataEntryWriter

public ExtraDataEntryWriter(String extraEntryName,
                            DataEntryWriter dataEntryWriter,
                            DataEntryWriter extraDataEntryWriter)

Creates a new ExtraDataEntryWriter that writes one given extra data entry together with the first data entry that is written.

Parameters:

extraEntryName - the name of the extra data entry.

dataEntryWriter - the writer to which the entries are written.

extraDataEntryWriter - the writer to which the extra data entry will be written.

ExtraDataEntryWriter

public ExtraDataEntryWriter(MultiValueMap<String,String> extraEntryNameMap,
                            DataEntryWriter dataEntryWriter,
                            DataEntryWriter extraDataEntryWriter,
                            String entrySuffix)

Creates a new ExtraDataEntryWriter.

Parameters:

extraEntryNameMap - a map with data entry names and their associated extra data entries. An extra data entry that is associated with multiple entries is only written once.

dataEntryWriter - the writer to which the entries are written.

extraDataEntryWriter - the writer to which the extra data entry will be written.

entrySuffix - an optional file suffix. It is stripped from the entry name when looking up the entry in the map, and added to all extra entry names.

Method Detail

createDirectory

public boolean createDirectory(DataEntry dataEntry)
                        throws IOException

Description copied from interface: DataEntryWriter

Creates a directory.

Specified by:

createDirectory in interface DataEntryWriter

Parameters:

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

Returns:

whether the directory has been created.

Throws:

IOException

sameOutputStream

public boolean sameOutputStream(DataEntry dataEntry1,
                                DataEntry dataEntry2)
                         throws IOException

Description copied from interface: DataEntryWriter

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

Specified by:

sameOutputStream in interface DataEntryWriter

Parameters:

dataEntry1 - the first data entry.

dataEntry2 - the second data entry.

Throws:

IOException

createOutputStream

public OutputStream createOutputStream(DataEntry dataEntry)
                                throws IOException

Description copied from interface: DataEntryWriter

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

Specified by:

createOutputStream in interface DataEntryWriter

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

public void close()
           throws IOException

Description copied from interface: DataEntryWriter

Finishes writing all data entries.

Specified by:

close in interface DataEntryWriter

Throws:

IOException

println

public void println(PrintWriter pw,
                    String prefix)

Description copied from interface: DataEntryWriter

Prints out the structure of the data entry writer.

Specified by:

println in interface DataEntryWriter

Parameters:

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

prefix - a prefix for every printed line.