001: /*
002: * $Id: PdfBoolean.java 2739 2007-05-04 11:24:51Z blowagie $
003: * $Name$
004: *
005: * Copyright 1999, 2000, 2001, 2002 Bruno Lowagie
006: *
007: * The contents of this file are subject to the Mozilla Public License Version 1.1
008: * (the "License"); you may not use this file except in compliance with the License.
009: * You may obtain a copy of the License at http://www.mozilla.org/MPL/
010: *
011: * Software distributed under the License is distributed on an "AS IS" basis,
012: * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
013: * for the specific language governing rights and limitations under the License.
014: *
015: * The Original Code is 'iText, a free JAVA-PDF library'.
016: *
017: * The Initial Developer of the Original Code is Bruno Lowagie. Portions created by
018: * the Initial Developer are Copyright (C) 1999, 2000, 2001, 2002 by Bruno Lowagie.
019: * All Rights Reserved.
020: * Co-Developer of the code is Paulo Soares. Portions created by the Co-Developer
021: * are Copyright (C) 2000, 2001, 2002 by Paulo Soares. All Rights Reserved.
022: *
023: * Contributor(s): all the names of the contributors are added in the source code
024: * where applicable.
025: *
026: * Alternatively, the contents of this file may be used under the terms of the
027: * LGPL license (the "GNU LIBRARY GENERAL PUBLIC LICENSE"), in which case the
028: * provisions of LGPL are applicable instead of those above. If you wish to
029: * allow use of your version of this file only under the terms of the LGPL
030: * License and not to allow others to use your version of this file under
031: * the MPL, indicate your decision by deleting the provisions above and
032: * replace them with the notice and other provisions required by the LGPL.
033: * If you do not delete the provisions above, a recipient may use your version
034: * of this file under either the MPL or the GNU LIBRARY GENERAL PUBLIC LICENSE.
035: *
036: * This library is free software; you can redistribute it and/or modify it
037: * under the terms of the MPL as stated above or under the terms of the GNU
038: * Library General Public License as published by the Free Software Foundation;
039: * either version 2 of the License, or any later version.
040: *
041: * This library is distributed in the hope that it will be useful, but WITHOUT
042: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
043: * FOR A PARTICULAR PURPOSE. See the GNU Library general Public License for more
044: * details.
045: *
046: * If you didn't download this code from the following link, you should check if
047: * you aren't using an obsolete version:
048: * http://www.lowagie.com/iText/
049: */
050:
051: package com.lowagie.text.pdf;
052:
053: /**
054: * <CODE>PdfBoolean</CODE> is the boolean object represented by the keywords <VAR>true</VAR> or <VAR>false</VAR>.
055: * <P>
056: * This object is described in the 'Portable Document Format Reference Manual version 1.7'
057: * section 3.2.1 (page 52).
058: *
059: * @see PdfObject
060: * @see BadPdfFormatException
061: */
062:
063: public class PdfBoolean extends PdfObject {
064:
065: // static membervariables (possible values of a boolean object)
066: public static final PdfBoolean PDFTRUE = new PdfBoolean(true);
067: public static final PdfBoolean PDFFALSE = new PdfBoolean(false);
068: /** A possible value of <CODE>PdfBoolean</CODE> */
069: public static final String TRUE = "true";
070:
071: /** A possible value of <CODE>PdfBoolean</CODE> */
072: public static final String FALSE = "false";
073:
074: // membervariables
075:
076: /** the boolean value of this object */
077: private boolean value;
078:
079: // constructors
080:
081: /**
082: * Constructs a <CODE>PdfBoolean</CODE>-object.
083: *
084: * @param value the value of the new <CODE>PdfObject</CODE>
085: */
086:
087: public PdfBoolean(boolean value) {
088: super (BOOLEAN);
089: if (value) {
090: setContent(TRUE);
091: } else {
092: setContent(FALSE);
093: }
094: this .value = value;
095: }
096:
097: /**
098: * Constructs a <CODE>PdfBoolean</CODE>-object.
099: *
100: * @param value the value of the new <CODE>PdfObject</CODE>, represented as a <CODE>String</CODE>
101: *
102: * @throws BadPdfFormatException thrown if the <VAR>value</VAR> isn't '<CODE>true</CODE>' or '<CODE>false</CODE>'
103: */
104:
105: public PdfBoolean(String value) throws BadPdfFormatException {
106: super (BOOLEAN, value);
107: if (value.equals(TRUE)) {
108: this .value = true;
109: } else if (value.equals(FALSE)) {
110: this .value = false;
111: } else {
112: throw new BadPdfFormatException(
113: "The value has to be 'true' of 'false', instead of '"
114: + value + "'.");
115: }
116: }
117:
118: // methods returning the value of this object
119:
120: /**
121: * Returns the primitive value of the <CODE>PdfBoolean</CODE>-object.
122: *
123: * @return the actual value of the object.
124: */
125:
126: public boolean booleanValue() {
127: return value;
128: }
129:
130: public String toString() {
131: return value ? TRUE : FALSE;
132: }
133: }
|