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 * Class DocumentDescriptor 60 * 61 * @author Marc Johnson (mjohnson at apache dot org) 62 * @version %I%, %G% 63 */ 64 65 public class DocumentDescriptor 66 { 67 private POIFSDocumentPath path; 68 private String name; 69 private int hashcode = 0; 70 71 /** 72 * Trivial constructor 73 * 74 * @param path the Document path 75 * @param name the Document name 76 */ 77 78 public DocumentDescriptor(final POIFSDocumentPath path, final String name) 79 { 80 if (path == null) 81 { 82 throw new NullPointerException("path must not be null"); 83 } 84 if (name == null) 85 { 86 throw new NullPointerException("name must not be null"); 87 } 88 if (name.length() == 0) 89 { 90 throw new IllegalArgumentException("name cannot be empty"); 91 } 92 this.path = path; 93 this.name = name; 94 } 95 96 /** 97 * equality. Two DocumentDescriptor instances are equal if they 98 * have equal paths and names 99 * 100 * @param o the object we're checking equality for 101 * 102 * @return true if the object is equal to this object 103 */ 104 105 public boolean equals(final Object o) 106 { 107 boolean rval = false; 108 109 if ((o != null) && (o.getClass() == this.getClass())) 110 { 111 if (this == o) 112 { 113 rval = true; 114 } 115 else 116 { 117 DocumentDescriptor descriptor = ( DocumentDescriptor ) o; 118 119 rval = this.path.equals(descriptor.path) 120 && this.name.equals(descriptor.name); 121 } 122 } 123 return rval; 124 } 125 126 /** 127 * calculate and return the hashcode 128 * 129 * @return hashcode 130 */ 131 132 public int hashCode() 133 { 134 if (hashcode == 0) 135 { 136 hashcode = path.hashCode() ^ name.hashCode(); 137 } 138 return hashcode; 139 } 140 141 public String toString() 142 { 143 StringBuffer buffer = new StringBuffer(40 * (path.length() + 1)); 144 145 for (int j = 0; j < path.length(); j++) 146 { 147 buffer.append(path.getComponent(j)).append("/"); 148 } 149 buffer.append(name); 150 return buffer.toString(); 151 } 152 } // end public class DocumentDescriptor 153 154