jrcs/diff/Delta.java

8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik/*
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik * ====================================================================
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik *
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik * The Apache Software License, Version 1.1
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik *
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik * Copyright (c) 1999-2003 The Apache Software Foundation.
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik * All rights reserved.
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik *
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik * Redistribution and use in source and binary forms, with or without
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik * modification, are permitted provided that the following conditions
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik * are met:
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik *
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik * 1. Redistributions of source code must retain the above copyright
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik *    notice, this list of conditions and the following disclaimer.
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik *
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik * 2. Redistributions in binary form must reproduce the above copyright
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik *    notice, this list of conditions and the following disclaimer in
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik *    the documentation and/or other materials provided with the
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik *    distribution.
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik *
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik * 3. The end-user documentation included with the redistribution, if
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik *    any, must include the following acknowledgement:
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik *       "This product includes software developed by the
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik *        Apache Software Foundation (http://www.apache.org/)."
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik *    Alternately, this acknowledgement may appear in the software itself,
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik *    if and wherever such third-party acknowledgements normally appear.
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik *
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik * 4. The names "The Jakarta Project", "Commons", and "Apache Software
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik *    Foundation" must not be used to endorse or promote products derived
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik *    from this software without prior written permission. For written
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik *    permission, please contact apache@apache.org.
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik *
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik * 5. Products derived from this software may not be called "Apache"
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik *    nor may "Apache" appear in their names without prior written
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik *    permission of the Apache Software Foundation.
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik *
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik * SUCH DAMAGE.
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik * ====================================================================
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik *
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik * This software consists of voluntary contributions made by many
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik * individuals on behalf of the Apache Software Foundation.  For more
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik * information on the Apache Software Foundation, please see
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik * <http://www.apache.org/>.
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik *
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik */
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvikpackage org.apache.commons.jrcs.diff;
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvikimport java.util.List;
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik/**
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik * Holds a "delta" difference between to revisions of a text.
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik *
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik * @version $Revision: 1.6 $ $Date: 2003/10/13 08:00:24 $
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik *
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik * @author <a href="mailto:juanco@suigeneris.org">Juanco Anez</a>
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik * @author <a href="mailto:bwm@hplb.hpl.hp.com">Brian McBride</a>
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik * @see Diff
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik * @see Chunk
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik * @see Revision
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik *
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik * modifications
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik *
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik * 27 Apr 2003 bwm
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik *
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik * Added getOriginal() and getRevised() accessor methods
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik * Added visitor pattern accept() method
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik */
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvikpublic abstract class Delta
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik    extends org.apache.commons.jrcs.util.ToString
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik{
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik    protected Chunk original;
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik    protected Chunk revised;
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik    static Class[][] DeltaClass;
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik    static
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik    {
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik        DeltaClass = new Class[2][2];
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik        try
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik        {
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik            DeltaClass[0][0] = org.apache.commons.jrcs.diff.ChangeDelta.class;
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik            DeltaClass[0][1] = org.apache.commons.jrcs.diff.AddDelta.class;
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik            DeltaClass[1][0] = org.apache.commons.jrcs.diff.DeleteDelta.class;
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik            DeltaClass[1][1] = org.apache.commons.jrcs.diff.ChangeDelta.class;
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik        }
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik        catch (Throwable o)
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik        {
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik        }
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik    }
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik    /**
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik     * Returns a Delta that corresponds to the given chunks in the
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik     * original and revised text respectively.
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik     * @param orig the chunk in the original text.
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik     * @param rev  the chunk in the revised text.
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik     */
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik    public static Delta newDelta(Chunk orig, Chunk rev)
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik    {
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik        Class c = DeltaClass[orig.size() > 0 ? 1 : 0]
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik            [rev.size() > 0 ? 1 : 0];
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik        Delta result;
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik        try
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik        {
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik            result = (Delta) c.newInstance();
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik        }
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik        catch (Throwable e)
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik        {
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik            return null;
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik        }
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik        result.init(orig, rev);
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik        return result;
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik    }
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik    /**
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik     * Creates an uninitialized delta.
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik     */
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik    protected Delta()
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik    {
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik    }
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik    /**
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik     * Creates a delta object with the given chunks from the original
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik     * and revised texts.
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik     */
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik    protected Delta(Chunk orig, Chunk rev)
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik    {
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik        init(orig, rev);
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik    }
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik    /**
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik     * Initializaes the delta with the given chunks from the original
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik     * and revised texts.
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik     */
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik    protected void init(Chunk orig, Chunk rev)
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik    {
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik        original = orig;
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik        revised = rev;
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik    }
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik    /**
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik     * Verifies that this delta can be used to patch the given text.
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik     * @param target the text to patch.
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik     * @throws PatchFailedException if the patch cannot be applied.
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik     */
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik    public abstract void verify(List target)
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik        throws PatchFailedException;
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik    /**
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik     * Applies this delta as a patch to the given text.
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik     * @param target the text to patch.
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik     * @throws PatchFailedException if the patch cannot be applied.
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik     */
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik    public final void patch(List target)
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik        throws PatchFailedException
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik    {
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik        verify(target);
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik        try
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik        {
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik            applyTo(target);
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik        }
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik        catch (Exception e)
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik        {
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik            throw new PatchFailedException(e.getMessage());
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik        }
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik    }
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik    /**
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik     * Applies this delta as a patch to the given text.
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik     * @param target the text to patch.
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik     * @throws PatchFailedException if the patch cannot be applied.
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik     */
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik    public abstract void applyTo(List target);
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik    /**
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik     * Converts this delta into its Unix diff style string representation.
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik     * @param s a {@link StringBuffer StringBuffer} to which the string
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik     * representation will be appended.
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik     */
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik    public void toString(StringBuffer s)
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik    {
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik        original.rangeString(s);
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik        s.append("x");
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik        revised.rangeString(s);
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik        s.append(Diff.NL);
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik        original.toString(s, "> ", "\n");
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik        s.append("---");
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik        s.append(Diff.NL);
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik        revised.toString(s, "< ", "\n");
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik    }
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik    /**
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik     * Converts this delta into its RCS style string representation.
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik     * @param s a {@link StringBuffer StringBuffer} to which the string
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik     * representation will be appended.
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik     * @param EOL the string to use as line separator.
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik     */
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik    public abstract void toRCSString(StringBuffer s, String EOL);
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik    /**
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik     * Converts this delta into its RCS style string representation.
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik     * @param EOL the string to use as line separator.
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik     */
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik    public String toRCSString(String EOL)
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik    {
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik        StringBuffer s = new StringBuffer();
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik        toRCSString(s, EOL);
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik        return s.toString();
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik    }
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik    /**
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik     * Accessor method to return the chunk representing the original
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik     * sequence of items
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik     *
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik     * @return the original sequence
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik     */
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik    public Chunk getOriginal()
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik    {
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik        return original;
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik    }
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik    /**
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik     * Accessor method to return the chunk representing the updated
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik     * sequence of items.
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik     *
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik     * @return the updated sequence
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik     */
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik    public Chunk getRevised()
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik    {
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik        return revised;
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik    }
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik    /**
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik     * Accepts a visitor.
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik     * <p>
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik     * See the Visitor pattern in "Design Patterns" by the GOF4.
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik     * @param visitor The visitor.
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik     */
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik    public abstract void accept(RevisionVisitor visitor);
8d22687fbdc540bd0b4d05fd90d87fb6037f4b9fJorgen Austvik}