hg4j: src/org/tmatesoft/hg/repo/Revlog.java comparison

comparison src/org/tmatesoft/hg/repo/Revlog.java @ 367:2fadf8695f8a

Use 'revision index' instead of the vague 'local revision number' concept in the API

author	Artem Tikhomirov <tikhomirov.artem@gmail.com>
date	Fri, 16 Dec 2011 15:37:27 +0100
parents	189dc6dc1c3e
children	8107b95f4280

comparison

equal deleted inserted replaced

-:189dc6dc1c3e
+:2fadf8695f8a
 	 * @param nid revision to look up
 	 * @return revision local index in this revlog
 	 * @throws HgInvalidRevisionException if supplied nodeid doesn't identify any revision from this revlog
 	 * @throws HgInvalidControlFileException if access to revlog index/data entry failed
 	 */
-	public final int getLocalRevision(Nodeid nid) throws HgInvalidControlFileException, HgInvalidRevisionException {
+	public final int getRevisionIndex(Nodeid nid) throws HgInvalidControlFileException, HgInvalidRevisionException {
-		int revision = content.findLocalRevisionNumber(nid);
+		int revision = content.findRevisionIndex(nid);
 		if (revision == BAD_REVISION) {
 			throw new HgInvalidRevisionException(String.format("Bad revision of %s", this /*XXX HgDataFile.getPath might be more suitable here*/), nid, null);
 		}
 		return revision;
 	}
+	/**
+	 * @deprecated use {@link #getRevisionIndex(Nodeid)} instead
+	 */
+	@Deprecated
+	public final int getLocalRevision(Nodeid nid) throws HgInvalidControlFileException, HgInvalidRevisionException {
+		return getRevisionIndex(nid);
+	}
 	/**
 	 * Note, {@link Nodeid#NULL} nodeid is not reported as known in any revlog.
 	 *
 	 * @param nodeid
 	 * @return
 	 * @throws HgInvalidControlFileException if access to revlog index/data entry failed
 	 */
 	public final boolean isKnown(Nodeid nodeid) throws HgInvalidControlFileException {
-		final int rn = content.findLocalRevisionNumber(nodeid);
+		final int rn = content.findRevisionIndex(nodeid);
 		if (BAD_REVISION == rn) {
 			return false;
 		}
 		if (rn < 0 || rn >= content.revisionCount()) {
 			// Sanity check
 	/**
 	 * Access to revision data as is (decompressed, but otherwise unprocessed, i.e. not parsed for e.g. changeset or manifest entries)
 	 * @param nodeid
 	 */
 	protected void rawContent(Nodeid nodeid, ByteChannel sink) throws HgException, IOException, CancelledException, HgInvalidRevisionException {
-		rawContent(getLocalRevision(nodeid), sink);
+		rawContent(getRevisionIndex(nodeid), sink);
 	}
 	/**
 	 * @param revision - repo-local index of this file change (not a changelog revision number!)
 	 * FIXME is it necessary to have IOException along with HgException here?
 	public interface Inspector {
 	}
 	@Experimental
 	public interface RevisionInspector extends Inspector {
-		void next(int localRevision, Nodeid revision, int linkedRevision);
+		void next(int revisionIndex, Nodeid revision, int linkedRevision);
 	}
 	@Experimental
 	public interface ParentInspector extends Inspector {
 		// XXX document whether parentX is -1 or a constant (BAD_REVISION? or dedicated?)
-		void next(int localRevision, Nodeid revision, int parent1, int parent2, Nodeid nidParent1, Nodeid nidParent2);
+		void next(int revisionIndex, Nodeid revision, int parent1, int parent2, Nodeid nidParent1, Nodeid nidParent2);
 	}
 	/*
 	 * XXX think over if it's better to do either:
 	 * pw = getChangelog().new ParentWalker(); pw.init() and pass pw instance around as needed
 		}
 	}
 	/**
 	 * Effective int to Nodeid and vice versa translation. It's advised to use this class instead of
-	 * multiple {@link Revlog#getLocalRevision(Nodeid)} calls.
+	 * multiple {@link Revlog#getRevisionIndex(Nodeid)} calls.
 	 *
-	 * getLocalRevision(Nodeid) with straightforward lookup approach performs O(n/2)
+	 * getRevisionIndex(Nodeid) with straightforward lookup approach performs O(n/2)
 	 * #localRevision() is log(n), plus initialization is O(n)
 	 */
 	public final class RevisionMap implements RevisionInspector {
 		/*
 		 * in fact, initialization is much slower as it instantiates Nodeids, while #getLocalRevision
 		public HgRepository getRepo() {
 			return Revlog.this.getRepo();
 		}
-		public void next(int localRevision, Nodeid revision, int linkedRevision) {
+		public void next(int revisionIndex, Nodeid revision, int linkedRevision) {
-			sequential[localRevision] = sorted[localRevision] = revision;
+			sequential[revisionIndex] = sorted[revisionIndex] = revision;
 		}
 		/**
 		 * @return <code>this</code> for convenience.
 		 */
 			// note, values in ArrayHelper#getReversed are 1-based indexes, not 0-based
 			sorted2natural = ah.getReverse();
 			return this;
 		}
-		public Nodeid revision(int localRevision) {
+		public Nodeid revision(int revisionIndex) {
-			return sequential[localRevision];
+			return sequential[revisionIndex];
 		}
-		public int localRevision(Nodeid revision) {
+		public int revisionIndex(Nodeid revision) {
 			if (revision == null || revision.isNull()) {
 				return BAD_REVISION;
 			}
 			int x = Arrays.binarySearch(sorted, revision);
 			if (x < 0) {
 				return BAD_REVISION;
 			}
 			return sorted2natural[x]-1;
+		}
+		/**
+		 * @deprecated use {@link #revisionIndex(Nodeid)} instead
+		 */
+		@Deprecated
+		public int localRevision(Nodeid revision) {
+			return revisionIndex(revision);
 		}
 	}
 	protected abstract static class ErrorHandlingInspector implements RevlogStream.Inspector, CancelSupport {
 		private Exception failure;

Mercurial > hg4j

comparison src/org/tmatesoft/hg/repo/Revlog.java @ 367:2fadf8695f8a