1/*
2 * ProGuard -- shrinking, optimization, obfuscation, and preverification
3 *             of Java bytecode.
4 *
5 * Copyright (c) 2002-2009 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 */
21package proguard.io;
22
23import 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 */
33public interface DataEntryWriter
34{
35    /**
36     * Creates a directory.
37     * @param dataEntry the data entry for which the directory is to be created.
38     * @return whether the directory has been created.
39     */
40    public boolean createDirectory(DataEntry dataEntry) throws IOException;
41
42
43    /**
44     * Returns an output stream for writing data. The caller must not close
45     * the output stream; closing the output stream is the responsibility of
46     * the implementation of this interface.
47     * @param dataEntry the data entry for which the output stream is to be created.
48     * @return the output stream. The stream may be <code>null</code> to indicate
49     *         that the data entry should not be written.
50     */
51    public OutputStream getOutputStream(DataEntry dataEntry) throws IOException;
52
53
54    /**
55     * Returns an output stream for writing data. The caller must not close
56     * the output stream; closing the output stream is the responsibility of
57     * the implementation of this interface.
58     * @param dataEntry the data entry for which the output stream is to be created.
59     * @param finisher  the optional finisher that will be called before this
60     *                  class closes the output stream (at some later point in
61     *                  time) that will be returned (now).
62     * @return the output stream. The stream may be <code>null</code> to indicate
63     *         that the data entry should not be written.
64     */
65    public OutputStream getOutputStream(DataEntry dataEntry,
66                                        Finisher  finisher) throws IOException;
67
68
69    /**
70     * Finishes writing all data entries.
71     */
72    public void close() throws IOException;
73}
74