org.navimatrix.jaxen.function.NotFunction Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of navixpath Show documentation
A lib to access XML via XPath
There is a newer version: 1.0.5
/*
 * $Header: /cvs/jaxen/jaxen/src/java/main/org/jaxen/function/NotFunction.java,v 1.9 2006/02/05 21:47:41 elharo Exp $
 * $Revision: 1.9 $
 * $Date: 2006/02/05 21:47:41 $
 *
 * ====================================================================
 *
 * Copyright 2000-2002 bob mcwhirter & James Strachan.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 * 
 *   * Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 * 
 *   * Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in the
 *     documentation and/or other materials provided with the distribution.
 * 
 *   * Neither the name of the Jaxen Project nor the names of its
 *     contributors may be used to endorse or promote products derived 
 *     from this software without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
 * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
 * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * ====================================================================
 * This software consists of voluntary contributions made by many 
 * individuals on behalf of the Jaxen Project and was originally 
 * created by bob mcwhirter  and 
 * James Strachan .  For more information on the 
 * Jaxen Project, please see .
 * 
 * $Id: NotFunction.java,v 1.9 2006/02/05 21:47:41 elharo Exp $
 */

package org.navimatrix.jaxen.function;

import java.util.List;

import org.navimatrix.jaxen.Context;
import org.navimatrix.jaxen.Function;
import org.navimatrix.jaxen.FunctionCallException;
import org.navimatrix.jaxen.Navigator;

/**
 * 4.3 boolean not(boolean) 
 * 
 * 
 * 
 * The not function returns true if its argument is false, and false otherwise.
 * 
 * 
 * @author bob mcwhirter (bob @ werken.com)
 * @see Section 4.3 of the XPath Specification
 */
public class NotFunction implements Function
{

    /**
     * Create a new NotFunction object.
     */
    public NotFunction() {}
    
    /**
     * Returns Boolean.TRUE if the boolean value of 
     * args.get(0) is false, and Boolean.FALSE otherwise.
     * The boolean value is calculated as if by the XPath boolean
     * function. 
     * 
     * @param context the context at the point in the
     *         expression where the function is called
     * @param args a single element list
     * 
     * @return Boolean.TRUE if the boolean value of 
     * obj is false, and Boolean.FALSE otherwise
     * 
     * @throws FunctionCallException if args does not have exactly one argument
     */
    public Object call(Context context,
                       List args) throws FunctionCallException
    {
        if (args.size() == 1)
        {
            return evaluate( args.get(0), context.getNavigator() );
        }

        throw new FunctionCallException( "not() requires one argument." );
    }

    /**
     * Returns Boolean.TRUE if the boolean value of 
     * obj is false, and Boolean.FALSE otherwise.
     * The boolean value is calculated as if by the XPath boolean
     * function. 
     * 
     * @param obj the object whose boolean value is inverted
     * @param nav the Navigator used to calculate the boolean value of obj
     * 
     * @return Boolean.TRUE if the boolean value of 
     * obj is false, and Boolean.FALSE otherwise
     */
    public static Boolean evaluate(Object obj, Navigator nav)
    {
        return ( ( BooleanFunction.evaluate( obj, nav ).booleanValue() )
                 ? Boolean.FALSE
                 : Boolean.TRUE
                 );
    }
    
}