VcsDirtyScopeImpl (Unofficial IntelliJ Community Edition API docs)

java.lang.Object
- com.intellij.openapi.vcs.changes.VcsDirtyScope
- - com.intellij.openapi.vcs.changes.VcsModifiableDirtyScope
  - - com.intellij.openapi.vcs.changes.VcsDirtyScopeImpl

public class VcsDirtyScopeImpl
extends VcsModifiableDirtyScope

Constructor Summary

Constructors
Constructor and Description

VcsDirtyScopeImpl(AbstractVcs vcs)

VcsDirtyScopeImpl(AbstractVcs vcs, boolean wasEverythingDirty)

Constructors
Constructor and Description
`VcsDirtyScopeImpl(AbstractVcs vcs)`
`VcsDirtyScopeImpl(AbstractVcs vcs, boolean wasEverythingDirty)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addDirtyDirRecursively(FilePath newcomer)` Add dirty directory recursively.
`void`	`addDirtyFile(FilePath newcomer)` Add dirty file to the scope.
`void`	`addDirtyPathFast(FilePath filePath, boolean recursively)` Add file path into the sets, without removing potential duplicates.
`boolean`	`belongsTo(FilePath path)` Check if the path belongs to the dirty scope.
`java.util.Collection<VirtualFile>`	`getAffectedContentRoots()`
`java.util.Set<FilePath>`	`getDirtyFiles()` Get dirty files and directories.
`java.util.Set<FilePath>`	`getDirtyFilesNoExpand()` Get dirty files and directories.
`Project`	`getProject()`
`java.util.Set<FilePath>`	`getRecursivelyDirtyDirectories()` Get recursively dirty directories.
`AbstractVcs`	`getVcs()`
`boolean`	`isEmpty()`
`void`	`iterate(Processor<? super FilePath> iterator)` Invoke the `iterator` for all files in the dirty scope.
`void`	`iterateExistingInsideScope(Processor<? super VirtualFile> processor)`
`void`	`pack()` Remove potential duplicates from the sets.
`java.lang.String`	`toString()`
`boolean`	`wasEveryThingDirty()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - VcsDirtyScopeImpl
```
public VcsDirtyScopeImpl(AbstractVcs vcs)
```
  - VcsDirtyScopeImpl
```
public VcsDirtyScopeImpl(AbstractVcs vcs,
                         boolean wasEverythingDirty)
```
- Method Detail
  - getAffectedContentRoots
```
public java.util.Collection<VirtualFile> getAffectedContentRoots()
```
    Specified by:
    
    getAffectedContentRoots in class VcsDirtyScope
    
    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:
    
    VcsDirtyScope.getRecursivelyDirtyDirectories(), VcsDirtyScope.getDirtyFiles(), ProjectLevelVcsManager.getVcsRootFor(FilePath)
  - getProject
```
public Project getProject()
```
    Specified by:
    
    getProject in class VcsDirtyScope
    
    Returns:
    
    project for this dirty scope
  - getVcs
```
public AbstractVcs getVcs()
```
    Specified by:
    
    getVcs in class VcsDirtyScope
    
    Returns:
    
    the vcs for this dirty scope
  - getDirtyFiles
```
public java.util.Set<FilePath> getDirtyFiles()
```
    Description copied from class: VcsDirtyScope
    
    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 VcsDirtyScope.getRecursivelyDirtyDirectories().
    
    Specified by:
    
    getDirtyFiles in class VcsDirtyScope
    
    Returns:
    
    the set of dirty file or directories with all directory children added.
  - getDirtyFilesNoExpand
```
public java.util.Set<FilePath> getDirtyFilesNoExpand()
```
    Description copied from class: VcsDirtyScope
    
    Get dirty files and directories. This method differs from VcsDirtyScope.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.
    
    Specified by:
    
    getDirtyFilesNoExpand in class VcsDirtyScope
    
    Returns:
    
    the set of dirty file or directories without implied directory children.
  - getRecursivelyDirtyDirectories
```
public java.util.Set<FilePath> getRecursivelyDirtyDirectories()
```
    Description copied from class: VcsDirtyScope
    
    Get recursively dirty directories.
    
    Specified by:
    
    getRecursivelyDirtyDirectories in class VcsDirtyScope
    
    Returns:
    
    a directories that are recursively dirty.
  - addDirtyPathFast
```
public void addDirtyPathFast(FilePath filePath,
                             boolean recursively)
```
    Add file path into the sets, without removing potential duplicates. See pack(), that will be called later to perform this optimization.
    Use addDirtyFile(com.intellij.openapi.vcs.FilePath) / addDirtyDirRecursively(com.intellij.openapi.vcs.FilePath) to add file path and remove duplicates.
  - pack
```
public void pack()
```
    Remove potential duplicates from the sets.
  - addDirtyDirRecursively
```
public void addDirtyDirRecursively(FilePath newcomer)
```
    Add dirty directory recursively. If there are already dirty entries that are descendants or ancestors for the added directory, the contained entries are dropped from scope.
    
    Specified by:
    
    addDirtyDirRecursively in class VcsModifiableDirtyScope
    
    Parameters:
    
    newcomer - a new directory to add
  - addDirtyFile
```
public void addDirtyFile(FilePath newcomer)
```
    Add dirty file to the scope. Note that file is not added if its ancestor was added as dirty recursively or if its parent is in already in the dirty scope. Also immediate non-directory children are removed from the set of dirty files.
    
    Specified by:
    
    addDirtyFile in class VcsModifiableDirtyScope
    
    Parameters:
    
    newcomer - a file or directory added to the dirty scope.
  - iterate
```
public void iterate(Processor<? super FilePath> iterator)
```
    Description copied from class: VcsDirtyScope
    
    Invoke the iterator for all files in the dirty scope. For recursively dirty directories all children are processed.
    
    Specified by:
    
    iterate in class VcsDirtyScope
    
    Parameters:
    
    iterator - an iterator to invoke
  - iterateExistingInsideScope
```
public void iterateExistingInsideScope(Processor<? super VirtualFile> processor)
```
    Specified by:
    
    iterateExistingInsideScope in class VcsDirtyScope
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in class VcsDirtyScope
  - belongsTo
```
public boolean belongsTo(FilePath path)
```
    Description copied from class: VcsDirtyScope
    
    Check if the path belongs to the dirty scope.
    
    Specified by:
    
    belongsTo in class VcsDirtyScope
    
    Parameters:
    
    path - a path to check
    
    Returns:
    
    true if path belongs to the dirty scope.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - wasEveryThingDirty
```
public boolean wasEveryThingDirty()
```
    Overrides:
    
    wasEveryThingDirty in class VcsDirtyScope

Class VcsDirtyScopeImpl

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

VcsDirtyScopeImpl

VcsDirtyScopeImpl

Method Detail

getAffectedContentRoots

getProject

getVcs

getDirtyFiles

getDirtyFilesNoExpand

getRecursivelyDirtyDirectories

addDirtyPathFast

pack

addDirtyDirRecursively

addDirtyFile

iterate

iterateExistingInsideScope

isEmpty

belongsTo

toString

wasEveryThingDirty