/* ====================================================================
   Licensed to the Apache Software Foundation (ASF) under one or more
   contributor license agreements.  See the NOTICE file distributed with
   this work for additional information regarding copyright ownership.
   The ASF licenses this file to You 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.ss.excelant;

import org.apache.tools.ant.BuildException;
import org.apache.tools.ant.Project;

/**
 * Class for use in an Ant build script that sets the value of an Excel
 * sheet cell using the cell id ('Sheet Name'!cellId).
 */
public class ExcelAntSetStringCell extends ExcelAntSet {
    private String stringValue ;

    public ExcelAntSetStringCell() {}

    /**
     * Set the value of the cell to the String passed in.
     * @param value The string-value that should be set when this task is executed.
     */
    public void setValue(String value ) {
        stringValue = value ;
    }

    /**
     * Return the value that will be set into the cell.
     * @return The string-value of the cell as populated via setValue(), null
     *      if the value was not set yet.
     */
    public String getCellValue() {
        return stringValue;
    }

    @Override
    public void execute() throws BuildException {
        wbUtil.setStringValue(cellStr, stringValue ) ;

        log( "set cell " + cellStr + " to value " + stringValue + " as String.", Project.MSG_DEBUG ) ;
    }
}
