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;
059:
060: import java.util.ArrayList;
061: import java.util.Arrays;
062: import java.util.Iterator;
063: import java.util.LinkedList;
064: import java.util.List;
065: import java.util.ListIterator;
066:
067: import org.apache.commons.jrcs.util.ToString;
068:
069: /**
070: * A Revision holds the series of deltas that describe the differences between
071: * two sequences.
072: *
073: * @version $Revision: 7756 $ $Date: 2006-04-12 18:30:19 +0100 (Wed, 12 Apr
074: * 2006) $
075: * @author <a href="mailto:juanco@suigeneris.org">Juanco Anez</a>
076: * @author <a href="mailto:bwm@hplb.hpl.hp.com">Brian McBride</a>
077: * @see Delta
078: * @see Diff
079: * @see Chunk
080: * @see Revision modifications 27 Apr 2003 bwm Added visitor pattern Visitor
081: * interface and accept() method.
082: */
083:
084: public class Revision extends ToString {
085:
086: List deltas_ = new LinkedList();
087:
088: /**
089: * Creates an empty Revision.
090: */
091: public Revision() {
092: }
093:
094: /**
095: * Adds a delta to this revision.
096: *
097: * @param delta
098: * the {@link Delta Delta} to add.
099: */
100: public synchronized void addDelta(Delta delta) {
101: if (delta == null) {
102: throw new IllegalArgumentException("new delta is null");
103: }
104: deltas_.add(delta);
105: }
106:
107: /**
108: * Adds a delta to the start of this revision.
109: *
110: * @param delta
111: * the {@link Delta Delta} to add.
112: */
113: public synchronized void insertDelta(Delta delta) {
114: if (delta == null) {
115: throw new IllegalArgumentException("new delta is null");
116: }
117: deltas_.add(0, delta);
118: }
119:
120: /**
121: * Retrieves a delta from this revision by position.
122: *
123: * @param i
124: * the position of the delta to retrieve.
125: * @return the specified delta
126: */
127: public Delta getDelta(int i) {
128: return (Delta) deltas_.get(i);
129: }
130:
131: /**
132: * Returns the number of deltas in this revision.
133: *
134: * @return the number of deltas.
135: */
136: public int size() {
137: return deltas_.size();
138: }
139:
140: /**
141: * Applies the series of deltas in this revision as patches to the given
142: * text.
143: *
144: * @param src
145: * the text to patch, which the method doesn't change.
146: * @return the resulting text after the patches have been applied.
147: * @throws PatchFailedException
148: * if any of the patches cannot be applied.
149: */
150: public Object[] patch(Object[] src) throws PatchFailedException {
151: List target = new ArrayList(Arrays.asList(src));
152: applyTo(target);
153: return target.toArray();
154: }
155:
156: /**
157: * Applies the series of deltas in this revision as patches to the given
158: * text.
159: *
160: * @param target
161: * the text to patch.
162: * @throws PatchFailedException
163: * if any of the patches cannot be applied.
164: */
165: public synchronized void applyTo(List target)
166: throws PatchFailedException {
167: ListIterator i = deltas_.listIterator(deltas_.size());
168: while (i.hasPrevious()) {
169: Delta delta = (Delta) i.previous();
170: delta.patch(target);
171: }
172: }
173:
174: /**
175: * Converts this revision into its Unix diff style string representation.
176: *
177: * @param s
178: * a {@link StringBuffer StringBuffer} to which the string
179: * representation will be appended.
180: */
181: public synchronized void toString(StringBuffer s) {
182: Iterator i = deltas_.iterator();
183: while (i.hasNext()) {
184: ((Delta) i.next()).toString(s);
185: }
186: }
187:
188: /**
189: * Converts this revision into its RCS style string representation.
190: *
191: * @param s
192: * a {@link StringBuffer StringBuffer} to which the string
193: * representation will be appended.
194: * @param EOL
195: * the string to use as line separator.
196: */
197: public synchronized void toRCSString(StringBuffer s, String EOL) {
198: Iterator i = deltas_.iterator();
199: while (i.hasNext()) {
200: ((Delta) i.next()).toRCSString(s, EOL);
201: }
202: }
203:
204: /**
205: * Converts this revision into its RCS style string representation.
206: *
207: * @param s
208: * a {@link StringBuffer StringBuffer} to which the string
209: * representation will be appended.
210: */
211: public void toRCSString(StringBuffer s) {
212: toRCSString(s, Diff.NL);
213: }
214:
215: /**
216: * Converts this delta into its RCS style string representation.
217: *
218: * @param EOL
219: * the string to use as line separator.
220: */
221: public String toRCSString(String EOL) {
222: StringBuffer s = new StringBuffer();
223: toRCSString(s, EOL);
224: return s.toString();
225: }
226:
227: /**
228: * Converts this delta into its RCS style string representation using the
229: * default line separator.
230: */
231: public String toRCSString() {
232: return toRCSString(Diff.NL);
233: }
234:
235: /**
236: * Accepts a visitor.
237: *
238: * @param visitor
239: * the {@link Visitor} visiting this instance
240: */
241: public void accept(RevisionVisitor visitor) {
242: visitor.visit(this );
243: Iterator iter = deltas_.iterator();
244: while (iter.hasNext()) {
245: ((Delta) iter.next()).accept(visitor);
246: }
247: }
248:
249: }
|