KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > proguard > io > DataEntryWriter


1 /*
2  * ProGuard -- shrinking, optimization, obfuscation, and preverification
3  * of Java bytecode.
4  *
5  * Copyright (c) 2002-2007 Eric Lafortune (eric@graphics.cornell.edu)
6  *
7  * This program is free software; you can redistribute it and/or modify it
8  * under the terms of the GNU General Public License as published by the Free
9  * Software Foundation; either version 2 of the License, or (at your option)
10  * any later version.
11  *
12  * This program is distributed in the hope that it will be useful, but WITHOUT
13  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
14  * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
15  * more details.
16  *
17  * You should have received a copy of the GNU General Public License along
18  * with this program; if not, write to the Free Software Foundation, Inc.,
19  * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20  */
21 package proguard.io;
22
23 import java.io.*;
24
25
26 /**
27  * This interface provides methods for writing data entries, such as ZIP entries
28  * or files. The implementation determines to which type of data entry the
29  * data will be written.
30  *
31  * @author Eric Lafortune
32  */
33 public interface DataEntryWriter
34 {
35     /**
36      * Returns an output stream for writing data. The caller must not close
37      * the output stream; closing the output stream is the responsibility of
38      * the implementation of this interface.
39      * @param dataEntry the data entry for which the output stream is to be created.
40      * @return the output stream. The stream may be <code>null</code> to indicate
41      * that the data entry should not be written.
42      */
43     public OutputStream getOutputStream(DataEntry dataEntry) throws IOException;
44
45
46     /**
47      * Returns an output stream for writing data. The caller must not close
48      * the output stream; closing the output stream is the responsibility of
49      * the implementation of this interface.
50      * @param dataEntry the data entry for which the output stream is to be created.
51      * @param finisher the optional finisher that will be called before this
52      * class closes the output stream (at some later point in
53      * time) that will be returned (now).
54      * @return the output stream. The stream may be <code>null</code> to indicate
55      * that the data entry should not be written.
56      */
57     public OutputStream getOutputStream(DataEntry dataEntry,
58                                         Finisher finisher) throws IOException;
59
60
61     /**
62      * Finishes writing all data entries.
63      */
64     public void close() throws IOException;
65 }
66
Popular Tags