Mercurial > hg4j

comparison src/org/tmatesoft/hg/core/HgChangesetTreeHandler.java @ 366:189dc6dc1c3e

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Use exceptions to expose errors reading mercurial data
author Artem Tikhomirov <tikhomirov.artem@gmail.com>
date Fri, 16 Dec 2011 04:43:18 +0100
parents a674b8590362
children a2341e761609
comparison
equal deleted inserted replaced
365:3572fcb06473 366:189dc6dc1c3e
38 * Revision of the revlog being iterated. For example, when walking file history, return value represents file revisions. 38 * Revision of the revlog being iterated. For example, when walking file history, return value represents file revisions.
39 * 39 *
40 * @return revision of the revlog being iterated. 40 * @return revision of the revlog being iterated.
41 */ 41 */
42 public Nodeid fileRevision(); 42 public Nodeid fileRevision();
43
43 /** 44 /**
44 * @return changeset associated with the current revision 45 * @return changeset associated with the current revision
46 * @throws HgException indicates failure dealing with Mercurial data
45 */ 47 */
46 public HgChangeset changeset(); 48 public HgChangeset changeset() throws HgException;
47 49
48 /** 50 /**
49 * Lightweight alternative to {@link #changeset()}, identifies changeset in which current file node has been modified 51 * Lightweight alternative to {@link #changeset()}, identifies changeset in which current file node has been modified
50 * @return changeset {@link Nodeid} 52 * @return changeset {@link Nodeid}
51 */ 53 */
52 public Nodeid changesetRevision(); 54 public Nodeid changesetRevision();
53 55
54 /** 56 /**
55 * Node, these are not necessarily in direct relation to parents of changeset from {@link #changeset()} 57 * Node, these are not necessarily in direct relation to parents of changeset from {@link #changeset()}
56 * @return changesets that correspond to parents of the current file node, either pair element may be <code>null</code>. 58 * @return changesets that correspond to parents of the current file node, either pair element may be <code>null</code>.
59 * @throws HgException indicates failure dealing with Mercurial data
57 */ 60 */
58 public Pair<HgChangeset, HgChangeset> parents(); 61 public Pair<HgChangeset, HgChangeset> parents() throws HgException;
59 62
60 /** 63 /**
61 * Lightweight alternative to {@link #parents()}, give {@link Nodeid nodeids} only 64 * Lightweight alternative to {@link #parents()}, give {@link Nodeid nodeids} only
62 * @return two values, neither is <code>null</code>, use {@link Nodeid#isNull()} to identify parent not set 65 * @return two values, neither is <code>null</code>, use {@link Nodeid#isNull()} to identify parent not set
63 */ 66 */
64 public Pair<Nodeid, Nodeid> parentRevisions(); 67 public Pair<Nodeid, Nodeid> parentRevisions();
65 68
66 public Collection<HgChangeset> children(); 69 /**
70 * Changes that originate from the given change and bear it as their parent.
71 * @return collection (possibly empty) of immediate children of the change
72 * @throws HgException indicates failure dealing with Mercurial data
73 */
74 public Collection<HgChangeset> children() throws HgException;
67 75
68 /** 76 /**
69 * Lightweight alternative to {@link #children()}. 77 * Lightweight alternative to {@link #children()}.
70 * @return never <code>null</code> 78 * @return never <code>null</code>
71 */ 79 */