org.openzen.zengarden.delta

Class StringDelta

java.lang.Object

org.openzen.zengarden.delta.StringDelta

All Implemented Interfaces:

DataDelta<java.lang.String>

public class StringDelta
extends java.lang.Object
implements DataDelta<java.lang.String>

Contains the difference between two strings.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StringDelta.StringUpdateBuilder

Constructor Summary

Constructors

Constructor and Description
StringDelta(byte[] data) Constructs a string diff from the given binary data.
StringDelta(DataInput input) Deserializes a string diff from the given input.

Method Summary

Modifier and Type	Method and Description
static StringDelta	create(java.lang.String value) Constructs a string diff which will always expand into the given string.
<T,R> R	decode(StringUpdater<T,R> update) Performs a decode operation.
static StringDelta	diff(java.lang.String original, java.lang.String modified) Calculates the difference between two given strings.
static StringDelta.StringUpdateBuilder	getBuilder() Constructs a new string builder.
int	length()
static StringDelta	read(DataInput input) Reads a string diff from the given input stream.
void	serialize(DataOutput output) Serializes the diff to the given output stream.
StringDelta	shift(StringDelta other) Shifts the string updates to match the updates of another string update.
java.lang.String	toString()
java.lang.String	update(java.lang.String original) Updates the given value.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

StringDelta

public StringDelta(byte[] data)

Constructs a string diff from the given binary data.

Parameters:

data - encoded diff dta

StringDelta

public StringDelta(DataInput input)
            throws java.io.IOException

Deserializes a string diff from the given input.

Parameters:

input - input stream

Throws:

java.io.IOException - if an I/O error occurs

Method Detail

create

public static StringDelta create(java.lang.String value)

Constructs a string diff which will always expand into the given string.

Parameters:

value - value to create the diff for

Returns:

literal string diff

diff

public static StringDelta diff(java.lang.String original,
                               java.lang.String modified)

Calculates the difference between two given strings. There is no guarantee that the given diff will be minimal, but a best effort is made to do so.

Parameters:

original - original (old) string

modified - modified (new) string

Returns:

difference between the two strings

read

public static StringDelta read(DataInput input)
                        throws java.io.IOException

Reads a string diff from the given input stream.

Parameters:

input - input stream to read from

Returns:

deserialized string diff

Throws:

java.io.IOException - if an I/O error occurs

decode

public <T,R> R decode(StringUpdater<T,R> update)

Performs a decode operation. Calculates the updater for every update action in this diff.

Type Parameters:

T - intermediate result type

R - result type

Parameters:

update - update callback

Returns:

resulting value

shift

public StringDelta shift(StringDelta other)

Shifts the string updates to match the updates of another string update. Applying the other update + the shifted update will then result in a proper combination of both edits. Used in the merging of changes.

Parameters:

other - updates to be matched to

Returns:

shifted updates

serialize

public void serialize(DataOutput output)
               throws java.io.IOException

Description copied from interface: DataDelta

Serializes the diff to the given output stream.

Specified by:

serialize in interface DataDelta<java.lang.String>

Parameters:

output - output stream

Throws:

java.io.IOException - if an I/O error occurs

length

public int length()

update

public java.lang.String update(java.lang.String original)

Description copied from interface: DataDelta

Updates the given value. The value must be the original value used to make the diff; otherwise the output is undetermined.

Specified by:

update in interface DataDelta<java.lang.String>

Parameters:

original - original value

Returns:

modified value

getBuilder

public static StringDelta.StringUpdateBuilder getBuilder()

Constructs a new string builder. Can be used for custom diff algorithms.

Returns:

string update builder

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object