001: /*
002: * ====================================================================
003: *
004: * The Apache Software License, Version 1.1
005: *
006: * Copyright (c) 1999-2003 The Apache Software Foundation.
007: * All rights reserved.
008: *
009: * Redistribution and use in source and binary forms, with or without
010: * modification, are permitted provided that the following conditions
011: * are met:
012: *
013: * 1. Redistributions of source code must retain the above copyright
014: * notice, this list of conditions and the following disclaimer.
015: *
016: * 2. Redistributions in binary form must reproduce the above copyright
017: * notice, this list of conditions and the following disclaimer in
018: * the documentation and/or other materials provided with the
019: * distribution.
020: *
021: * 3. The end-user documentation included with the redistribution, if
022: * any, must include the following acknowledgement:
023: * "This product includes software developed by the
024: * Apache Software Foundation (http://www.apache.org/)."
025: * Alternately, this acknowledgement may appear in the software itself,
026: * if and wherever such third-party acknowledgements normally appear.
027: *
028: * 4. The names "The Jakarta Project", "Commons", and "Apache Software
029: * Foundation" must not be used to endorse or promote products derived
030: * from this software without prior written permission. For written
031: * permission, please contact apache@apache.org.
032: *
033: * 5. Products derived from this software may not be called "Apache"
034: * nor may "Apache" appear in their names without prior written
035: * permission of the Apache Software Foundation.
036: *
037: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
038: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
039: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
040: * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
041: * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
042: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
043: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
044: * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
045: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
046: * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
047: * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
048: * SUCH DAMAGE.
049: * ====================================================================
050: *
051: * This software consists of voluntary contributions made by many
052: * individuals on behalf of the Apache Software Foundation. For more
053: * information on the Apache Software Foundation, please see
054: * <http://www.apache.org/>.
055: *
056: */
057:
058: package org.apache.commons.jrcs.diff.myers;
059:
060: /**
061: * A node in a diffpath.
062: *
063: * @version $Revision: 7756 $ $Date: 2006-04-12 18:30:19 +0100 (Wed, 12 Apr
064: * 2006) $
065: * @author <a href="mailto:juanco@suigeneris.org">Juanco Anez</a>
066: * @see DiffNode
067: * @see Snake
068: */
069: public abstract class PathNode {
070: /** Position in the original sequence. */
071: public final int i;
072:
073: /** Position in the revised sequence. */
074: public final int j;
075:
076: /** The previous node in the path. */
077: public final PathNode prev;
078:
079: /**
080: * Concatenates a new path node with an existing diffpath.
081: *
082: * @param i
083: * The position in the original sequence for the new node.
084: * @param j
085: * The position in the revised sequence for the new node.
086: * @param prev
087: * The previous node in the path.
088: */
089: public PathNode(int i, int j, PathNode prev) {
090: this .i = i;
091: this .j = j;
092: this .prev = prev;
093: }
094:
095: /**
096: * Is this node a {@link Snake Snake node}?
097: *
098: * @return true if this is a {@link Snake Snake node}
099: */
100: public abstract boolean isSnake();
101:
102: /**
103: * Is this a bootstrap node?
104: * <p>
105: * In bottstrap nodes one of the two corrdinates is less than zero.
106: *
107: * @return tru if this is a bootstrap node.
108: */
109: public boolean isBootstrap() {
110: return i < 0 || j < 0;
111: }
112:
113: /**
114: * Skips sequences of {@link DiffNode DiffNodes} until a {@link Snake} or
115: * bootstrap node is found, or the end of the path is reached.
116: *
117: * @return The next first {@link Snake} or bootstrap node in the path, or
118: * <code>null</code> if none found.
119: */
120: public final PathNode previousSnake() {
121: if (isBootstrap())
122: return null;
123: if (!isSnake() && prev != null)
124: return prev.previousSnake();
125: return this ;
126: }
127:
128: /**
129: * {@inheritDoc}
130: */
131: public String toString() {
132: StringBuffer buf = new StringBuffer("[");
133: PathNode node = this ;
134: while (node != null) {
135: buf.append("(");
136: buf.append(Integer.toString(node.i));
137: buf.append(",");
138: buf.append(Integer.toString(node.j));
139: buf.append(")");
140: node = node.prev;
141: }
142: buf.append("]");
143: return buf.toString();
144: }
145: }
|