org.apache.poi.POIReadOnlyDocument Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of apache-poi Show documentation

The Apache Commons Codec package contains simple encoder and decoders for various formats such as Base64 and Hexadecimal. In addition to these widely used encoders and decoders, the codec package also maintains a collection of phonetic encoding utilities.

There is a newer version: 62

Show newest version

/* ====================================================================
   Licensed to the Apache Software Foundation (ASF) under one or more
   contributor license agreements.  See the NOTICE file distributed with
   this work for additional information regarding copyright ownership.
   The ASF licenses this file to You under the Apache License, Version 2.0
   (the "License"); you may not use this file except in compliance with
   the License.  You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.
==================================================================== */
package org.apache.poi;

import java.io.File;
import java.io.OutputStream;

import org.apache.poi.poifs.filesystem.DirectoryNode;
import org.apache.poi.poifs.filesystem.POIFSFileSystem;


/**
 * This holds the common functionality for all read-only
 *  POI Document classes, i.e. ones which don't support writing.
 *
 *  @since POI 3.15 beta 3
 */
public abstract class POIReadOnlyDocument extends POIDocument {
    protected POIReadOnlyDocument(DirectoryNode dir) {
        super(dir);
    }
    protected POIReadOnlyDocument(POIFSFileSystem fs) {
        super(fs);
    }

    /**
     * Note - writing is not yet supported for this file format, sorry.
     *
     * @throws IllegalStateException If you call the method, as writing is not supported
     */
    @Override
    public void write() {
        notImplemented();
    }
    /**
     * Note - writing is not yet supported for this file format, sorry.
     *
     * @throws IllegalStateException If you call the method, as writing is not supported
     */
    @Override
    public void write(File file) {
        notImplemented();
    }
    /**
     * Note - writing is not yet supported for this file format, sorry.
     *
     * @throws IllegalStateException If you call the method, as writing is not supported
     */
    @Override
    public void write(OutputStream out) {
        notImplemented();
    }

    private static void notImplemented() {
        throw new IllegalStateException("Writing is not yet implemented for this Document Format");
    }
}