com.starteam
Class CheckinManager.WebCacheCheckinManager

java.lang.Object
  com.starteam.CheckinManager.WebCacheCheckinManager

Enclosing class:

CheckinManager

public static final class CheckinManager.WebCacheCheckinManager
extends java.lang.Object

Method Summary

void	addCheckinListener(WebCacheCheckinListener listener) Adds a listener for checkin-related events.
boolean	canCommit() return true if this checkin can be committed
void	checkinFrom(File.WebCacheFile starTeamFile, java.io.File diskFile) Set up a file to checkin from a working file on disk.
void	checkinFrom(File.WebCacheFile starTeamFile, java.io.InputStream stream) Set up a file to checkin from an input stream.
File.WebCacheFile[]	commit() commit the changes and return the results.
ChangePackage.WebCacheChangePackage	getChangePackage() Returns the Change Package created as the outcome of this checkin operation Returns NULL if this checkin has not yet run
CheckinOptions.WebCacheCheckinOptions	getOptions() Return the options associated with this checkin manager These options can be changed by the caller on demand
View.WebCacheView	getView() returns the containing view

Methods inherited from class java.lang.Object

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

Method Detail

getOptions

public CheckinOptions.WebCacheCheckinOptions getOptions()

Return the options associated with this checkin manager These options can be changed by the caller on demand

Returns:

the options associated with this checkin manager

checkinFrom

public void checkinFrom(File.WebCacheFile starTeamFile,
                        java.io.File diskFile)

Set up a file to checkin from a working file on disk. The file content is streamed to the server and this call blocks until complete, then returns. Once this method returns, the working file (on disk) is no longer required, and may be discarded Note that the file content is NOT retained in memory either The file revision in saved as part of the commit transaction, which includes the creation of the workspace change package. No status update is performed in this case. Creates a copy of the global options. Subsequent changes to global options do not affect this file

Parameters:

starTeamFile - The file to be checked in.

diskFile - The disk file from which the content is to be read

See Also:

CheckinManager.WebCacheCheckinManager.commit()

checkinFrom

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

Set up a file to checkin from an input stream. The file is checked in on commit. No status update is performed in this case. The file content is retained in memory in a byte array, so this api is extremely memory intensive. Additonally, log and history keyword substitution is not supported via streams Creates a copy of the global options. Subsequent changes to global options do not affect this file

Parameters:

starTeamFile - The file to be checked in.

stream - The stream from which the content is to be read.

See Also:

CheckinManager.WebCacheCheckinManager.commit()

canCommit

public boolean canCommit()

return true if this checkin can be committed

Returns:

true if this checkin can be committed

addCheckinListener

public void addCheckinListener(WebCacheCheckinListener listener)

Adds a listener for checkin-related events.

Parameters:

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

See Also:

WebCacheCheckinListener, WebCacheCheckinEvent

commit

public File.WebCacheFile[] commit()

commit the changes and return the results.

getChangePackage

public ChangePackage.WebCacheChangePackage getChangePackage()

Returns the Change Package created as the outcome of this checkin operation Returns NULL if this checkin has not yet run

Returns:

the Change Package created as the outcome of this checkin operation

getView

public View.WebCacheView getView()

returns the containing view

Returns:

the View