1 /*
2 * Redistribution and use of this software and associated documentation ("Software"), with or
3 * without modification, are permitted provided that the following conditions are met:
4 *
5 * 1. Redistributions of source code must retain copyright statements and notices. Redistributions
6 * must also contain a copy of this document.
7 *
8 * 2. Redistributions in binary form must reproduce the above copyright notice, this list of
9 * conditions and the following disclaimer in the documentation and/or other materials provided with
10 * the distribution.
11 *
12 * 3. The name "Exolab" must not be used to endorse or promote products derived from this Software
13 * without prior written permission of Intalio, Inc. For written permission, please contact
14 * info@exolab.org.
15 *
16 * 4. Products derived from this Software may not be called "Exolab" nor may "Exolab" appear in
17 * their names without prior written permission of Intalio, Inc. Exolab is a registered trademark of
18 * Intalio, Inc.
19 *
20 * 5. Due credit should be given to the Exolab Project (http://www.exolab.org/).
21 *
22 * THIS SOFTWARE IS PROVIDED BY INTALIO, INC. AND CONTRIBUTORS ``AS IS'' AND ANY EXPRESSED OR
23 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
24 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL INTALIO, INC. OR ITS
25 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
28 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY
29 * WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 *
31 * Copyright 1999 (C) Intalio, Inc. All Rights Reserved.
32 *
33 * $Id$
34 */
35 package org.exolab.castor.xml.location;
36
37 import java.util.Vector;
38
39 import org.apache.commons.lang3.StringUtils;
40
41
42 /**
43 * A very simple XPath location class for use with the ValidationException. This class only supports
44 * the parent "/" operator and element names.
45 *
46 * @author <a href="mailto:kvisco@intalio.com">Keith Visco</a>
47 * @version $Revision$ $Date: 2003-03-03 00:05:44 -0700 (Mon, 03 Mar 2003) $
48 */
49 public class XPathLocation implements Location, java.io.Serializable {
50
51 /** <code>serialVersionUID</code> TODO Write field description. */
52 private static final long serialVersionUID = 1L;
53
54 /** Our XPath, built up one String at a time. */
55 private final Vector<String> _path = new Vector<>();
56
57 /** If we have reached the logical end of XPath (i.e., an attribute), set to false. */
58 private boolean _allowChildrenOrAtts = true;
59
60 /**
61 * Creates a default XPathLocation.
62 */
63 public XPathLocation() {
64 super();
65 }
66
67 /**
68 * Adds an attribute to the XPath location.
69 *
70 * @param name the name of the attribute
71 */
72 public void addAttribute(final String name) {
73 if (_allowChildrenOrAtts) {
74 _allowChildrenOrAtts = false;
75 _path.add("@" + name);
76 }
77 }
78
79 /**
80 * Adds the given element name as a child of the current path.
81 *
82 * @param name the name to add as a child
83 */
84 public void addChild(final String name) {
85 if (_allowChildrenOrAtts) {
86 _path.add(name);
87 }
88 }
89
90 /**
91 * Adds the name as a parent of the current path.
92 *
93 * @param name the name to add as a parent
94 */
95 public void addParent(final String name) {
96 _path.insertElementAt(name, 0);
97 }
98
99 /**
100 * Returns the String representation of this XPathLocation.
101 *
102 * @return the String representation of this XPathLocation.
103 */
104 public String toString() {
105 return "XPATH: /" + StringUtils.join(_path, '/');
106 }
107
108 }