KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > lowagie > text > pdf > PdfBoolean


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