Overview | Package | Class | Tree | Deprecated | Index | Help
| JavaSVN Home
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.tmatesoft.svn.core
Class SVNCommitInfo

    java.lang.Object
      org.tmatesoft.svn.core.SVNCommitInfo

public class SVNCommitInfo
extends Object

The SVNCommitInfo class represents information about a committed revision. Commit information includes:

1. a revision number;
2. a datestamp when the revision was committed;
3. the name of the revision author.

In addition, this class provides anexception that, if a commit has failed, has got a description of a failure reason.

Version:
  1.0
Author:
  TMate Software Ltd.

Field Summary
`static SVNCommitInfo` | `NULL` Denotes an unsuccessful commit.

Constructor Summary
`SVNCommitInfo(long revision, String author, Date date)` Constructs an SVNCommitInfo object.
`SVNCommitInfo(long revision, String author, Date date, SVNErrorMessage error)` Constructs an SVNCommitInfo object.

Method Summary
`String` | `getAuthor()` Gets the name of the revision author
`Date` | `getDate()` Gets the datestamp when the revision was committed.
`SVNException` | `getError()` Deprecated. use `getErrorMessage()` instead
`SVNErrorMessage` | `getErrorMessage()` Gets an error message for a failed commit (if it has failed).
`long` | `getNewRevision()` Gets the revision number the repository was committed to.
`String` | `toString()` Gives a string representation of this object.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Field Detail

### NULL

    public static final SVNCommitInfo NULL

  Denotes an unsuccessful commit.

Constructor Detail

### SVNCommitInfo

    public SVNCommitInfo(long revision,
                         String author,
                         Date date)

  Constructs an SVNCommitInfo object.

Parameters:
  `revision` - a revision number
  `author` - the name of the author who committed the revision
  `date` - the datestamp when the revision was committed

### SVNCommitInfo

    public SVNCommitInfo(long revision,
                         String author,
                         Date date,
                         SVNErrorMessage error)

  Constructs an SVNCommitInfo object.

Parameters:
  `revision` - a revision number
  `author` - the name of the author who committed the revision
  `date` - the datestamp when the revision was committed
  `error` - if a commit failed - this is an error description containing details on the failure

Method Detail

### getNewRevision

    public long getNewRevision()

  Gets the revision number the repository was committed to.

  Returns:
    a revision number

### getAuthor

    public String getAuthor()

  Gets the name of the revision author

  Returns:
    a revision author's name

### getDate

    public Date getDate()

  Gets the datestamp when the revision was committed.

  Returns:
    a revision datestamp

### getErrorMessage

    public SVNErrorMessage getErrorMessage()

  Gets an error message for a failed commit (if it has failed). This message will usually keep the entire stack trace of all the error messages as of results of errors occurred.

  Returns:
    an error messages or null.

### getError

    public SVNException getError()

  Deprecated. use `getErrorMessage()` instead

### toString

    public String toString()

  Gives a string representation of this object.

  Returns:
    a string describing commit info

Overview | Package | Class | Tree | Deprecated | Index | Help
| JavaSVN Home
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

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