DataEntry.java revision b9cc48a43ed984587c939d02fba5316bf5c0df6e 
1/*
2 * ProGuard -- shrinking, optimization, obfuscation, and preverification
3 *             of Java bytecode.
4 *
5 * Copyright (c) 2002-2013 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 * This interface describes a data entry, e.g. a ZIP entry, a file, or a
27 * directory.
28 *
29 * @author Eric Lafortune
30 */
31public interface DataEntry
32{
33    /**
34     * Returns the name of this data entry.
35     */
36    public String getName();
37
38    /**
39     * Returns whether the data entry represents a directory.
40     */
41    public boolean isDirectory();
42
43
44    /**
45     * Returns an input stream for reading the content of this data entry.
46     * The data entry may not represent a directory.
47     */
48    public InputStream getInputStream() throws IOException;
49
50
51    /**
52     * Closes the previously retrieved InputStream.
53     */
54    public void closeInputStream() throws IOException;
55
56
57    /**
58     * Returns the parent of this data entry, or <code>null</null> if it doesn't
59     * have one.
60     */
61    public DataEntry getParent();
62}
63