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 /** 59 * This interface provides access to an object managed by a Filesystem 60 * instance. Entry objects are further divided into DocumentEntry and 61 * DirectoryEntry instances. 62 * 63 * @author Marc Johnson (mjohnson at apache dot org) 64 */ 65 66 public interface Entry 67 { 68 69 /** 70 * get the name of the Entry 71 * 72 * @return name 73 */ 74 75 public String getName(); 76 77 /** 78 * is this a DirectoryEntry? 79 * 80 * @return true if the Entry is a DirectoryEntry, else false 81 */ 82 83 public boolean isDirectoryEntry(); 84 85 /** 86 * is this a DocumentEntry? 87 * 88 * @return true if the Entry is a DocumentEntry, else false 89 */ 90 91 public boolean isDocumentEntry(); 92 93 /** 94 * get this Entry's parent (the DirectoryEntry that owns this 95 * Entry). All Entry objects, except the root Entry, has a parent. 96 * 97 * @return this Entry's parent; null iff this is the root Entry 98 */ 99 100 public DirectoryEntry getParent(); 101 102 /** 103 * Delete this Entry. This operation should succeed, but there are 104 * special circumstances when it will not: 105 * 106 * If this Entry is the root of the Entry tree, it cannot be 107 * deleted, as there is no way to create another one. 108 * 109 * If this Entry is a directory, it cannot be deleted unless it is 110 * empty. 111 * 112 * @return true if the Entry was successfully deleted, else false 113 */ 114 115 public boolean delete(); 116 117 /** 118 * Rename this Entry. This operation will fail if: 119 * 120 * There is a sibling Entry (i.e., an Entry whose parent is the 121 * same as this Entry's parent) with the same name. 122 * 123 * This Entry is the root of the Entry tree. Its name is dictated 124 * by the Filesystem and many not be changed. 125 * 126 * @param newName the new name for this Entry 127 * 128 * @return true if the operation succeeded, else false 129 */ 130 131 public boolean renameTo(final String newName); 132 } // end public interface Entry 133 134