Package com.intellij.vcs.log

Interface VcsLogRefManager

All Known Implementing Classes:

GitRefManager, HgRefManager

public interface VcsLogRefManager

Sorts references of branches and tags according to their type, "expected importance" and other means.

Method Summary

Modifier and Type	Method and Description
VcsRefType	deserialize(java.io.DataInput in) Reads reference type from given input.
java.util.Comparator<VcsRef>	getBranchLayoutComparator() Returns the comparator which compares two given references, which represent heads (leafs) of the log graph, by their expected position in the log graph.
java.util.Comparator<VcsRef>	getLabelsOrderComparator() Return the comparator which compares two given references, to identify the order of branch labels in the log table and description.
java.util.List<RefGroup>	groupForBranchFilter(java.util.Collection<? extends VcsRef> refs) Groups VCS references to show them in branch filter.
java.util.List<RefGroup>	groupForTable(java.util.Collection<? extends VcsRef> refs, boolean compact, boolean showTagNames) Groups VCS references to show them in graph table.
boolean	isFavorite(VcsRef reference) Checks whether a reference is a favorite.
void	serialize(java.io.DataOutput out, VcsRefType type) Writes given reference type to the output.
void	setFavorite(VcsRef reference, boolean favorite) Marks or unmarks a reference as favorite.

Method Detail

getBranchLayoutComparator

java.util.Comparator<VcsRef> getBranchLayoutComparator()

Returns the comparator which compares two given references, which represent heads (leafs) of the log graph, by their expected position in the log graph.

The comparison result is used in graph layout to choose which branch should be laid at the left, and which - at the right. This layout order should be kept between log refreshes, when possible. Branches which are laid at the left are considered more important than which are laid at the right.

• Negative value is returned if the first branch should be laid out at the left from the second (i.e. "is more important").
• Positive value is returned if the first branch should be laid out at the right from the second (i.e. "is less important").
• Zero is returned for equal references.

It is guaranteed that the supplied collection is not empty.

The given collection may contain references from different roots.

See Also:

getLabelsOrderComparator()

getLabelsOrderComparator

java.util.Comparator<VcsRef> getLabelsOrderComparator()

Return the comparator which compares two given references, to identify the order of branch labels in the log table and description. References are compared by their position, more important references appear at the left from the less important.

• Negative value is returned if the first reference should appear at the left from the second (i.e. "is more important").
• Positive value is returned if the first reference should appear at the right from the second (i.e. "is less important").
• Zero is returned for equal references.

Note that this comparator not necessarily should be consistent with getBranchLayoutComparator().

See Also:

getBranchLayoutComparator()

groupForBranchFilter

java.util.List<RefGroup> groupForBranchFilter(java.util.Collection<? extends VcsRef> refs)

Groups VCS references to show them in branch filter.

Groups containing only one element will be displayed as a single ref. Others will provide a popup menu.

Groups must be pre-sorted in the order which they are to be painted on the panel.

groupForTable

java.util.List<RefGroup> groupForTable(java.util.Collection<? extends VcsRef> refs,
                                       boolean compact,
                                       boolean showTagNames)

Groups VCS references to show them in graph table. All references given to this method are from the same commit.

serialize

void serialize(java.io.DataOutput out,
               VcsRefType type)
        throws java.io.IOException

Writes given reference type to the output.

Parameters:

out - output to write type into

type - type to serialize

Throws:

java.io.IOException

deserialize

VcsRefType deserialize(java.io.DataInput in)
                throws java.io.IOException

Reads reference type from given input.

Parameters:

in - input to read type from

Returns:

reference type read from the input

Throws:

java.io.IOException

isFavorite

boolean isFavorite(VcsRef reference)

Checks whether a reference is a favorite.

Parameters:

reference - reference to check

Returns:

true if provided reference is a favorite, false otherwise

setFavorite

void setFavorite(VcsRef reference,
                 boolean favorite)

Marks or unmarks a reference as favorite.

Parameters:

reference - a reference to mark or unmark as favorite

favorite - true means to mark as favorite, false to unmark