Top Description Fields Constructors Methods
com.github.difflib.patch

public final Class Chunk<T>

extends Object
implements Serializable
Class Inheritance
All Implemented Interfaces
java.io.Serializable
Type Parameters
<T>
The type of the compared elements in the 'lines'.
Imports
java.io.Serializable, java.util.ArrayList, .Arrays, .List, .Objects

Holds the information about the part of text involved in the diff process

Text is represented as Object[] because the diff engine is capable of handling more than plain ascci. In fact, arrays or lists of any type that implements hashCode() and equals() correctly can be subject to differencing using this library.

Author

Field Summary

Modifier and TypeField and Description
private final List<Integer>
private List<T>
private final int

Constructor Summary

AccessConstructor and Description
public
Chunk(int
the start position
position
,
List<T>
the affected lines
lines
,
List<Integer>
the positions of changed lines
changePosition
)

Creates a chunk and saves a copy of affected lines

public
Chunk(int
the start position
position
,
List<T>
the affected lines
lines
)

Creates a chunk and saves a copy of affected lines

public
Chunk(int
the start position
position
,
T[]
the affected lines
lines
,
List<Integer>
the positions of changed lines
changePosition
)

Creates a chunk and saves a copy of affected lines

public
Chunk(int
the start position
position
,
T[]
the affected lines
lines
)

Creates a chunk and saves a copy of affected lines

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(Object obj)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

public List<Integer>

Returns:

the positions of changed lines of chunk in the text
getChangePosition
()

public List<T>

Returns:

the affected lines
getLines
()

public int

Returns:

the start position of chunk in the text
getPosition
()

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public int
last()

Returns the index of the last line of the chunk.

public void
setLines(List<T> lines)

public int
size()

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

public VerifyChunk
verifyChunk(List<T>
the sequence to verify against.
target
)

Verifies that this chunk's saved text matches the corresponding text in the given sequence.

public VerifyChunk
verifyChunk(List<T>
the sequence to verify against.
target
,
int
the count of ignored prefix/suffix
fuzz
,
int
the position of target
position
)

Verifies that this chunk's saved text matches the corresponding text in the given sequence.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

changePositionback to summary
private final List<Integer> changePosition
linesback to summary
private List<T> lines
positionback to summary
private final int position

Constructor Detail

Chunkback to summary
public Chunk(int position, List<T> lines, List<Integer> changePosition)

Creates a chunk and saves a copy of affected lines

Parameters
position:int

the start position

lines:List<T>

the affected lines

changePosition:List<Integer>

the positions of changed lines

Chunkback to summary
public Chunk(int position, List<T> lines)

Creates a chunk and saves a copy of affected lines

Parameters
position:int

the start position

lines:List<T>

the affected lines

Chunkback to summary
public Chunk(int position, T[] lines, List<Integer> changePosition)

Creates a chunk and saves a copy of affected lines

Parameters
position:int

the start position

lines:T[]

the affected lines

changePosition:List<Integer>

the positions of changed lines

Chunkback to summary
public Chunk(int position, T[] lines)

Creates a chunk and saves a copy of affected lines

Parameters
position:int

the start position

lines:T[]

the affected lines

Method Detail

equalsback to summary
public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Annotations
@Override
getChangePositionback to summary
public List<Integer> getChangePosition()
Returns:List<Integer>

the positions of changed lines of chunk in the text

getLinesback to summary
public List<T> getLines()
Returns:List<T>

the affected lines

getPositionback to summary
public int getPosition()
Returns:int

the start position of chunk in the text

hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Annotations
@Override
lastback to summary
public int last()

Returns the index of the last line of the chunk.

setLinesback to summary
public void setLines(List<T> lines)
sizeback to summary
public int size()
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Annotations
@Override
verifyChunkback to summary
public VerifyChunk verifyChunk(List<T> target) throws PatchFailedException

Verifies that this chunk's saved text matches the corresponding text in the given sequence.

Parameters
target:List<T>

the sequence to verify against.

verifyChunkback to summary
public VerifyChunk verifyChunk(List<T> target, int fuzz, int position) throws PatchFailedException

Verifies that this chunk's saved text matches the corresponding text in the given sequence.

Parameters
target:List<T>

the sequence to verify against.

fuzz:int

the count of ignored prefix/suffix

position:int

the position of target