Coverage Report - org.jaxen.expr.LocationPath
 
Classes in this File Line Coverage Branch Coverage Complexity
LocationPath
N/A
N/A
1
 
 1  
 /*
 2  
  * $Header: /home/projects/jaxen/scm/jaxen/src/java/main/org/jaxen/expr/LocationPath.java,v 1.9 2006/11/08 17:02:21 elharo Exp $
 3  
  * $Revision: 1.9 $
 4  
  * $Date: 2006/11/08 17:02:21 $
 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: LocationPath.java,v 1.9 2006/11/08 17:02:21 elharo Exp $
 46  
  */
 47  
 
 48  
 package org.jaxen.expr;
 49  
 
 50  
 import java.util.List;
 51  
 
 52  
 /**
 53  
  * Represents an XPath location path such as <code>//foo/bar</code>
 54  
  * or <code>pre:baz[position()=last()]</code>.
 55  
  * This is production 1 in the 
 56  
  * <a href="http://www.w3.org/TR/xpath#NT-LocationPath">XPath 1.0 specification</a>:
 57  
  * 
 58  
  * <pre>[1]  LocationPath ::= RelativeLocationPath    
 59  
  *                    | AbsoluteLocationPath</pre>
 60  
  * 
 61  
  */
 62  
 public interface LocationPath extends Expr
 63  
 {
 64  
     
 65  
     /**
 66  
      * Add the next step to this location path.
 67  
      * 
 68  
      * @param step
 69  
      */
 70  
     void addStep(Step step);
 71  
 
 72  
     /**
 73  
      * Returns the ordered list of steps in this location path.
 74  
      * This list may be live.
 75  
      * 
 76  
      * @return the ordered list of steps in this location path
 77  
      */
 78  
     List getSteps();
 79  
     
 80  
     /**
 81  
      * Returns true if this is an absolute location path; false if it isn't. 
 82  
      * Absolute location paths all begiune with <code>/</code> 
 83  
      * or <code>//</code>.
 84  
      * 
 85  
      * @return true if this is an absol;ute location path; false if it isn't
 86  
      */
 87  
     boolean isAbsolute();
 88  
 }