proguard.io

Class FilteredDataEntryWriter

java.lang.Object

proguard.io.FilteredDataEntryWriter

All Implemented Interfaces:

java.lang.AutoCloseable, DataEntryWriter

Direct Known Subclasses:

NameFilteredDataEntryWriter

public class FilteredDataEntryWriter
extends java.lang.Object
implements DataEntryWriter

This DataEntryWriter delegates to one of two other DataEntryWriter instances, depending on whether the data entry passes through a given data entry filter or not.

Constructor Summary

Constructors

Constructor and Description
FilteredDataEntryWriter(DataEntryFilter dataEntryFilter, DataEntryWriter acceptedDataEntryWriter) Creates a new FilteredDataEntryWriter with only a writer for accepted data entries.
FilteredDataEntryWriter(DataEntryFilter dataEntryFilter, DataEntryWriter acceptedDataEntryWriter, DataEntryWriter rejectedDataEntryWriter) Creates a new FilteredDataEntryWriter.

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

FilteredDataEntryWriter

public FilteredDataEntryWriter(DataEntryFilter dataEntryFilter,
                               DataEntryWriter acceptedDataEntryWriter)

Creates a new FilteredDataEntryWriter with only a writer for accepted data entries.

Parameters:

dataEntryFilter - the data entry filter.

acceptedDataEntryWriter - the DataEntryWriter to which the writing will be delegated if the filter accepts the data entry. May be null.

FilteredDataEntryWriter

public FilteredDataEntryWriter(DataEntryFilter dataEntryFilter,
                               DataEntryWriter acceptedDataEntryWriter,
                               DataEntryWriter rejectedDataEntryWriter)

Creates a new FilteredDataEntryWriter.

Parameters:

dataEntryFilter - the data entry filter.

acceptedDataEntryWriter - the DataEntryWriter to which the writing will be delegated if the filter accepts the data entry. May be null.

rejectedDataEntryWriter - the DataEntryWriter to which the writing will be delegated if the filter does not accept the data entry. May be null.

Method Detail

createDirectory

public boolean createDirectory(DataEntry dataEntry)
                        throws java.io.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:

java.io.IOException

sameOutputStream

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

java.io.IOException

createOutputStream

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

java.io.IOException

close

public void close()
           throws java.io.IOException

Description copied from interface: DataEntryWriter

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 DataEntryWriter.close() invocations, and only finally clean up. It is possible that delegates call DataEntryWriter.createOutputStream(DataEntry) while DataEntryWriter.close() is in progress.

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface DataEntryWriter

Throws:

java.io.IOException

println

public void println(java.io.PrintWriter pw,
                    java.lang.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.