org.apache.poi.xslf.usermodel.XSLFObjectData Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of apache-poi-ooxml 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.

The 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.xslf.usermodel;

import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;

import org.apache.poi.ooxml.POIXMLDocumentPart;
import org.apache.poi.openxml4j.opc.PackagePart;
import org.apache.poi.sl.usermodel.ObjectData;
import org.apache.poi.util.Beta;

/**
 * An XSLFOleData instance holds the ole binary stream/object  
 */
@SuppressWarnings("unused")
@Beta
public final class XSLFObjectData extends POIXMLDocumentPart implements ObjectData {

    /**
     * Create a new XSLFObjectData node
     */
    /* package */ XSLFObjectData() {
        super();
    }

    /**
     * Construct XSLFObjectData from a package part
     *
     * @param part the package part holding the ole data
     * 
     * @since POI 3.14-Beta1
     */
    public XSLFObjectData(final PackagePart part) {
        super(part);
    }    

    @Override
    public InputStream getInputStream() throws IOException {
        return getPackagePart().getInputStream();
    }

    @Override
    public OutputStream getOutputStream() {
        final PackagePart pp = getPackagePart();
        pp.clear();
        return pp.getOutputStream();
    }
    
    /**
     * XSLFObjectData objects store the actual content in the part directly without keeping a
     * copy like all others therefore we need to handle them differently.
     */
    @Override
    protected void prepareForCommit() {
        // do not clear the part here
    }


    public void setData(final byte[] data) throws IOException {
        try (final OutputStream os = getPackagePart().getOutputStream()) {
            os.write(data);
        }
    }

    @Override
    public String getOLE2ClassName() {
        return null;
    }

    @Override
    public String getFileName() {
        return null;
    }
}