1    
2    /* ====================================================================
3     * The Apache Software License, Version 1.1
4     *
5     * Copyright (c) 2002 The Apache Software Foundation.  All rights
6     * reserved.
7     *
8     * Redistribution and use in source and binary forms, with or without
9     * modification, are permitted provided that the following conditions
10    * are met:
11    *
12    * 1. Redistributions of source code must retain the above copyright
13    *    notice, this list of conditions and the following disclaimer.
14    *
15    * 2. Redistributions in binary form must reproduce the above copyright
16    *    notice, this list of conditions and the following disclaimer in
17    *    the documentation and/or other materials provided with the
18    *    distribution.
19    *
20    * 3. The end-user documentation included with the redistribution,
21    *    if any, must include the following acknowledgment:
22    *       "This product includes software developed by the
23    *        Apache Software Foundation (http://www.apache.org/)."
24    *    Alternately, this acknowledgment may appear in the software itself,
25    *    if and wherever such third-party acknowledgments normally appear.
26    *
27    * 4. The names "Apache" and "Apache Software Foundation" and
28    *    "Apache POI" must not be used to endorse or promote products
29    *    derived from this software without prior written permission. For
30    *    written permission, please contact apache@apache.org.
31    *
32    * 5. Products derived from this software may not be called "Apache",
33    *    "Apache POI", nor may "Apache" appear in their name, without
34    *    prior written permission of the Apache Software Foundation.
35    *
36    * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
37    * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
38    * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
39    * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
40    * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
41    * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
42    * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
43    * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
44    * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
45    * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
46    * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
47    * SUCH DAMAGE.
48    * ====================================================================
49    *
50    * This software consists of voluntary contributions made by many
51    * individuals on behalf of the Apache Software Foundation.  For more
52    * information on the Apache Software Foundation, please see
53    * <http://www.apache.org/>.
54    */
55   
56   package org.apache.poi.hssf.record.formula;
57   
58   import java.util.List;
59   
60   import org.apache.poi.hssf.util.SheetReferences;
61   
62   /**
63    * While formula tokens are stored in RPN order and thus do not need parenthesis for 
64    * precedence reasons, Parenthesis tokens ARE written to ensure that user entered
65    * parenthesis are displayed as-is on reading back
66    *
67    * Avik Sengupta <lists@aviksengupta.com>
68    * Andrew C. Oliver (acoliver at apache dot org)
69    * @author Jason Height (jheight at chariot dot net dot au)
70    */
71   public class ParenthesisPtg
72       extends OperationPtg
73   {
74      
75       private final static int SIZE = 1;
76       public final static byte sid  = 0x15;
77      
78       public ParenthesisPtg()
79       {
80       }
81   
82       public ParenthesisPtg(byte [] data, int offset)
83       {
84   
85           // doesn't need anything
86       }
87       
88     
89       
90       public void writeBytes(byte [] array, int offset)
91       {
92           array[ offset + 0 ] = sid;
93       }
94   
95       public int getSize()
96       {
97           return SIZE;
98       }
99   
100      public int getType()
101      {
102          return TYPE_BINARY;
103      }
104  
105      public int getNumberOfOperands()
106      {
107          return 1;
108      }
109  
110      public String toFormulaString(SheetReferences refs)
111      {
112          return "()";
113      }
114  
115            
116      public String toFormulaString(String[] operands) {
117          return "("+operands[0]+")";
118      }  
119      
120      public byte getDefaultOperandClass() {return Ptg.CLASS_VALUE;}
121          
122      public Object clone() {
123        return new ParenthesisPtg();
124      }
125  
126  }
127  
128