KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > jxl > BooleanCell


1 /*********************************************************************
2 *
3 * Copyright (C) 2002 Andrew Khan
4 *
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Lesser General Public
7 * License as published by the Free Software Foundation; either
8 * version 2.1 of the License, or (at your option) any later version.
9 *
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Lesser General Public License for more details.
14 *
15 * You should have received a copy of the GNU Lesser General Public
16 * License along with this library; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18 ***************************************************************************/
19
20 package jxl;
21
22 /**
23  * This type represents the Microsoft concept of a Boolean. Accordingly, this
24  * cell represents either TRUE, FALSE or an error condition. This third
25  * state naturally makes handling BooleanCells quite tricky, and use of
26  * the specific access methods should be handled with care
27  */
28 public interface BooleanCell extends Cell
29 {
30   /**
31    * Gets the boolean value stored in this cell. If this cell contains an
32    * error, then returns FALSE. Always query this cell type using the
33    * accessor method isError() prior to calling this method
34    *
35    * @return TRUE if this cell contains TRUE, FALSE if it contains FALSE or
36    * an error code
37    */
38   public boolean getValue();
39 }
40
41
42
43
44
45
46
47
Popular Tags