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 /** 59 * Abstract base class of all POIFS block storage classes. All 60 * extensions of BigBlock should write 512 bytes of data when 61 * requested to write their data. 62 * 63 * This class has package scope, as there is no reason at this time to 64 * make the class public. 65 * 66 * @author Marc Johnson (mjohnson at apache dot org) 67 */ 68 69 import java.io.IOException; 70 import java.io.OutputStream; 71 72 abstract class BigBlock 73 implements BlockWritable 74 { 75 76 /** 77 * Default implementation of write for extending classes that 78 * contain their data in a simple array of bytes. 79 * 80 * @param stream the OutputStream to which the data should be 81 * written. 82 * @param data the byte array of to be written. 83 * 84 * @exception IOException on problems writing to the specified 85 * stream. 86 */ 87 88 protected void doWriteData(final OutputStream stream, final byte [] data) 89 throws IOException 90 { 91 stream.write(data); 92 } 93 94 /** 95 * Write the block's data to an OutputStream 96 * 97 * @param stream the OutputStream to which the stored data should 98 * be written 99 * 100 * @exception IOException on problems writing to the specified 101 * stream 102 */ 103 104 abstract void writeData(final OutputStream stream) 105 throws IOException; 106 107 /* ********** START implementation of BlockWritable ********** */ 108 109 /** 110 * Write the storage to an OutputStream 111 * 112 * @param stream the OutputStream to which the stored data should 113 * be written 114 * 115 * @exception IOException on problems writing to the specified 116 * stream 117 */ 118 119 public void writeBlocks(final OutputStream stream) 120 throws IOException 121 { 122 writeData(stream); 123 } 124 125 /* ********** END implementation of BlockWritable ********** */ 126 } // end abstract class BigBlock 127 128