001/*
002 * $Id: PdfBoolean.java 4784 2011-03-15 08:33:00Z blowagie $
003 *
004 * This file is part of the iText (R) project.
005 * Copyright (c) 1998-2011 1T3XT BVBA
006 * Authors: Bruno Lowagie, Paulo Soares, et al.
007 *
008 * This program is free software; you can redistribute it and/or modify
009 * it under the terms of the GNU Affero General Public License version 3
010 * as published by the Free Software Foundation with the addition of the
011 * following permission added to Section 15 as permitted in Section 7(a):
012 * FOR ANY PART OF THE COVERED WORK IN WHICH THE COPYRIGHT IS OWNED BY 1T3XT,
013 * 1T3XT DISCLAIMS THE WARRANTY OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
014 *
015 * This program is distributed in the hope that it will be useful, but
016 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
017 * or FITNESS FOR A PARTICULAR PURPOSE.
018 * See the GNU Affero General Public License for more details.
019 * You should have received a copy of the GNU Affero General Public License
020 * along with this program; if not, see http://www.gnu.org/licenses or write to
021 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
022 * Boston, MA, 02110-1301 USA, or download the license from the following URL:
023 * http://itextpdf.com/terms-of-use/
024 *
025 * The interactive user interfaces in modified source and object code versions
026 * of this program must display Appropriate Legal Notices, as required under
027 * Section 5 of the GNU Affero General Public License.
028 *
029 * In accordance with Section 7(b) of the GNU Affero General Public License,
030 * a covered work must retain the producer line in every PDF that is created
031 * or manipulated using iText.
032 *
033 * You can be released from the requirements of the license by purchasing
034 * a commercial license. Buying such a license is mandatory as soon as you
035 * develop commercial activities involving the iText software without
036 * disclosing the source code of your own applications.
037 * These activities include: offering paid services to customers as an ASP,
038 * serving PDFs on the fly in a web application, shipping iText with a closed
039 * source product.
040 *
041 * For more information, please contact iText Software Corp. at this
042 * address: sales@itextpdf.com
043 */
044package com.itextpdf.text.pdf;
045
046import com.itextpdf.text.error_messages.MessageLocalization;
047
048/**
049 * <CODE>PdfBoolean</CODE> is the boolean object represented by the keywords <VAR>true</VAR> or <VAR>false</VAR>.
050 * <P>
051 * This object is described in the 'Portable Document Format Reference Manual version 1.7'
052 * section 3.2.1 (page 52).
053 *
054 * @see         PdfObject
055 * @see         BadPdfFormatException
056 */
057
058public class PdfBoolean extends PdfObject {
059    
060    // static membervariables (possible values of a boolean object)
061    public static final PdfBoolean PDFTRUE = new PdfBoolean(true);
062    public static final PdfBoolean PDFFALSE = new PdfBoolean(false);
063/** A possible value of <CODE>PdfBoolean</CODE> */
064    public static final String TRUE = "true";
065    
066/** A possible value of <CODE>PdfBoolean</CODE> */
067    public static final String FALSE = "false";
068    
069    // membervariables
070    
071/** the boolean value of this object */
072    private boolean value;
073    
074    // constructors
075    
076/**
077 * Constructs a <CODE>PdfBoolean</CODE>-object.
078 *
079 * @param               value                   the value of the new <CODE>PdfObject</CODE>
080 */
081    
082    public PdfBoolean(boolean value) {
083        super(BOOLEAN);
084        if (value) {
085            setContent(TRUE);
086        }
087        else {
088            setContent(FALSE);
089        }
090        this.value = value;
091    }
092    
093/**
094 * Constructs a <CODE>PdfBoolean</CODE>-object.
095 *
096 * @param               value                   the value of the new <CODE>PdfObject</CODE>, represented as a <CODE>String</CODE>
097 *
098 * @throws              BadPdfFormatException   thrown if the <VAR>value</VAR> isn't '<CODE>true</CODE>' or '<CODE>false</CODE>'
099 */
100    
101    public PdfBoolean(String value) throws BadPdfFormatException {
102        super(BOOLEAN, value);
103        if (value.equals(TRUE)) {
104            this.value = true;
105        }
106        else if (value.equals(FALSE)) {
107            this.value = false;
108        }
109        else {
110            throw new BadPdfFormatException(MessageLocalization.getComposedMessage("the.value.has.to.be.true.of.false.instead.of.1", value));
111        }
112    }
113    
114    // methods returning the value of this object
115    
116/**
117 * Returns the primitive value of the <CODE>PdfBoolean</CODE>-object.
118 *
119 * @return              the actual value of the object.
120 */
121    
122    public boolean booleanValue() {
123        return value;
124    }
125    
126    public String toString() {
127        return value ? TRUE : FALSE;
128    }
129}