| |
| /* ==================================================================== |
| * The Apache Software License, Version 1.1 |
| * |
| * Copyright (c) 2003 The Apache Software Foundation. All rights |
| * reserved. |
| * |
| * Redistribution and use in source and binary forms, with or without |
| * modification, are permitted provided that the following conditions |
| * are met: |
| * |
| * 1. Redistributions of source code must retain the above copyright |
| * notice, this list of conditions and the following disclaimer. |
| * |
| * 2. Redistributions in binary form must reproduce the above copyright |
| * notice, this list of conditions and the following disclaimer in |
| * the documentation and/or other materials provided with the |
| * distribution. |
| * |
| * 3. The end-user documentation included with the redistribution, |
| * if any, must include the following acknowledgment: |
| * "This product includes software developed by the |
| * Apache Software Foundation (http://www.apache.org/)." |
| * Alternately, this acknowledgment may appear in the software itself, |
| * if and wherever such third-party acknowledgments normally appear. |
| * |
| * 4. The names "Apache" and "Apache Software Foundation" and |
| * "Apache POI" must not be used to endorse or promote products |
| * derived from this software without prior written permission. For |
| * written permission, please contact apache@apache.org. |
| * |
| * 5. Products derived from this software may not be called "Apache", |
| * "Apache POI", nor may "Apache" appear in their name, without |
| * prior written permission of the Apache Software Foundation. |
| * |
| * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED |
| * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES |
| * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE |
| * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR |
| * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
| * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
| * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF |
| * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND |
| * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, |
| * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT |
| * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF |
| * SUCH DAMAGE. |
| * ==================================================================== |
| * |
| * This software consists of voluntary contributions made by many |
| * individuals on behalf of the Apache Software Foundation. For more |
| * information on the Apache Software Foundation, please see |
| * <http://www.apache.org/>. |
| */ |
| |
| package org.apache.poi.poifs.filesystem; |
| |
| import java.io.*; |
| |
| import java.util.*; |
| |
| import org.apache.poi.hpsf.ClassID; |
| |
| /** |
| * This interface defines methods specific to Directory objects |
| * managed by a Filesystem instance. |
| * |
| * @author Marc Johnson (mjohnson at apache dot org) |
| */ |
| |
| public interface DirectoryEntry |
| extends Entry |
| { |
| |
| /** |
| * get an iterator of the Entry instances contained directly in |
| * this instance (in other words, children only; no grandchildren |
| * etc.) |
| * |
| * @return iterator; never null, but hasNext() may return false |
| * immediately (i.e., this DirectoryEntry is empty). All |
| * objects retrieved by next() are guaranteed to be |
| * implementations of Entry. |
| */ |
| |
| public Iterator getEntries(); |
| |
| /** |
| * is this DirectoryEntry empty? |
| * |
| * @return true if this instance contains no Entry instances |
| */ |
| |
| public boolean isEmpty(); |
| |
| /** |
| * find out how many Entry instances are contained directly within |
| * this DirectoryEntry |
| * |
| * @return number of immediately (no grandchildren etc.) contained |
| * Entry instances |
| */ |
| |
| public int getEntryCount(); |
| |
| /** |
| * get a specified Entry by name |
| * |
| * @param name the name of the Entry to obtain. |
| * |
| * @return the specified Entry, if it is directly contained in |
| * this DirectoryEntry |
| * |
| * @exception FileNotFoundException if no Entry with the specified |
| * name exists in this DirectoryEntry |
| */ |
| |
| public Entry getEntry(final String name) |
| throws FileNotFoundException; |
| |
| /** |
| * create a new DocumentEntry |
| * |
| * @param name the name of the new DocumentEntry |
| * @param stream the InputStream from which to create the new |
| * DocumentEntry |
| * |
| * @return the new DocumentEntry |
| * |
| * @exception IOException |
| */ |
| |
| public DocumentEntry createDocument(final String name, |
| final InputStream stream) |
| throws IOException; |
| |
| /** |
| * create a new DocumentEntry; the data will be provided later |
| * |
| * @param name the name of the new DocumentEntry |
| * @param size the size of the new DocumentEntry |
| * @param writer the writer of the new DocumentEntry |
| * |
| * @return the new DocumentEntry |
| * |
| * @exception IOException |
| */ |
| |
| public DocumentEntry createDocument(final String name, final int size, |
| final POIFSWriterListener writer) |
| throws IOException; |
| |
| /** |
| * create a new DirectoryEntry |
| * |
| * @param name the name of the new DirectoryEntry |
| * |
| * @return the new DirectoryEntry |
| * |
| * @exception IOException |
| */ |
| |
| public DirectoryEntry createDirectory(final String name) |
| throws IOException; |
| |
| /** |
| * Gets the storage clsid of the directory entry |
| * |
| * @return storage Class ID |
| */ |
| public ClassID getStorageClsid(); |
| |
| /** |
| * Sets the storage clsid for the directory entry |
| * |
| * @param clsidStorage storage Class ID |
| */ |
| public void setStorageClsid(ClassID clsidStorage); |
| |
| } // end public interface DirectoryEntry |
| |