Initial revision

git-svn-id: https://svn.apache.org/repos/asf/jakarta/poi/trunk@352063 13f79535-47bb-0310-9956-ffa450edef68

1 files changed, 127 insertions, 0 deletions

diff --git a/src/java/org/apache/poi/poifs/storage/BigBlock.java b/src/java/org/apache/poi/poifs/storage/BigBlock.java
new file mode 100644
index 0000000000..148cc0c384
--- /dev/null
+++ b/src/java/org/apache/poi/poifs/storage/BigBlock.java
@@ -0,0 +1,127 @@
+
+/* ====================================================================
+ * The Apache Software License, Version 1.1
+ *
+ * Copyright (c) 2002 The Apache Software Foundation.  All rights
+ * reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in
+ *    the documentation and/or other materials provided with the
+ *    distribution.
+ *
+ * 3. The end-user documentation included with the redistribution,
+ *    if any, must include the following acknowledgment:
+ *       "This product includes software developed by the
+ *        Apache Software Foundation (http://www.apache.org/)."
+ *    Alternately, this acknowledgment may appear in the software itself,
+ *    if and wherever such third-party acknowledgments normally appear.
+ *
+ * 4. The names "Apache" and "Apache Software Foundation" and
+ *    "Apache POI" must not be used to endorse or promote products
+ *    derived from this software without prior written permission. For
+ *    written permission, please contact apache@apache.org.
+ *
+ * 5. Products derived from this software may not be called "Apache",
+ *    "Apache POI", nor may "Apache" appear in their name, without
+ *    prior written permission of the Apache Software Foundation.
+ *
+ * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
+ * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+ * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
+ * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
+ * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
+ * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+ * SUCH DAMAGE.
+ * ====================================================================
+ *
+ * This software consists of voluntary contributions made by many
+ * individuals on behalf of the Apache Software Foundation.  For more
+ * information on the Apache Software Foundation, please see
+ * <http://www.apache.org/>.
+ */
+
+package org.apache.poi.poifs.storage;
+
+/**
+ * Abstract base class of all POIFS block storage classes. All
+ * extensions of BigBlock should write 512 bytes of data when
+ * requested to write their data.
+ *
+ * This class has package scope, as there is no reason at this time to
+ * make the class public.
+ *
+ * @author Marc Johnson (mjohnson at apache dot org)
+ */
+
+import java.io.IOException;
+import java.io.OutputStream;
+
+abstract class BigBlock
+    implements BlockWritable
+{
+
+    /**
+     * Default implementation of write for extending classes that
+     * contain their data in a simple array of bytes.
+     *
+     * @param stream the OutputStream to which the data should be
+     *               written.
+     * @param data the byte array of to be written.
+     *
+     * @exception IOException on problems writing to the specified
+     *            stream.
+     */
+
+    protected void doWriteData(final OutputStream stream, final byte [] data)
+        throws IOException
+    {
+        stream.write(data);
+    }
+
+    /**
+     * Write the block's data to an OutputStream
+     *
+     * @param stream the OutputStream to which the stored data should
+     *               be written
+     *
+     * @exception IOException on problems writing to the specified
+     *            stream
+     */
+
+    abstract void writeData(final OutputStream stream)
+        throws IOException;
+
+    /* ********** START implementation of BlockWritable ********** */
+
+    /**
+     * Write the storage to an OutputStream
+     *
+     * @param stream the OutputStream to which the stored data should
+     *               be written
+     *
+     * @exception IOException on problems writing to the specified
+     *            stream
+     */
+
+    public void writeBlocks(final OutputStream stream)
+        throws IOException
+    {
+        writeData(stream);
+    }
+
+    /* **********  END  implementation of BlockWritable ********** */
+}   // end abstract class BigBlock
+