org.tmatesoft.svn.core.wc

Class SVNCommitPacket

public class SVNCommitPacket extends Object

The SVNCommitPacket is a storage for SVNCommitItem objects which represent information on versioned items intended for being committed to a repository.

Used by SVNCommitClient in (File[], boolean, boolean, boolean) doCollectCommitItems() to collect and hold information on paths that have local changes.

Version: 1.1.1

Author: TMate Software Ltd.

See Also: SVNCommitItem

Field Summary
static SVNCommitPacketEMPTY
This constant denotes an empty commit items storage (contains no SVNCommitItem objects).
Method Summary
voiddispose()
Disposes the current object.
SVNCommitItem[]getCommitItems()
Gets an array of SVNCommitItem objects stored in this object.
booleanisCommitItemSkipped(SVNCommitItem item)
Determines if an item intended for a commit is set to be skipped - that is not to be committed.
booleanisDisposed()
Determines if this object is disposed.
voidsetCommitItemSkipped(SVNCommitItem item, boolean skipped)
Sets or unsets a versioned item to be skipped - whether or not it should be committed.
StringtoString()
Gives a string representation of this object.

Field Detail

EMPTY

public static final SVNCommitPacket EMPTY
This constant denotes an empty commit items storage (contains no SVNCommitItem objects).

Method Detail

dispose

public void dispose()
Disposes the current object.

Throws: SVNException

getCommitItems

public SVNCommitItem[] getCommitItems()
Gets an array of SVNCommitItem objects stored in this object.

Returns: an array of SVNCommitItem objects containing info of versioned items to be committed

isCommitItemSkipped

public boolean isCommitItemSkipped(SVNCommitItem item)
Determines if an item intended for a commit is set to be skipped - that is not to be committed.

Parameters: item an item to check

Returns: true if the item is set to be skipped, otherwise false

See Also: SVNCommitPacket

isDisposed

public boolean isDisposed()
Determines if this object is disposed.

Returns: true if disposed otherwise false

setCommitItemSkipped

public void setCommitItemSkipped(SVNCommitItem item, boolean skipped)
Sets or unsets a versioned item to be skipped - whether or not it should be committed.

Parameters: item an item that should be marked skipped skipped if true the item is set to be skipped (a commit operation should skip the item), otherwise - unskipped if it was previously marked skipped

See Also:

toString

public String toString()
Gives a string representation of this object.

Returns: a string representing this object.

Copyright © 2004-2007 TMate Software Ltd. All Rights Reserved.