/*
 * $Id: PDFInfo.java,v 1.2 2007/08/26 18:56:35 gil1 Exp $
 *
 * $Date: 2007/08/26 18:56:35 $
 *
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 * 
 */
package gnu.jpdf;

import java.io.*;

/**
 * <p>
 * This class stores details of the author, the PDF generator etc. The values
 * are accessible via the PDFDocument class.</p>
 *
 * @author Peter T. Mount
 * @author Eric Z. Beard, ericzbeard@hotmail.com
 * @version $Revision: 1.2 $, $Date: 2007/08/26 18:56:35 $
 *
 */
public class PDFInfo extends PDFObject {

    private String author;
    private String creator;
    private String title;
    private String subject;
    private String keywords;

    /**
     * This constructs a minimal info object
     */
    public PDFInfo() {
        super(null);
    }

    /**
     * @param title Title of this document
     */
    public PDFInfo(String title) {
        this();
        this.title = title;
    }

    /**
     * Get the value of author.
     *
     * @return value of author.
     */
    public String getAuthor() {
        return author;
    }

    /**
     * Set the value of author.
     *
     * @param v Value to assign to author.
     */
    public void setAuthor(String v) {
        this.author = v;
    }

    /**
     * PDF has two values, a Creator and a Producer. The creator field is
     * available for calling code. The producer is fixed by this library. Get
     * the value of creator.
     *
     * @return value of creator.
     */
    public String getCreator() {
        return creator;
    }

    /**
     * Set the value of creator.
     *
     * @param v Value to assign to creator.
     */
    public void setCreator(String v) {
        this.creator = v;
    }

    /**
     * Get the value of title.
     *
     * @return value of title.
     */
    public String getTitle() {
        return title;
    }

    /**
     * Set the value of title.
     *
     * @param v Value to assign to title.
     */
    public void setTitle(String v) {
        this.title = v;
    }

    /**
     * Get the value of subject.
     *
     * @return value of subject.
     */
    public String getSubject() {
        return subject;
    }

    /**
     * Set the value of subject.
     *
     * @param v Value to assign to subject.
     */
    public void setSubject(String v) {
        this.subject = v;
    }

    /**
     * Get the value of keywords.
     *
     * @return value of keywords.
     */
    public String getKeywords() {
        return keywords;
    }

    /**
     * Set the value of keywords.
     *
     * @param v Value to assign to keywords.
     */
    public void setKeywords(String v) {
        this.keywords = v;
    }

    /**
     * @param os OutputStream to send the object to
     * @exception IOException on error
     */
    @Override
    public void write(OutputStream os) throws IOException {
        // Write the object header
        writeStart(os);

        // now the objects body
        if (author != null) {
            os.write("/Author (".getBytes("UTF-8"));
            os.write(PDFStringHelper.makePDFString(author).getBytes("UTF-8"));
            os.write(")\n".getBytes("UTF-8"));
        }

        if (creator != null) {
            os.write("/Creator (".getBytes("UTF-8"));
            os.write(PDFStringHelper.makePDFString(creator).getBytes("UTF-8"));
            os.write(")\n".getBytes("UTF-8"));
        }

        os.write("/Producer ".getBytes("UTF-8"));
        os.write(PDFStringHelper.makePDFString("gnujpdf - gnujpdf.sourceforge.net")
                .getBytes("UTF-8"));
        os.write("\n".getBytes("UTF-8"));

        if (title != null) {
            os.write("/Title ".getBytes("UTF-8"));
            os.write(PDFStringHelper.makePDFString(title).getBytes("UTF-8"));
            os.write("\n".getBytes("UTF-8"));
        }

        if (subject != null) {
            os.write("/Subject (".getBytes("UTF-8"));
            os.write(PDFStringHelper.makePDFString(subject).getBytes("UTF-8"));
            os.write(")\n".getBytes("UTF-8"));
        }

        if (keywords != null) {
            os.write("/Keywords (".getBytes("UTF-8"));
            os.write(PDFStringHelper.makePDFString(keywords).getBytes("UTF-8"));
            os.write(")\n".getBytes("UTF-8"));
        }

        // finish off with its footer
        writeEnd(os);
    } // end write

} // end class PDFInfo