added Incubating annotation for showing which parts are specific to .…

…bagit

src/main/java/gov/loc/repository/bagit/annotation/Incubating.java

@@ -0,0 +1,25 @@
+package gov.loc.repository.bagit.annotation;
+
+import java.lang.annotation.Documented;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+
+/**
+ * The annotation conveys following information:
+ * <ul>
+ * <li>The API is fairly new and we would appreciate your feedback. For example, what are you missing from the API
+ * to solve your use case.</li>
+ * <li>The API might change.
+ * The chance for that is small because we care great deal for the initial design.
+ * The incubating API might change based on the feedback from the community in order to make the API most useful for the users.
+ * </li>
+ * <li>
+ * For types or methods that are not yet released it means the API is <strong>work in progress</strong>
+ * and can change before release.
+ * </li>
+ * </ul>
+ */
+@Retention(RetentionPolicy.RUNTIME)
+@Documented
+public @interface Incubating {
+}

src/main/java/gov/loc/repository/bagit/creator/BagCreator.java

@@ -11,6 +11,7 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+import gov.loc.repository.bagit.annotation.Incubating;
 import gov.loc.repository.bagit.domain.Bag;
 import gov.loc.repository.bagit.domain.Manifest;
 import gov.loc.repository.bagit.domain.Version;
@@ -85,6 +86,7 @@ protected static void moveFilesToDataDir(File[] files, File dataDir) throws IOEx
    * @throws NoSuchAlgorithmException if {@link MessageDigest} can't find the algorithm
    * @throws IOException if there is a problem writing files or .bagit directory
    */
+  @Incubating
   public static Bag createDotBagit(File root, SupportedAlgorithm algorithm, boolean includeHidden) throws NoSuchAlgorithmException, IOException{
     Bag bag = new Bag(new Version(0, 98));
     bag.setRootDir(root);