1    
2    /* ====================================================================
3     * The Apache Software License, Version 1.1
4     *
5     * Copyright (c) 2002 The Apache Software Foundation.  All rights
6     * reserved.
7     *
8     * Redistribution and use in source and binary forms, with or without
9     * modification, are permitted provided that the following conditions
10    * are met:
11    *
12    * 1. Redistributions of source code must retain the above copyright
13    *    notice, this list of conditions and the following disclaimer.
14    *
15    * 2. Redistributions in binary form must reproduce the above copyright
16    *    notice, this list of conditions and the following disclaimer in
17    *    the documentation and/or other materials provided with the
18    *    distribution.
19    *
20    * 3. The end-user documentation included with the redistribution,
21    *    if any, must include the following acknowledgment:
22    *       "This product includes software developed by the
23    *        Apache Software Foundation (http://www.apache.org/)."
24    *    Alternately, this acknowledgment may appear in the software itself,
25    *    if and wherever such third-party acknowledgments normally appear.
26    *
27    * 4. The names "Apache" and "Apache Software Foundation" and
28    *    "Apache POI" must not be used to endorse or promote products
29    *    derived from this software without prior written permission. For
30    *    written permission, please contact apache@apache.org.
31    *
32    * 5. Products derived from this software may not be called "Apache",
33    *    "Apache POI", nor may "Apache" appear in their name, without
34    *    prior written permission of the Apache Software Foundation.
35    *
36    * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
37    * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
38    * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
39    * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
40    * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
41    * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
42    * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
43    * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
44    * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
45    * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
46    * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
47    * SUCH DAMAGE.
48    * ====================================================================
49    *
50    * This software consists of voluntary contributions made by many
51    * individuals on behalf of the Apache Software Foundation.  For more
52    * information on the Apache Software Foundation, please see
53    * <http://www.apache.org/>.
54    */
55   
56   package org.apache.poi.poifs.filesystem;
57   
58   import java.io.*;
59   
60   import java.util.*;
61   
62   /**
63    * This interface defines methods specific to Directory objects
64    * managed by a Filesystem instance.
65    *
66    * @author Marc Johnson (mjohnson at apache dot org)
67    */
68   
69   public interface DirectoryEntry
70       extends Entry
71   {
72   
73       /**
74        * get an iterator of the Entry instances contained directly in
75        * this instance (in other words, children only; no grandchildren
76        * etc.)
77        *
78        * @return iterator; never null, but hasNext() may return false
79        *         immediately (i.e., this DirectoryEntry is empty). All
80        *         objects retrieved by next() are guaranteed to be
81        *         implementations of Entry.
82        */
83   
84       public Iterator getEntries();
85   
86       /**
87        * is this DirectoryEntry empty?
88        *
89        * @return true if this instance contains no Entry instances
90        */
91   
92       public boolean isEmpty();
93   
94       /**
95        * find out how many Entry instances are contained directly within
96        * this DirectoryEntry
97        *
98        * @return number of immediately (no grandchildren etc.) contained
99        *         Entry instances
100       */
101  
102      public int getEntryCount();
103  
104      /**
105       * get a specified Entry by name
106       *
107       * @param name the name of the Entry to obtain.
108       *
109       * @return the specified Entry, if it is directly contained in
110       *         this DirectoryEntry
111       *
112       * @exception FileNotFoundException if no Entry with the specified
113       *            name exists in this DirectoryEntry
114       */
115  
116      public Entry getEntry(final String name)
117          throws FileNotFoundException;
118  
119      /**
120       * create a new DocumentEntry
121       *
122       * @param name the name of the new DocumentEntry
123       * @param stream the InputStream from which to create the new
124       *               DocumentEntry
125       *
126       * @return the new DocumentEntry
127       *
128       * @exception IOException
129       */
130  
131      public DocumentEntry createDocument(final String name,
132                                          final InputStream stream)
133          throws IOException;
134  
135      /**
136       * create a new DocumentEntry; the data will be provided later
137       *
138       * @param name the name of the new DocumentEntry
139       * @param size the size of the new DocumentEntry
140       * @param writer the writer of the new DocumentEntry
141       *
142       * @return the new DocumentEntry
143       *
144       * @exception IOException
145       */
146  
147      public DocumentEntry createDocument(final String name, final int size,
148                                          final POIFSWriterListener writer)
149          throws IOException;
150  
151      /**
152       * create a new DirectoryEntry
153       *
154       * @param name the name of the new DirectoryEntry
155       *
156       * @return the new DirectoryEntry
157       *
158       * @exception IOException
159       */
160  
161      public DirectoryEntry createDirectory(final String name)
162          throws IOException;
163  }   // end public interface DirectoryEntry
164  
165