Package org.tmatesoft.svn.core.wc
Class DefaultSVNCommitHandler
java.lang.Object
org.tmatesoft.svn.core.wc.DefaultSVNCommitHandler
- All Implemented Interfaces:
ISVNCommitHandler
This is a default implementation for ISVNCommitHandler.
Since methods of those SVN*Client classes that can initiate a commit operation use ISVNCommitHandler to process user's commit log messages there should be a default implementation. If no special implementation of ISVNCommitHandler is provided into those classes then DefaultSVNCommitHandler is the one that is used by default.
- Since:
- 1.2
- Version:
- 1.3
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionjava.lang.String
getCommitMessage
(java.lang.String message, SVNCommitItem[] commitables) Returns themessage
itself without any modifications to it or""
if themessage
is null.getRevisionProperties
(java.lang.String message, SVNCommitItem[] commitables, SVNProperties revisionProperties) ReturnsrevisionProperties
as is if it's not null, or an emptySVNProperties
object ifrevisionProperties
is null.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Constructor Details
-
DefaultSVNCommitHandler
public DefaultSVNCommitHandler()
-
-
Method Details
-
getCommitMessage
public java.lang.String getCommitMessage(java.lang.String message, SVNCommitItem[] commitables) throws SVNException Returns themessage
itself without any modifications to it or""
if themessage
is null.In other words this method does nothing except of replacing null for
""
.- Specified by:
getCommitMessage
in interfaceISVNCommitHandler
- Parameters:
message
- a user's initial commit log messagecommitables
- an array of SVNCommitItem objects that represent Working Copy items which have local modifications and so need to be committed to the repository- Returns:
- the user's initial commit log message or
""
if the message is null - Throws:
SVNException
-
getRevisionProperties
public SVNProperties getRevisionProperties(java.lang.String message, SVNCommitItem[] commitables, SVNProperties revisionProperties) throws SVNException ReturnsrevisionProperties
as is if it's not null, or an emptySVNProperties
object ifrevisionProperties
is null.- Specified by:
getRevisionProperties
in interfaceISVNCommitHandler
- Parameters:
message
- log message for commitcommitables
- paths to commitrevisionProperties
- initial revision properties to set- Returns:
revisionProperties
itself or an emptySVNProperties
object ifrevisionProperties
is null- Throws:
SVNException
-