Mercurial > jhg
comparison src/org/tmatesoft/hg/repo/HgManifest.java @ 537:5a455624be4f
Update javadoc for HgManifest.Inspector and fix erroneous internal API
author | Artem Tikhomirov <tikhomirov.artem@gmail.com> |
---|---|
date | Tue, 05 Feb 2013 20:06:22 +0100 |
parents | b3c16d1aede0 |
children | 66fc86e8c0dd |
comparison
equal
deleted
inserted
replaced
536:2813a26b8999 | 537:5a455624be4f |
---|---|
1 /* | 1 /* |
2 * Copyright (c) 2010-2012 TMate Software Ltd | 2 * Copyright (c) 2010-2013 TMate Software Ltd |
3 * | 3 * |
4 * This program is free software; you can redistribute it and/or modify | 4 * This program is free software; you can redistribute it and/or modify |
5 * it under the terms of the GNU General Public License as published by | 5 * it under the terms of the GNU General Public License as published by |
6 * the Free Software Foundation; version 2 of the License. | 6 * the Free Software Foundation; version 2 of the License. |
7 * | 7 * |
352 } | 352 } |
353 } | 353 } |
354 | 354 |
355 @Callback | 355 @Callback |
356 public interface Inspector { | 356 public interface Inspector { |
357 boolean begin(int mainfestRevision, Nodeid nid, int changelogRevision); | |
358 /** | 357 /** |
358 * Denotes entering specific manifest revision, separate entries are | |
359 * reported with subsequence {@link #next(Nodeid, Path, Flags)} calls. | |
360 * | |
361 * @param mainfestRevisionIndex local revision index of the inspected revision | |
362 * @param manifestRevision revision of the manifest we're about to iterate through | |
363 * @param changelogRevisionIndex local revision index of changelog this manifest points to | |
364 * @return <code>true</code> to continue iteration, <code>false</code> to stop | |
365 */ | |
366 boolean begin(int mainfestRevisionIndex, Nodeid manifestRevision, int changelogRevisionIndex); | |
367 | |
368 | |
369 /** | |
370 * Reports each manifest entry | |
371 * | |
359 * @param nid file revision | 372 * @param nid file revision |
360 * @param fname file name | 373 * @param fname file name |
361 * @param flags one of {@link HgManifest.Flags} constants, not <code>null</code> | 374 * @param flags one of {@link HgManifest.Flags} constants, not <code>null</code> |
362 * @return <code>true</code> to continue iteration, <code>false</code> to stop | 375 * @return <code>true</code> to continue iteration, <code>false</code> to stop |
363 */ | 376 */ |
364 boolean next(Nodeid nid, Path fname, Flags flags); | 377 boolean next(Nodeid nid, Path fname, Flags flags); |
365 boolean end(int manifestRevision); | 378 |
379 /** | |
380 * Denotes leaving specific manifest revision, after all entries were reported using {@link #next(Nodeid, Path, Flags)} | |
381 * | |
382 * @param manifestRevisionIndex indicates manifest revision, corresponds to opening {@link #begin(int, Nodeid, int)} | |
383 * @return <code>true</code> to continue iteration, <code>false</code> to stop | |
384 */ | |
385 boolean end(int manifestRevisionIndex); | |
366 } | 386 } |
367 | 387 |
368 /** | 388 /** |
369 * When Pool uses Strings directly, | 389 * When Pool uses Strings directly, |
370 * ManifestParser creates new String instance with new char[] value, and does byte->char conversion. | 390 * ManifestParser creates new String instance with new char[] value, and does byte->char conversion. |