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.property; 57 58 import org.apache.poi.poifs.filesystem.POIFSDocument; 59 60 /** 61 * Trivial extension of Property for POIFSDocuments 62 * 63 * @author Marc Johnson (mjohnson at apache dot org) 64 */ 65 66 public class DocumentProperty 67 extends Property 68 { 69 70 // the POIFSDocument this property is associated with 71 private POIFSDocument _document; 72 73 /** 74 * Constructor 75 * 76 * @param name POIFSDocument name 77 * @param size POIFSDocument size 78 */ 79 80 public DocumentProperty(final String name, final int size) 81 { 82 super(); 83 _document = null; 84 setName(name); 85 setSize(size); 86 setNodeColor(_NODE_BLACK); // simplification 87 setPropertyType(PropertyConstants.DOCUMENT_TYPE); 88 } 89 90 /** 91 * reader constructor 92 * 93 * @param index index number 94 * @param array byte data 95 * @param offset offset into byte data 96 */ 97 98 protected DocumentProperty(final int index, final byte [] array, 99 final int offset) 100 { 101 super(index, array, offset); 102 _document = null; 103 } 104 105 /** 106 * set the POIFSDocument 107 * 108 * @param doc the associated POIFSDocument 109 */ 110 111 public void setDocument(POIFSDocument doc) 112 { 113 _document = doc; 114 } 115 116 /** 117 * get the POIFSDocument 118 * 119 * @return the associated document 120 */ 121 122 public POIFSDocument getDocument() 123 { 124 return _document; 125 } 126 127 /* ********** START extension of Property ********** */ 128 129 /** 130 * give method more visibility 131 * 132 * @return true if this property should use small blocks 133 */ 134 135 public boolean shouldUseSmallBlocks() 136 { 137 return super.shouldUseSmallBlocks(); 138 } 139 140 /** 141 * @return true if a directory type Property 142 */ 143 144 public boolean isDirectory() 145 { 146 return false; 147 } 148 149 /** 150 * Perform whatever activities need to be performed prior to 151 * writing 152 */ 153 154 protected void preWrite() 155 { 156 157 // do nothing 158 } 159 160 /* ********** END extension of Property ********** */ 161 } // end public class DocumentProperty 162 163