org.apache.poi.hssf.record.formula.ParenthesisPtg Maven / Gradle / Ivy

/* ====================================================================
   Copyright 2003-2004   Apache Software Foundation

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.
==================================================================== */


package org.apache.poi.hssf.record.formula;

import java.util.List;

import org.apache.poi.hssf.model.Workbook;

/**
 * While formula tokens are stored in RPN order and thus do not need parenthesis for 
 * precedence reasons, Parenthesis tokens ARE written to ensure that user entered
 * parenthesis are displayed as-is on reading back
 *
 * Avik Sengupta 
 * Andrew C. Oliver (acoliver at apache dot org)
 * @author Jason Height (jheight at chariot dot net dot au)
 */
public class ParenthesisPtg
    extends OperationPtg
{
   
    private final static int SIZE = 1;
    public final static byte sid  = 0x15;
   
    public ParenthesisPtg()
    {
    }

    public ParenthesisPtg(byte [] data, int offset)
    {

        // doesn't need anything
    }
    
  
    
    public void writeBytes(byte [] array, int offset)
    {
        array[ offset + 0 ] = sid;
    }

    public int getSize()
    {
        return SIZE;
    }

    public int getType()
    {
        return TYPE_BINARY;
    }

    public int getNumberOfOperands()
    {
        return 1;
    }

    public String toFormulaString(Workbook book)
    {
        return "()";
    }

          
    public String toFormulaString(String[] operands) {
        return "("+operands[0]+")";
    }  
    
    public byte getDefaultOperandClass() {return Ptg.CLASS_VALUE;}
        
    public Object clone() {
      return new ParenthesisPtg();
    }

}