Share project "plexus-build-api" into "https://svn.sonatype.org/spice"

git-svn-id: file:///opt/svn/repositories/sonatype.org/spice/trunk/plexus-build-api@846 5751e0cb-dcb7-432f-92e2-260806df54be

Author: Igor Fedorenko

pom.xml

@@ -0,0 +1,33 @@
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
+  <modelVersion>4.0.0</modelVersion>
+  <groupId>org.codehaus.plexus</groupId>
+  <artifactId>plexus-build-api</artifactId>
+  <version>0.0.1-SNAPSHOT</version>
+
+  <dependencies>
+    <dependency>
+      <groupId>org.codehaus.plexus</groupId>
+      <artifactId>plexus-utils</artifactId>
+      <version>1.5.8-SNAPSHOT</version>
+    </dependency>
+  </dependencies>
+
+  <build>
+    <plugins>
+      <plugin>
+        <groupId>org.codehaus.plexus</groupId>
+        <artifactId>plexus-maven-plugin</artifactId>
+        <version>1.3.4</version>
+        <executions>
+          <execution>
+            <goals>
+              <goal>descriptor</goal>
+            </goals>
+          </execution>
+        </executions>
+      </plugin>
+    </plugins>
+  </build>
+
+</project>

src/main/java/org/codehaus/plexus/build/incremental/BuildContext.java

@@ -0,0 +1,69 @@
+
+package org.codehaus.plexus.build.incremental;
+
+import java.io.File;
+import java.io.IOException;
+import java.io.OutputStream;
+import java.util.List;
+
+import org.codehaus.plexus.util.Scanner;
+
+
+// TODO should it be BuildWorkspace or something like that?
+public interface BuildContext {
+
+  // TODO should we add File getBasedir()?
+  
+  /**
+   * Returns <code>true</code> if file or folder identified by <code>relpath</code> has 
+   * changed since last build. 
+   * 
+   * @param relpath is path relative to build context basedir
+   */
+  boolean hasDelta(String relpath);
+
+  /**
+   * Returns <code>true</code> if any file or folder identified by <code>relpaths</code> has 
+   * changed since last build.
+   *  
+   * @param relpaths List<String> are paths relative to build context basedir
+   */
+  boolean hasDelta(List relpaths);
+
+  /**
+   * Indicates that the file content has been modified during the build.
+   * 
+   * @see #newFileOutputStream(File)
+   */
+  void refresh(File file);
+
+  /**
+   * Returns new OutputStream that writes to the <code>file</code>.
+   *  
+   * Files changed using OutputStream returned by this method do not need to be
+   * explicitly refreshed using {@link #refresh(File)}.
+   */
+  OutputStream newFileOutputStream(File file) throws IOException;
+
+  /**
+   * Convenience method, fully equal to newScanner(basedir, false)
+   */
+  Scanner newScanner(File basedir);
+
+  /**
+   * Returned Scanner scans <code>basedir</code> for files and directories 
+   * deleted since last build. Returns empty Scanner if <code>basedir</code>
+   * is not under this build context basedir.
+   */
+  Scanner newDeleteScanner(File basedir);
+
+  /**
+   * Returned Scanner scans files and folders under <code>basedir</code>.
+   * If <code>ignoreDelta</code> is <code>false</code>, the scanner will only
+   * "see" files and folders with content changes since last build. If 
+   * <code>ignoreDelta</code> is <code>true</code>, the scanner will "see" all
+   * files and folders. Returns empty Scanner if <code>basedir</code>
+   * is not under this build context basedir.
+   */
+  Scanner newScanner(File basedir, boolean ignoreDelta);
+}

src/main/java/org/codehaus/plexus/build/incremental/DefaultBuildContext.java

@@ -0,0 +1,56 @@
+
+package org.codehaus.plexus.build.incremental;
+
+import java.io.File;
+import java.io.FileOutputStream;
+import java.io.IOException;
+import java.io.OutputStream;
+import java.util.List;
+
+import org.codehaus.plexus.util.DirectoryScanner;
+import org.codehaus.plexus.util.Scanner;
+
+/**
+ * Filesystem based build context implementation which behaves as if all files
+ * were just created. More specifically, 
+ * 
+ * hasDelta returns <code>true</code> for all paths
+ * newScanner returns Scanner that scanns all files under provided basedir
+ * newDeletedScanner always returns empty scanner.
+ * 
+ * @plexus.component role="org.codehaus.plexus.build.incremental.BuildContext"
+ *                   role-hint="default"
+ */
+public class DefaultBuildContext implements BuildContext {
+
+  public boolean hasDelta(String relPath) {
+    return true;
+  }
+
+  public boolean hasDelta(List relPaths) {
+    return true;
+  }
+
+  public OutputStream newFileOutputStream(File file) throws IOException {
+    return new FileOutputStream(file);
+  }
+
+  public Scanner newScanner(File basedir) {
+    DirectoryScanner ds = new DirectoryScanner();
+    ds.setBasedir(basedir);
+    return ds;
+  }
+
+  public void refresh(File file) {
+    // do nothing
+  }
+
+  public Scanner newDeleteScanner(File basedir) {
+    return EmptyScanner.INSTANCE;
+  }
+
+  public Scanner newScanner(File basedir, boolean ignoreDelta) {
+    return newScanner(basedir);
+  }
+
+}

src/main/java/org/codehaus/plexus/build/incremental/EmptyScanner.java

@@ -0,0 +1,35 @@
+
+package org.codehaus.plexus.build.incremental;
+
+import org.codehaus.plexus.util.Scanner;
+
+/**
+ * Scanner implementation never finds any files/directories.
+ */
+public class EmptyScanner implements Scanner {
+  
+  public static final Scanner INSTANCE = new EmptyScanner();
+  
+  private static final String[] EMPTY_STRING_ARRAY = new String[0];
+
+  public void addDefaultExcludes() {
+  }
+
+  public String[] getIncludedDirectories() {
+    return EMPTY_STRING_ARRAY;
+  }
+
+  public String[] getIncludedFiles() {
+    return EMPTY_STRING_ARRAY;
+  }
+
+  public void scan() {
+  }
+
+  public void setExcludes(String[] excludes) {
+  }
+
+  public void setIncludes(String[] includes) {
+  }
+
+}