com.starbase.starteam.viewcomparemerge
Class FolderScope

java.lang.Object
  |
  +--com.starbase.starteam.viewcomparemerge.Scope
        |
        +--com.starbase.starteam.viewcomparemerge.FolderScope

public class FolderScope

extends Scope

Allows folders to be included or excluded from the scope of the view compare/merge operation in a flexible way.

See Also:

Session#addScope, Scope

Constructor Summary

FolderScope(Folder f)
Creates a new FolderScope that includes the files in the given source folder.

FolderScope(Folder f, boolean bIncludeSubfolders)
Creates a new FolderScope that includes the files in the given source folder, and optionally in all of its child folders at any depth.

FolderScope(Folder f, boolean bIncludeSubfolders, Type type)
Creates a new FolderScope that includes the files in the given source folder, and optionally in all of its child folders at any depth.

FolderScope(Folder f, boolean bIncludeSubfolders, Type[] types)

FolderScope(FolderListManager folders)
Creates a new FolderScope that includes all of the folders indicated by the given FolderListManager.

FolderScope(FolderListManager folders, Type type)

FolderScope(FolderListManager folders, Type[] types)

FolderScope(Folder f, Type type)
Creates a new FolderScope that includes the items of the given type in the given source folder.

FolderScope(Folder f, Type[] types)
Creates a new FolderScope that includes the items of all of the given types in the given source folder.

Methods inherited from class java.lang.Object

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

Constructor Detail

FolderScope

public FolderScope(Folder f)

Creates a new FolderScope that includes the files in the given source folder.

Parameters:

f - A folder in the source view.

FolderScope

public FolderScope(Folder f,
                   Type type)

Creates a new FolderScope that includes the items of the given type in the given source folder.

Parameters:

f - A folder in the source view.

type - An item type.

FolderScope

public FolderScope(Folder f,
                   Type[] types)

Creates a new FolderScope that includes the items of all of the given types in the given source folder.

Parameters:

f - A folder in the source view.

types - A list of item types.

FolderScope

public FolderScope(Folder f,
                   boolean bIncludeSubfolders)

Creates a new FolderScope that includes the files in the given source folder, and optionally in all of its child folders at any depth.

Parameters:

f - A folder in the source view.

bIncludeSubfolders - true to include files in child folders; false to include only the files in the folder itself.

FolderScope

public FolderScope(Folder f,
                   boolean bIncludeSubfolders,
                   Type type)

Creates a new FolderScope that includes the files in the given source folder, and optionally in all of its child folders at any depth.

Parameters:

f - A folder in the source view.

bIncludeSubfolders - true to include files in child folders; false to include only the files in the folder itself.

FolderScope

public FolderScope(Folder f,
                   boolean bIncludeSubfolders,
                   Type[] types)

FolderScope

public FolderScope(FolderListManager folders)

Creates a new FolderScope that includes all of the folders indicated by the given FolderListManager.

The client application is free to include or exlude folders from the FolderListManager at any time. Changes will be reflected in the scope after the next refresh().

Parameters:

folders - The FolderListManager that describes the scope.

See Also:

FolderListManager

FolderScope

public FolderScope(FolderListManager folders,
                   Type type)

FolderScope

public FolderScope(FolderListManager folders,
                   Type[] types)