Package com.intellij.vcs.log

Interface VcsLogUserFilter

All Superinterfaces:

VcsLogDetailsFilter, VcsLogFilter

public interface VcsLogUserFilter
extends VcsLogDetailsFilter

Filters commits by one or several users.

Method Summary

Modifier and Type	Method and Description
default java.lang.String	getDisplayText()
default VcsLogFilterCollection.FilterKey<VcsLogUserFilter>	getKey()
java.util.Collection<VcsUser>	getUsers(VirtualFile root) Returns users selected in the filter, concerning the passed VCS root.
java.util.Collection<java.lang.String>	getValuesAsText() Filter values in text format, such that the filter could be later restored from it.

Methods inherited from interface com.intellij.vcs.log.VcsLogDetailsFilter

matches

Method Detail

getUsers

java.util.Collection<VcsUser> getUsers(VirtualFile root)

Returns users selected in the filter, concerning the passed VCS root.

Parameters:

root - has no effect if user chooses some user name; it is needed if user selects the predefined value "me" which means the current user. Since current user name can be defined differently for different roots, we pass the root for which this value is requested.

getValuesAsText

java.util.Collection<java.lang.String> getValuesAsText()

Filter values in text format, such that the filter could be later restored from it.

getDisplayText

default java.lang.String getDisplayText()

Specified by:

getDisplayText in interface VcsLogFilter

getKey

default VcsLogFilterCollection.FilterKey<VcsLogUserFilter> getKey()

Specified by:

getKey in interface VcsLogFilter