de.intarsys.pdf.pd.PDEmbeddedFile Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jpod Show documentation
This is a fork of http://sourceforge.net/projects/jpodlib/ as development seems to be frozen. We're providing some bug fixes along with deployments to maven.
There is a newer version: 2.0
Show newest version
/*
 * Copyright (c) 2007, intarsys consulting GmbH
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * - Redistributions of source code must retain the above copyright notice,
 *   this list of conditions and the following disclaimer.
 *
 * - 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.
 *
 * - Neither the name of intarsys nor the names of its contributors may be used
 *   to endorse or promote products derived from this software without specific
 *   prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS 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 COPYRIGHT OWNER OR 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.
 */
package de.intarsys.pdf.pd;

import de.intarsys.pdf.cos.COSBasedObject;
import de.intarsys.pdf.cos.COSDictionary;
import de.intarsys.pdf.cos.COSName;
import de.intarsys.pdf.cos.COSObject;
import de.intarsys.pdf.cos.COSStream;
import de.intarsys.pdf.filter.Filter;

/**
 * An embedding of another file (and optional content) within the PDF.
 */
public class PDEmbeddedFile extends PDObject {
    /**
     * The meta class implementation
     */
    public static class MetaClass extends PDObject.MetaClass {
        protected MetaClass(Class instanceClass) {
            super(instanceClass);
        }

        @Override
        protected COSBasedObject doCreateCOSBasedObject(COSObject object) {
            return new PDEmbeddedFile(object);
        }

        @Override
        protected COSObject doCreateCOSObject() {
            return COSStream.create(null);
        }
    }

    /**
     * The meta class instance
     */
    public static final MetaClass META = new MetaClass(MetaClass.class.getDeclaringClass());

    public static final COSName DK_Params = COSName.constant("Params"); //

    public static final COSName DK_Subtype = COSName.constant("Subtype"); //

    public static final COSName CN_ModDate = COSName.constant("ModDate"); //

    public static final COSName CN_Type_EmbeddedFile = COSName.constant("EmbeddedFile"); //

    protected PDEmbeddedFile(COSObject object) {
        super(object);
    }

    /*
     * (non-Javadoc)
     *
     * @see de.intarsys.pdf.cos.COSBasedObject#cosGetDict()
     */
    @Override
    public COSDictionary cosGetDict() {
        return cosGetStream().getDict();
    }

    /*
     * (non-Javadoc)
     *
     * @see de.intarsys.pdf.pd.PDObject#cosGetExpectedType()
     */
    @Override
    protected COSName cosGetExpectedType() {
        return CN_Type_EmbeddedFile;
    }

    /**
     * get the data representing the XObject
     *
     * @return get the data representing the XObject
     */
    public byte[] getBytes() {
        return cosGetStream().getDecodedBytes();
    }

    public PDEmbeddedFileParams getParams() {
        COSDictionary cosParams = cosGetField(DK_Params).asDictionary();
        if (cosParams == null) {
            return null;
        }
        return (PDEmbeddedFileParams) PDEmbeddedFileParams.META.createFromCos(cosParams);
    }

    public String getSubtype() {
        COSName value = cosGetField(DK_Subtype).asName();
        if (value == null) {
            return null;
        }
        return value.stringValue();
    }

    /*
     * (non-Javadoc)
     *
     * @see de.intarsys.pdf.pd.PDSubtypedObject#initializeFromScratch()
     */
    @Override
    protected void initializeFromScratch() {
        super.initializeFromScratch();
        cosGetStream().addFilter(Filter.CN_Filter_FlateDecode);
    }

    /**
     * set the data representing the XObject
     *
     * @param bytes the data representing the XObject
     */
    public void setBytes(byte[] bytes) {
        cosGetStream().setDecodedBytes(bytes);
    }

    public void setParams(PDEmbeddedFileParams params) {
        setFieldObject(DK_Params, params);
    }

    public void setSubtype(String subtype) {
        setFieldName(DK_Subtype, subtype);
    }
}