eu.mais_h.mathsync

Interface Summary

All Known Implementing Classes:

FullContent

public interface Summary

Represents summarized data.

Note that instances must be immutable.

Method Summary

Methods

Modifier and Type	Method and Description
Summary	minus(byte[] item) Removes an item to the summary.
Summary	minus(Iterator<byte[]> items) Removes several items to the summary.
Summary	plus(byte[] item) Adds an item to the summary.
Summary	plus(Iterator<byte[]> items) Adds several items to the summary.
Difference<byte[]>	toDifference() Retrieves a view of the summary as a difference.
String	toJSON() Retrieves a JSON view of the summary.

Method Detail

plus

Summary plus(byte[] item)

Adds an item to the summary.

When both summaries can be viewed as a difference:

• if the item is in the removed set of that summary, it is in none of the resulting summary difference sets
• if the item is in none of the difference sets of that summary, it is in the added set of the resulting difference
• if the item is in the added set of that summary, the resulting summary may be impossible to decipher

Parameters:

item - the item to add.

Returns:

a new summary with the item being included.

plus

Summary plus(Iterator<byte[]> items)

Adds several items to the summary.

Equivalent to repeatedly calling plus(byte[]) for each element, but this method can do optimizations for batch updates.

Parameters:

items - the items to add.

Returns:

a new summary with the items being included.

minus

Summary minus(byte[] item)

Removes an item to the summary.

When both summaries can be viewed as a difference:

• if the item is in the added set of that summary, it is in none of the resulting summary difference sets
• if the item is in none of the difference sets of that summary, it is in the removed set of the resulting difference
• if the item is in the removed set of that summary, the resulting summary may be impossible to decipher

Parameters:

item - the item to remove.

Returns:

a new summary with the item being removed.

minus

Summary minus(Iterator<byte[]> items)

Removes several items to the summary.

Equivalent to repeatedly calling minus(byte[]) for each element, but this method can do optimizations for batch updates.

Parameters:

items - the items to remove.

Returns:

a new summary with the items being removed.

toJSON

String toJSON()

Retrieves a JSON view of the summary.

Returns:

a JSON view of the summary.

toDifference

Difference<byte[]> toDifference()

Retrieves a view of the summary as a difference.

Returns:

a difference view of the summary or null if it cannot be resolved with the information it contains.