Package com.intellij.openapi.vcs.changes

Class VcsDirtyScope

java.lang.Object

com.intellij.openapi.vcs.changes.VcsDirtyScope

Direct Known Subclasses:

VcsModifiableDirtyScope

public abstract class VcsDirtyScope
extends java.lang.Object

The dirty scope for a version control system. The instance of this interface is passed to implementers of the ChangeProvider interface to the method ChangeProvider.getChanges(VcsDirtyScope, ChangelistBuilder, com.intellij.openapi.progress.ProgressIndicator, ChangeListManagerGate).

The instance of this class is valid only while the project is valid.

Constructor Summary

Constructors

Constructor and Description
VcsDirtyScope()

Method Summary

Modifier and Type	Method and Description
abstract boolean	belongsTo(FilePath path) Check if the path belongs to the dirty scope.
abstract java.util.Collection<VirtualFile>	getAffectedContentRoots()
abstract java.util.Set<FilePath>	getDirtyFiles() Get dirty files and directories.
abstract java.util.Set<FilePath>	getDirtyFilesNoExpand() Get dirty files and directories.
abstract Project	getProject()
abstract java.util.Set<FilePath>	getRecursivelyDirtyDirectories() Get recursively dirty directories.
abstract AbstractVcs	getVcs()
abstract boolean	isEmpty()
abstract void	iterate(Processor<? super FilePath> iterator) Invoke the iterator for all files in the dirty scope.
abstract void	iterateExistingInsideScope(Processor<? super VirtualFile> vf)
boolean	wasEveryThingDirty()

Methods inherited from class java.lang.Object

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

Constructor Detail

VcsDirtyScope

public VcsDirtyScope()

Method Detail

getAffectedContentRoots

public abstract java.util.Collection<VirtualFile> getAffectedContentRoots()

Returns:

a set of content roots affected. The content root is considered affected if there is at least one descendant dirty file or directory which is under this content root.

See Also:

getRecursivelyDirtyDirectories(), getDirtyFiles(), ProjectLevelVcsManager.getVcsRootFor(FilePath)

getProject

public abstract Project getProject()

Returns:

project for this dirty scope

getVcs

public abstract AbstractVcs getVcs()

Returns:

the vcs for this dirty scope

getDirtyFiles

public abstract java.util.Set<FilePath> getDirtyFiles()

Get dirty files and directories. Note if the directory is listed as dirty, all files in it are also considered dirty and they are returned by this method. Note that this method does not list files that are returned by getRecursivelyDirtyDirectories().

Returns:

the set of dirty file or directories with all directory children added.

getDirtyFilesNoExpand

public abstract java.util.Set<FilePath> getDirtyFilesNoExpand()

Get dirty files and directories. This method differs from getDirtyFiles() that it does not adds all children to the set of the dirty files automatically. The invoker should process the children of valid directories themselves.

Returns:

the set of dirty file or directories without implied directory children.

getRecursivelyDirtyDirectories

public abstract java.util.Set<FilePath> getRecursivelyDirtyDirectories()

Get recursively dirty directories.

Returns:

a directories that are recursively dirty.

iterate

public abstract void iterate(Processor<? super FilePath> iterator)

Invoke the iterator for all files in the dirty scope. For recursively dirty directories all children are processed.

Parameters:

iterator - an iterator to invoke

iterateExistingInsideScope

public abstract void iterateExistingInsideScope(Processor<? super VirtualFile> vf)

isEmpty

public abstract boolean isEmpty()

belongsTo

public abstract boolean belongsTo(FilePath path)

Check if the path belongs to the dirty scope.

Parameters:

path - a path to check

Returns:

true if path belongs to the dirty scope.

wasEveryThingDirty

public boolean wasEveryThingDirty()