changeset 467:51d682cf9cdc

Cleaned experimental tag and updated comments/javadoc
author Artem Tikhomirov <tikhomirov.artem@gmail.com>
date Fri, 22 Jun 2012 17:39:31 +0200
parents 3ace1fc95d0a
children 3ca4ae7bdd38
files src/org/tmatesoft/hg/repo/HgBundle.java src/org/tmatesoft/hg/repo/HgInternals.java src/org/tmatesoft/hg/repo/HgInvalidControlFileException.java src/org/tmatesoft/hg/repo/HgRepoConfig.java src/org/tmatesoft/hg/repo/HgSubrepoLocation.java src/org/tmatesoft/hg/util/DirectHashSet.java
diffstat 6 files changed, 5 insertions(+), 15 deletions(-) [+]
line wrap: on
line diff
--- a/src/org/tmatesoft/hg/repo/HgBundle.java	Wed Jun 20 17:12:00 2012 +0200
+++ b/src/org/tmatesoft/hg/repo/HgBundle.java	Fri Jun 22 17:39:31 2012 +0200
@@ -40,6 +40,7 @@
  * @author Artem Tikhomirov
  * @author TMate Software Ltd.
  */
+@Experimental(reason="API is not stable")
 public class HgBundle {
 
 	private final File bundleFile;
--- a/src/org/tmatesoft/hg/repo/HgInternals.java	Wed Jun 20 17:12:00 2012 +0200
+++ b/src/org/tmatesoft/hg/repo/HgInternals.java	Fri Jun 22 17:39:31 2012 +0200
@@ -139,7 +139,6 @@
 		}
 	}
 	
-	@Experimental(reason="Don't want to expose io.File from HgRepository; need to create FileIterator for working dir. Need a place to keep that code")
 	/*package-local*/ FileIterator createWorkingDirWalker(Path.Matcher workindDirScope) {
 		File repoRoot = repo.getWorkingDir();
 		Path.Source pathSrc = new Path.SimpleSource(new PathRewrite.Composite(new RelativePathRewrite(repoRoot), repo.getToRepoPathHelper()));
--- a/src/org/tmatesoft/hg/repo/HgInvalidControlFileException.java	Wed Jun 20 17:12:00 2012 +0200
+++ b/src/org/tmatesoft/hg/repo/HgInvalidControlFileException.java	Fri Jun 22 17:39:31 2012 +0200
@@ -19,20 +19,18 @@
 import java.io.File;
 
 import org.tmatesoft.hg.core.Nodeid;
-import org.tmatesoft.hg.internal.Experimental;
 import org.tmatesoft.hg.util.Path;
 
 /**
  * Subclass of {@link HgInvalidFileException} to indicate failure to deal with one of <b>Mercurial</b> control files 
  * (most likely those under .hg/, but also those residing in the repository, with special meaning to the Mercurial, like .hgtags or .hgignore)
  * 
- * XXX Perhaps, HgInvalidRevlogException? and parent HgInvalidRepositoryFileException?
  * @author Artem Tikhomirov
  * @author TMate Software Ltd.
  */
 @SuppressWarnings("serial")
-@Experimental(reason="WORK IN PROGRESS. Name is likely to change")
 public class HgInvalidControlFileException extends HgInvalidFileException {
+	// XXX Perhaps, child HgInvalidRevlogException and parent HgInvalidRepositoryFileException?
 
 	public HgInvalidControlFileException(String message, Throwable th, File file) {
 		super(message, th, file);
--- a/src/org/tmatesoft/hg/repo/HgRepoConfig.java	Wed Jun 20 17:12:00 2012 +0200
+++ b/src/org/tmatesoft/hg/repo/HgRepoConfig.java	Fri Jun 22 17:39:31 2012 +0200
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2011 TMate Software Ltd
+ * Copyright (c) 2011-2012 TMate Software Ltd
  *  
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -23,18 +23,14 @@
 import java.util.Map;
 
 import org.tmatesoft.hg.internal.ConfigFile;
-import org.tmatesoft.hg.internal.Experimental;
 import org.tmatesoft.hg.util.Pair;
 
 /**
- * WORK IN PROGRESS
- * 
  * Repository-specific configuration. 
  * 
  * @author Artem Tikhomirov
  * @author TMate Software Ltd.
  */
-@Experimental(reason="WORK IN PROGRESS")
 public final class HgRepoConfig /*implements RepoChangeListener, perhaps, also RepoChangeNotifier? */{
 	/*ease access for inner classes*/ final ConfigFile config;
 
--- a/src/org/tmatesoft/hg/repo/HgSubrepoLocation.java	Wed Jun 20 17:12:00 2012 +0200
+++ b/src/org/tmatesoft/hg/repo/HgSubrepoLocation.java	Fri Jun 22 17:39:31 2012 +0200
@@ -20,17 +20,15 @@
 
 import org.tmatesoft.hg.core.HgRepositoryNotFoundException;
 import org.tmatesoft.hg.core.Nodeid;
-import org.tmatesoft.hg.internal.Experimental;
 import org.tmatesoft.hg.util.Path;
 
 /**
- * WORK IN PROGRESS, DO NOT USE
+ * Descriptor for subrepository location
  * 
  * @see http://mercurial.selenic.com/wiki/Subrepository
  * @author Artem Tikhomirov
  * @author TMate Software Ltd.
  */
-@Experimental(reason="Work in progress")
 public class HgSubrepoLocation {
 	
 	private final HgRepository owner;
--- a/src/org/tmatesoft/hg/util/DirectHashSet.java	Wed Jun 20 17:12:00 2012 +0200
+++ b/src/org/tmatesoft/hg/util/DirectHashSet.java	Fri Jun 22 17:39:31 2012 +0200
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2011 TMate Software Ltd
+ * Copyright (c) 2011-2012 TMate Software Ltd
  *  
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -16,7 +16,6 @@
  */
 package org.tmatesoft.hg.util;
 
-import org.tmatesoft.hg.internal.Experimental;
 
 /**
  * Memory-friendly alternative to HashSet. With slightly worse performance than that of HashSet, uses n * sizeof(HashMap.Entry) less memory 
@@ -26,7 +25,6 @@
  * @author Artem Tikhomirov
  * @author TMate Software Ltd.
  */
-@Experimental
 public class DirectHashSet<T> {
 	
 	private Object[] table;