| 1 | /** |
|---|
| 2 | * @copyright |
|---|
| 3 | * ==================================================================== |
|---|
| 4 | * Copyright (c) 2007 CollabNet. All rights reserved. |
|---|
| 5 | * |
|---|
| 6 | * This software is licensed as described in the file COPYING, which |
|---|
| 7 | * you should have received as part of this distribution. The terms |
|---|
| 8 | * are also available at http://subversion.tigris.org/license-1.html. |
|---|
| 9 | * If newer versions of this license are posted there, you may use a |
|---|
| 10 | * newer version instead, at your option. |
|---|
| 11 | * |
|---|
| 12 | * This software consists of voluntary contributions made by many |
|---|
| 13 | * individuals. For exact contribution history, see the revision |
|---|
| 14 | * history and logs, available at http://subversion.tigris.org/. |
|---|
| 15 | * ==================================================================== |
|---|
| 16 | * @endcopyright |
|---|
| 17 | */ |
|---|
| 18 | |
|---|
| 19 | package org.tigris.subversion.javahl; |
|---|
| 20 | |
|---|
| 21 | import java.util.Map; |
|---|
| 22 | |
|---|
| 23 | /** |
|---|
| 24 | * This interface is used to receive every log message for the log |
|---|
| 25 | * messages found by a SVNClientInterface.logMessages call. |
|---|
| 26 | * |
|---|
| 27 | * All log messages are returned in a list, which is terminated by an |
|---|
| 28 | * invocation of this callback with the revision set to SVN_INVALID_REVNUM. |
|---|
| 29 | * |
|---|
| 30 | * If the includeMergedRevisions parameter to SVNClientInterface.logMessages |
|---|
| 31 | * is true, then messages returned through this callback may have the |
|---|
| 32 | * hasChildren parameter set. This parameter indicates that a separate list, |
|---|
| 33 | * which includes messages for merged revisions, will immediately follow. |
|---|
| 34 | * This list is also terminated with SVN_INVALID_REVNUM, after which the |
|---|
| 35 | * previous log message list continues. |
|---|
| 36 | * |
|---|
| 37 | * Log message lists may be nested arbitrarily deep, depending on the ancestry |
|---|
| 38 | * of the requested paths. |
|---|
| 39 | */ |
|---|
| 40 | public interface LogMessageCallback |
|---|
| 41 | { |
|---|
| 42 | /** |
|---|
| 43 | * The method will be called for every log message. |
|---|
| 44 | * |
|---|
| 45 | * @param changedPaths the paths that were changed |
|---|
| 46 | * @param revision the revision of the commit |
|---|
| 47 | * @param revprops All of the requested revision properties, |
|---|
| 48 | * possibly including svn:date, svn:author, |
|---|
| 49 | * and svn:log. |
|---|
| 50 | * @param hasChildren when merge sensitive option was requested, |
|---|
| 51 | * whether or not this entry has child entries. |
|---|
| 52 | */ |
|---|
| 53 | public void singleMessage(ChangePath[] changedPaths, |
|---|
| 54 | long revision, |
|---|
| 55 | Map revprops, |
|---|
| 56 | boolean hasChildren); |
|---|
| 57 | } |
|---|
