1 /*
2 * $Id: PdfBoolean.java 3373 2008-05-12 16:21:24Z xlv $
3 *
4 * Copyright 1999, 2000, 2001, 2002 Bruno Lowagie
5 *
6 * The contents of this file are subject to the Mozilla Public License Version 1.1
7 * (the "License"); you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at http://www.mozilla.org/MPL/
9 *
10 * Software distributed under the License is distributed on an "AS IS" basis,
11 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
12 * for the specific language governing rights and limitations under the License.
13 *
14 * The Original Code is 'iText, a free JAVA-PDF library'.
15 *
16 * The Initial Developer of the Original Code is Bruno Lowagie. Portions created by
17 * the Initial Developer are Copyright (C) 1999, 2000, 2001, 2002 by Bruno Lowagie.
18 * All Rights Reserved.
19 * Co-Developer of the code is Paulo Soares. Portions created by the Co-Developer
20 * are Copyright (C) 2000, 2001, 2002 by Paulo Soares. All Rights Reserved.
21 *
22 * Contributor(s): all the names of the contributors are added in the source code
23 * where applicable.
24 *
25 * Alternatively, the contents of this file may be used under the terms of the
26 * LGPL license (the "GNU LIBRARY GENERAL PUBLIC LICENSE"), in which case the
27 * provisions of LGPL are applicable instead of those above. If you wish to
28 * allow use of your version of this file only under the terms of the LGPL
29 * License and not to allow others to use your version of this file under
30 * the MPL, indicate your decision by deleting the provisions above and
31 * replace them with the notice and other provisions required by the LGPL.
32 * If you do not delete the provisions above, a recipient may use your version
33 * of this file under either the MPL or the GNU LIBRARY GENERAL PUBLIC LICENSE.
34 *
35 * This library is free software; you can redistribute it and/or modify it
36 * under the terms of the MPL as stated above or under the terms of the GNU
37 * Library General Public License as published by the Free Software Foundation;
38 * either version 2 of the License, or any later version.
39 *
40 * This library is distributed in the hope that it will be useful, but WITHOUT
41 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
42 * FOR A PARTICULAR PURPOSE. See the GNU Library general Public License for more
43 * details.
44 *
45 * If you didn't download this code from the following link, you should check if
46 * you aren't using an obsolete version:
47 * http://www.lowagie.com/iText/
48 */
49
50 package com.lowagie.text.pdf;
51
52 /**
53 * <CODE>PdfBoolean</CODE> is the boolean object represented by the keywords <VAR>true</VAR> or <VAR>false</VAR>.
54 * <P>
55 * This object is described in the 'Portable Document Format Reference Manual version 1.7'
56 * section 3.2.1 (page 52).
57 *
58 * @see PdfObject
59 * @see BadPdfFormatException
60 */
61
62 public class PdfBoolean extends PdfObject {
63
64 // static membervariables (possible values of a boolean object)
65 public static final PdfBoolean PDFTRUE = new PdfBoolean(true);
66 public static final PdfBoolean PDFFALSE = new PdfBoolean(false);
67 /** A possible value of <CODE>PdfBoolean</CODE> */
68 public static final String TRUE = "true";
69
70 /** A possible value of <CODE>PdfBoolean</CODE> */
71 public static final String FALSE = "false";
72
73 // membervariables
74
75 /** the boolean value of this object */
76 private boolean value;
77
78 // constructors
79
80 /**
81 * Constructs a <CODE>PdfBoolean</CODE>-object.
82 *
83 * @param value the value of the new <CODE>PdfObject</CODE>
84 */
85
86 public PdfBoolean(boolean value) {
87 super(BOOLEAN);
88 if (value) {
89 setContent(TRUE);
90 }
91 else {
92 setContent(FALSE);
93 }
94 this.value = value;
95 }
96
97 /**
98 * Constructs a <CODE>PdfBoolean</CODE>-object.
99 *
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 }
110 else if (value.equals(FALSE)) {
111 this.value = false;
112 }
113 else {
114 throw new BadPdfFormatException("The value has to be 'true' of 'false', instead of '" + 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 }