Mercurial > hg4j
changeset 251:8c951645bea0
Some javadoc to explain HgFileInformer
author | Artem Tikhomirov <tikhomirov.artem@gmail.com> |
---|---|
date | Fri, 12 Aug 2011 19:12:04 +0200 (2011-08-12) |
parents | 9ef71bd26db1 |
children | a6d19adc2636 |
files | src/org/tmatesoft/hg/core/HgFileInformer.java |
diffstat | 1 files changed, 30 insertions(+), 1 deletions(-) [+] |
line wrap: on
line diff
--- a/src/org/tmatesoft/hg/core/HgFileInformer.java Fri Aug 12 18:59:36 2011 +0200 +++ b/src/org/tmatesoft/hg/core/HgFileInformer.java Fri Aug 12 19:12:04 2011 +0200 @@ -24,6 +24,16 @@ /** * Primary purpose is to provide information about file revisions at specific changeset. Multiple {@link #check(Path)} calls * are possible once {@link #changeset(Nodeid)} (and optionally, {@link #followRenames(boolean)}) were set. + * + * <p>Sample: + * <pre><code> + * HgFileInformer i = new HgFileInformer(hgRepo).changeset(Nodeid.fromString("<40 digits>")).followRenames(true); + * if (i.check(file)) { + * HgCatCommand catCmd = new HgCatCommand(hgRepo).revision(i.getFileRevision()); + * catCmd.execute(...); + * ... + * } + * </pre></code> * * @author Artem Tikhomirov * @author TMate Software Ltd. @@ -41,6 +51,12 @@ repo = hgRepo; } + /** + * Select specific changelog revision + * + * @param nid changeset identifier + * @return <code>this</code> for convenience + */ public HgFileInformer changeset(Nodeid nid) { if (nid == null || Nodeid.NULL.equals(nid)) { throw new IllegalArgumentException(); @@ -50,13 +66,26 @@ fileRevision = null; return this; } - + + /** + * Whether to check file origins, default is false (look up only the name supplied) + * + * @param follow <code>true</code> to check copy/rename origin of the file if it is a copy. + * @return <code>this</code> for convenience + */ public HgFileInformer followRenames(boolean follow) { followRenames = follow; fileRevision = null; return this; } + /** + * Find file (or its origin, if {@link #followRenames(boolean)} was set to <code>true</code>) among files known at specified {@link #changeset(Nodeid)}. + * + * @param file name of the file in question + * @return <code>true</code> if file is known at the selected changeset. + * @throws IllegalArgumentException if {@link #changeset(Nodeid)} not specified or file argument is bad. + */ public boolean check(Path file) { // XXX IStatus instead of boolean? fileRevision = null; checked = false;