Coverage Report - org.jaxen.function.FloorFunction
 
Classes in this File Line Coverage Branch Coverage Complexity
FloorFunction
100%
6/6
100%
1/1
2
 
 1  
 /*
 2  
  * $Header: /home/projects/jaxen/scm/jaxen/src/java/main/org/jaxen/function/FloorFunction.java,v 1.11 2006/02/05 21:47:41 elharo Exp $
 3  
  * $Revision: 1.11 $
 4  
  * $Date: 2006/02/05 21:47:41 $
 5  
  *
 6  
  * ====================================================================
 7  
  *
 8  
  * Copyright 2000-2002 bob mcwhirter & James Strachan.
 9  
  * All rights reserved.
 10  
  *
 11  
  * Redistribution and use in source and binary forms, with or without
 12  
  * modification, are permitted provided that the following conditions are
 13  
  * met:
 14  
  * 
 15  
  *   * Redistributions of source code must retain the above copyright
 16  
  *     notice, this list of conditions and the following disclaimer.
 17  
  * 
 18  
  *   * Redistributions in binary form must reproduce the above copyright
 19  
  *     notice, this list of conditions and the following disclaimer in the
 20  
  *     documentation and/or other materials provided with the distribution.
 21  
  * 
 22  
  *   * Neither the name of the Jaxen Project nor the names of its
 23  
  *     contributors may be used to endorse or promote products derived 
 24  
  *     from this software without specific prior written permission.
 25  
  * 
 26  
  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
 27  
  * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
 28  
  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
 29  
  * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
 30  
  * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 31  
  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 32  
  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 33  
  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 34  
  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 35  
  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 36  
  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 37  
  *
 38  
  * ====================================================================
 39  
  * This software consists of voluntary contributions made by many 
 40  
  * individuals on behalf of the Jaxen Project and was originally 
 41  
  * created by bob mcwhirter <bob@werken.com> and 
 42  
  * James Strachan <jstrachan@apache.org>.  For more information on the 
 43  
  * Jaxen Project, please see <http://www.jaxen.org/>.
 44  
  * 
 45  
  * $Id: FloorFunction.java,v 1.11 2006/02/05 21:47:41 elharo Exp $
 46  
  */
 47  
 
 48  
 
 49  
 package org.jaxen.function;
 50  
 
 51  
 import java.util.List;
 52  
 
 53  
 import org.jaxen.Context;
 54  
 import org.jaxen.Function;
 55  
 import org.jaxen.FunctionCallException;
 56  
 import org.jaxen.Navigator;
 57  
 
 58  
 /**
 59  
  * <p><b>4.4</b> <code><i>number</i> floor(<i>number</i>)</code></p> 
 60  
  * 
 61  
  * 
 62  
  * <blockquote src="http://www.w3.org/TR/xpath">
 63  
  * The floor function returns the largest (closest to positive infinity) 
 64  
  * number that is not greater than the argument and that is an integer....
 65  
  * If the argument is NaN, then NaN is returned. 
 66  
  * If the argument is positive infinity, then positive infinity is returned. 
 67  
  * If the argument is negative infinity, then negative infinity is returned. 
 68  
  * If the argument is positive zero, then positive zero is returned. 
 69  
  * If the argument is negative zero, then negative zero is returned. 
 70  
  * If the argument is greater than zero, but less than 1, then positive zero is returned.
 71  
  * </blockquote>
 72  
  * 
 73  
  * @author bob mcwhirter (bob @ werken.com)
 74  
  * 
 75  
  * @see <a href="http://www.w3.org/TR/xpath#function-floor" target="_top">Section 4.4 of the XPath Specification</a>
 76  
  * @see <a href="http://www.w3.org/1999/11/REC-xpath-19991116-errata/"  target="_top">XPath Errata</a>
 77  
  */
 78  
 public class FloorFunction implements Function
 79  
 {
 80  
 
 81  
     /**
 82  
      * Create a new <code>FloorFunction</code> object.
 83  
      */
 84  106
     public FloorFunction() {}
 85  
     
 86  
     /** Returns the largest integer less than or equal to a number.
 87  
      *
 88  
      * @param context the context at the point in the
 89  
      *         expression when the function is called
 90  
      * @param args a list with exactly one item which will be converted to a 
 91  
      *     <code>Double</code> as if by the XPath <code>number()</code> function
 92  
      * 
 93  
      * @return a <code>Double</code> containing the largest integer less than or equal
 94  
      *     to <code>args.get(0)</code>
 95  
      * 
 96  
      * @throws FunctionCallException if <code>args</code> has more or less than one item
 97  
      */
 98  
     public Object call(Context context,
 99  
                        List args) throws FunctionCallException
 100  
     {
 101  14
         if (args.size() == 1)
 102  
         {
 103  10
             return evaluate( args.get(0),
 104  
                              context.getNavigator() );
 105  
         }
 106  
 
 107  4
         throw new FunctionCallException( "floor() requires one argument." );
 108  
     }
 109  
 
 110  
     /** Returns the largest integer less than or equal to the argument.
 111  
      * If necessary, the argument is first converted to a <code>Double</code>
 112  
      * as if by the XPath <code>number()</code> function.
 113  
      * 
 114  
      * @param obj the object whose floor is returned
 115  
      * @param nav ignored
 116  
      * 
 117  
      * @return a <code>Double</code> containing the largest integer less 
 118  
      *     than or equal to <code>obj</code>
 119  
      */
 120  
     public static Double evaluate(Object obj,
 121  
                                   Navigator nav)
 122  
     {
 123  10
         Double value = NumberFunction.evaluate( obj,
 124  
                                                 nav );
 125  
 
 126  10
         return new Double( Math.floor( value.doubleValue() ) );
 127  
     }
 128  
 }
 129