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.storage; 57 58 import java.io.*; 59 60 import java.util.*; 61 62 import org.apache.poi.poifs.common.POIFSConstants; 63 import org.apache.poi.poifs.property.Property; 64 import org.apache.poi.util.IntegerField; 65 import org.apache.poi.util.LittleEndian; 66 import org.apache.poi.util.LittleEndianConsts; 67 68 /** 69 * A block of Property instances 70 * 71 * @author Marc Johnson (mjohnson at apache dot org) 72 */ 73 74 public class PropertyBlock 75 extends BigBlock 76 { 77 private static final int _properties_per_block = 78 POIFSConstants.BIG_BLOCK_SIZE / POIFSConstants.PROPERTY_SIZE; 79 private Property[] _properties; 80 81 /** 82 * Create a single instance initialized with default values 83 * 84 * @param properties the properties to be inserted 85 * @param offset the offset into the properties array 86 */ 87 88 private PropertyBlock(final Property [] properties, final int offset) 89 { 90 _properties = new Property[ _properties_per_block ]; 91 for (int j = 0; j < _properties_per_block; j++) 92 { 93 _properties[ j ] = properties[ j + offset ]; 94 } 95 } 96 97 /** 98 * Create an array of PropertyBlocks from an array of Property 99 * instances, creating empty Property instances to make up any 100 * shortfall 101 * 102 * @param properties the Property instances to be converted into 103 * PropertyBlocks, in a java List 104 * 105 * @return the array of newly created PropertyBlock instances 106 */ 107 108 public static BlockWritable [] createPropertyBlockArray( 109 final List properties) 110 { 111 int block_count = 112 (properties.size() + _properties_per_block - 1) 113 / _properties_per_block; 114 Property[] to_be_written = 115 new Property[ block_count * _properties_per_block ]; 116 117 System.arraycopy(properties.toArray(new Property[ 0 ]), 0, 118 to_be_written, 0, properties.size()); 119 for (int j = properties.size(); j < to_be_written.length; j++) 120 { 121 122 // create an instance of an anonymous inner class that 123 // extends Property 124 to_be_written[ j ] = new Property() 125 { 126 protected void preWrite() 127 { 128 } 129 130 public boolean isDirectory() 131 { 132 return false; 133 } 134 }; 135 } 136 BlockWritable[] rvalue = new BlockWritable[ block_count ]; 137 138 for (int j = 0; j < block_count; j++) 139 { 140 rvalue[ j ] = new PropertyBlock(to_be_written, 141 j * _properties_per_block); 142 } 143 return rvalue; 144 } 145 146 /* ********** START extension of BigBlock ********** */ 147 148 /** 149 * Write the block's data to an OutputStream 150 * 151 * @param stream the OutputStream to which the stored data should 152 * be written 153 * 154 * @exception IOException on problems writing to the specified 155 * stream 156 */ 157 158 void writeData(final OutputStream stream) 159 throws IOException 160 { 161 for (int j = 0; j < _properties_per_block; j++) 162 { 163 _properties[ j ].writeData(stream); 164 } 165 } 166 167 /* ********** END extension of BigBlock ********** */ 168 } // end public class PropertyBlock 169 170