com.starbase.starteam
Class CheckinManager

java.lang.Object
  |
  +--com.starbase.starteam.CheckinManager

public class CheckinManager

extends java.lang.Object

Provides a way to check out multiple files, applying a consistent set of options across all files.

Constructor Summary

CheckinManager(View view)
Deprecated. Use View.createCheckinManager() instead.

CheckinManager(View view, CheckinManager checkinManager)
Deprecated.

CheckinManager(View view, CheckinOptions options)
Deprecated. Use View.createCheckinManager(CheckinOptions) instead.

Method Summary

void	addCheckinListener(CheckinListener listener) Adds a listener for checkin-related events.
void	checkin(File file) Checks in a single file from the default location.
void	checkin(Folder folder) Checks in all the files in the given folder.
void	checkin(Folder folder, int depth) Checks in all the files in the given folder, and in all subfolders to the given depth.
void	checkin(Item[] files) Checks in the given set of files.
void	checkin(ItemList files) Checks in the given set of files.
void	checkin(Items files) Checks in the given set of files.
void	checkinFrom(File file, java.io.File workingFile) Checks in a single file from an alternate location.
void	checkinFrom(File file, java.io.InputStream stream) Checks in a single file from an output stream.
java.lang.Object	clone() Clone a checkin manager from this one
boolean	equals(java.lang.Object source) returns true if this object instance is equal to the source
CheckinOptions	getOptions() Gets the checkin options currently in effect.
CheckinProgress	getProgress() Gets a snapshot of the state of the current checkin operation.
int	hashCode() returns a unique hash for all instances of this type
boolean	isCanceled() Indicates whether or not pending checkin operations have been canceled.
boolean	isRunning() Determines whether or not there is currently a checkin operation in progress.
void	removeCheckinListener(CheckinListener listener) Removes a listener for checkin-related events.
void	setCanceled() Cancels any pending checkin operations.
void	setOptions(CheckinOptions checkinOptions) Changes the checkin options currently in effect.
java.lang.String	toString() Gets a string representation of this CheckinManager, useful for debugging.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CheckinManager

public CheckinManager(View view)

Deprecated. Use View.createCheckinManager() instead.

Constructs a CheckinManager with default options.

Parameters:

view - The View containing the files to be checked in.

CheckinManager

public CheckinManager(View view,
                      CheckinOptions options)

Deprecated. Use View.createCheckinManager(CheckinOptions) instead.

Constructs a CheckinManager using a specific set of options.

Note that individual options can be overridden on a file-by-file basis by registering a CheckinListener, and changing options as necessary in the onStartFile event handler.

Parameters:

view - The View containing the files to be checked in.

options - The specific CheckinOtions to be used.

See Also:

CheckinOptions, CheckinManager.addCheckinListener(com.starbase.starteam.CheckinListener), CheckinListener.onStartFile(com.starbase.starteam.CheckinEvent)

CheckinManager

public CheckinManager(View view,
                      CheckinManager checkinManager)

Deprecated.

Constructs a CheckinManager with the same options as the given one.

Parameters:

view - The View containing the files to be checked in.

checkinManager - The CheckinManager whose options are to be copied.

Method Detail

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Clone a checkin manager from this one

Overrides:

clone in class java.lang.Object

Returns:

Object an instance of a checkin manager

java.lang.CloneNotSupportedException

setCanceled

public void setCanceled()

Cancels any pending checkin operations.

See Also:

CheckinManager.isCanceled()

isCanceled

public boolean isCanceled()

Indicates whether or not pending checkin operations have been canceled.

Returns:

true if pending checkin operations have been canceled, and false otherwise.

See Also:

CheckinManager.setCanceled()

checkin

public void checkin(File file)

Checks in a single file from the default location.

Parameters:

file - The file to be checked in.

checkinFrom

public void checkinFrom(File file,
                        java.io.File workingFile)

Checks in a single file from an alternate location.

Parameters:

file - The file to be checked in.

workingFile - The alternate working file.

checkinFrom

public void checkinFrom(File file,
                        java.io.InputStream stream)

Checks in a single file from an output stream. No status update is performed in this case.

Parameters:

file - The file to be checked in.

stream - The stream to which the checked in content is written.

checkin

public void checkin(Items files)

Checks in the given set of files.

Parameters:

files - The files to be checked in.

See Also:

Items, ItemListManager.getItems(), ItemListManager.getItemsForFolder(com.starbase.starteam.Folder, boolean), ItemListManager.selectByLabel(com.starbase.starteam.Label), ItemListManager.selectByQuery(com.starbase.starteam.QueryInfo)

checkin

public void checkin(ItemList files)

Checks in the given set of files.

Parameters:

files - The files to be checked in.

See Also:

ItemList

checkin

public void checkin(Item[] files)

Checks in the given set of files.

Parameters:

files - The files to be checked in.

See Also:

Folder.getItems(java.lang.String)

checkin

public void checkin(Folder folder)

Checks in all the files in the given folder.

Parameters:

folder - The StarTeam folder whose files are to be checked in.

See Also:

Folder, CheckinManager.checkin(Folder,int)

checkin

public void checkin(Folder folder,
                    int depth)

Checks in all the files in the given folder, and in all subfolders to the given depth.

Parameters:

folder - The StarTeam folder whose files are to be checked in.

depth - Indicates which subfolders also contain files to be checked in. Zero indicates that no subfolders should be included; 1 indicates that this folder and its immediate child folders should be included; -1 indicates that this folder and all child folders at any depth should be included.

isRunning

public boolean isRunning()

Determines whether or not there is currently a checkin operation in progress.

Returns:

true if there is currently a checkin operation in progress, and false otherwise.

addCheckinListener

public void addCheckinListener(CheckinListener listener)

Adds a listener for checkin-related events.

Parameters:

listener - Application-specific event handler for checkin-related events.

See Also:

CheckinListener, CheckinEvent, CheckinManager.removeCheckinListener(com.starbase.starteam.CheckinListener)

removeCheckinListener

public void removeCheckinListener(CheckinListener listener)

Removes a listener for checkin-related events.

Parameters:

listener - A previously-registered event handler for checkin-related events.

See Also:

CheckinManager.addCheckinListener(com.starbase.starteam.CheckinListener)

toString

public java.lang.String toString()

Gets a string representation of this CheckinManager, useful for debugging.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this CheckinManager.

getOptions

public CheckinOptions getOptions()

Gets the checkin options currently in effect.

Note that individual options can be overridden on a file-by-file basis by registering a CheckinListener, and changing options as necessary in the onStartFile event handler.

Returns:

The checkin options currently in effect.

See Also:

CheckinOptions, CheckinManager.addCheckinListener(com.starbase.starteam.CheckinListener), CheckinListener.onStartFile(com.starbase.starteam.CheckinEvent)

setOptions

public void setOptions(CheckinOptions checkinOptions)

Changes the checkin options currently in effect.

Parameters:

checkinOptions - The new checkin options.

getProgress

public CheckinProgress getProgress()

Gets a snapshot of the state of the current checkin operation.

Returns:

A snapshot of the state of the current checkin operation.

See Also:

CheckinProgress, CheckinManager.isRunning(), CheckinEvent#getProgress

equals

public boolean equals(java.lang.Object source)

returns true if this object instance is equal to the source

Overrides:

equals in class java.lang.Object

Parameters:

source - Object the source to comapre with

Returns:

boolean true if this object is equal to the source

hashCode

public int hashCode()

returns a unique hash for all instances of this type

Overrides:

hashCode in class java.lang.Object

Returns:

int a unique hash for all instances of this type