Coverage Report - org.jaxen.function.BooleanFunction

Classes in this Package Line Coverage Branch Coverage Complexity
BooleanFunction
100% 
100% 
8

 1  
 /*
 2  
  * $Header: /home/projects/jaxen/scm/jaxen/src/java/main/org/jaxen/function/BooleanFunction.java,v 1.11 2005/04/30 22:49:21 elharo Exp $
 3  
  * $Revision: 1.11 $
 4  
  * $Date: 2005/04/30 22:49:21 $
 5  
  *
 6  
  * ====================================================================
 7  
  *
 8  
  * Copyright (C) 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
 13  
  * are met:
 14  
  * 
 15  
  * 1. Redistributions of source code must retain the above copyright
 16  
  *    notice, this list of conditions, and the following disclaimer.
 17  
  *
 18  
  * 2. Redistributions in binary form must reproduce the above copyright
 19  
  *    notice, this list of conditions, and the disclaimer that follows 
 20  
  *    these conditions in the documentation and/or other materials 
 21  
  *    provided with the distribution.
 22  
  *
 23  
  * 3. The name "Jaxen" must not be used to endorse or promote products
 24  
  *    derived from this software without prior written permission.  For
 25  
  *    written permission, please contact license@jaxen.org.
 26  
  * 
 27  
  * 4. Products derived from this software may not be called "Jaxen", nor
 28  
  *    may "Jaxen" appear in their name, without prior written permission
 29  
  *    from the Jaxen Project Management (pm@jaxen.org).
 30  
  * 
 31  
  * In addition, we request (but do not require) that you include in the 
 32  
  * end-user documentation provided with the redistribution and/or in the 
 33  
  * software itself an acknowledgement equivalent to the following:
 34  
  *     "This product includes software developed by the
 35  
  *      Jaxen Project (http://www.jaxen.org/)."
 36  
  * Alternatively, the acknowledgment may be graphical using the logos 
 37  
  * available at http://www.jaxen.org/
 38  
  *
 39  
  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
 40  
  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 41  
  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 42  
  * DISCLAIMED.  IN NO EVENT SHALL THE Jaxen AUTHORS OR THE PROJECT
 43  
  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 44  
  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 45  
  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 46  
  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 47  
  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 48  
  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 49  
  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 50  
  * SUCH DAMAGE.
 51  
  *
 52  
  * ====================================================================
 53  
  * This software consists of voluntary contributions made by many 
 54  
  * individuals on behalf of the Jaxen Project and was originally 
 55  
  * created by bob mcwhirter <bob@werken.com> and 
 56  
  * James Strachan <jstrachan@apache.org>.  For more information on the 
 57  
  * Jaxen Project, please see <http://www.jaxen.org/>.
 58  
  * 
 59  
  * $Id: BooleanFunction.java,v 1.11 2005/04/30 22:49:21 elharo Exp $
 60  
  */
 61  
 
 62  
 
 63  
 package org.jaxen.function;
 64  
 
 65  
 import java.util.List;
 66  
 
 67  
 import org.jaxen.Context;
 68  
 import org.jaxen.Function;
 69  
 import org.jaxen.FunctionCallException;
 70  
 import org.jaxen.Navigator;
 71  
 
 72  
 /**
 73  
  *  <p><b>4.3</b> <code><i>boolean</i> boolean(<i>object</i>)</code> 
 74  
  *  
 75  
  *  @author bob mcwhirter (bob @ werken.com)
 76  
  */
 77  41
 public class BooleanFunction implements Function
 78  
 {
 79  
 
 80  
     /** Convert the argument to a <code>Boolean</code>
 81  
      *
 82  
      * @param context the context at the point in the
 83  
      *         expression when the function is called
 84  
      * @param args a list with exactly one item which will be converted to a 
 85  
      *     <code>Boolean</code>
 86  
      * 
 87  
      * @return the result of evaluating the function; a <code>List</code>
 88  
      *    (node-set), <code>Double</code>, <code>Boolean</code>, or
 89  
      *    <code>String</code>
 90  
      * 
 91  
      * @throws FunctionCallException if there is more or less than one item in args
 92  
      */
 93  
     public Object call(Context context,
 94  
                        List args) throws FunctionCallException
 95  
     {
 96  8
         if ( args.size() == 1 )
 97  
         {
 98  6
             return evaluate( args.get(0), context.getNavigator() );
 99  
         }
 100  
 
 101  2
         throw new FunctionCallException("boolean() requires one argument");
 102  
     }
 103  
 
 104  
     /** 
 105  
      * <p>Convert the argument <code>obj</code> to a <code>Boolean</code> 
 106  
      * according to the following rules:</p>
 107  
      *
 108  
      * <ul>
 109  
      * <li>Lists are false if they're empty; true if they're not.</li>
 110  
      * <li>Booleans are false if they're false; true if they're true.</li>
 111  
      * <li>Strings are false if they're empty; true if they're not.</li>
 112  
      * <li>Numbers are false if they're 0; true if they're not.</li>
 113  
      * <li>All other objects are true.</li>
 114  
      * </ul>
 115  
      * 
 116  
      * @param obj the object to convert to a boolean.
 117  
      * @param nav ignored
 118  
      * 
 119  
      * @return <code>Boolean.TRUE</code> or <code>Boolean.FALSE</code>
 120  
      */
 121  
     public static Boolean evaluate(Object obj, Navigator nav)
 122  
     {
 123  3520
         if ( obj instanceof List )
 124  
         {
 125  216
             List list = (List) obj;
 126  
             
 127  
             // if it's an empty list, then we have a null node-set -> false            
 128  216
             if (list.size() == 0)
 129  
             {
 130  3
                 return Boolean.FALSE;
 131  
             }
 132  
      
 133  
             // otherwise, unwrap the list and check the primitive
 134  213
             obj = list.get(0);
 135  
         }
 136  
         
 137  
         // now check for primitive types
 138  
         // otherwise a non-empty node-set is true
 139  
 
 140  
         // if it's a Boolean, let it decide
 141  3517
         if ( obj instanceof Boolean )
 142  
         {
 143  3290
             return (Boolean) obj;
 144  
         }
 145  
         // if it's a Number, != 0 -> true
 146  227
         else if ( obj instanceof Number )
 147  
         {
 148  13
             double d = ((Number) obj).doubleValue();
 149  13
             if ( d == 0 || Double.isNaN(d) )
 150  
             {
 151  4
                 return Boolean.FALSE;
 152  
             }
 153  9
             return Boolean.TRUE;
 154  
         }
 155  
         // if it's a String, "" -> false
 156  214
         else if ( obj instanceof String )
 157  
         {
 158  4
             return ( ((String)obj).length() > 0
 159  
                      ? Boolean.TRUE
 160  
                      : Boolean.FALSE );
 161  
         }
 162  
         else 
 163  
         {
 164  
             // assume it's a node so that this node-set is non-empty 
 165  
             // and so it's true
 166  210
             return ( obj != null ) ? Boolean.TRUE : Boolean.FALSE;
 167  
         }
 168  
 
 169  
     }
 170  
 }