aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorThomas Watson2011-03-15 15:15:51 (EDT)
committerGlyn Normington2011-03-15 15:15:51 (EDT)
commit71dc59510d788b0753446b4c7fb0539822fbc7c0 (patch)
tree4e1f2aedfe9aa892506c9edf10a223bd978d1e7c
parentbe0b988443e885342eb62abb773f65adb7d51c78 (diff)
downloadorg.eclipse.virgo.kernel-71dc59510d788b0753446b4c7fb0539822fbc7c0.zip
org.eclipse.virgo.kernel-71dc59510d788b0753446b4c7fb0539822fbc7c0.tar.gz
org.eclipse.virgo.kernel-71dc59510d788b0753446b4c7fb0539822fbc7c0.tar.bz2
Fix javadoc.
-rw-r--r--org.eclipse.virgo.kernel.osgi/src/main/java/org/eclipse/virgo/kernel/osgi/region/RegionDigraphPersistence.java19
-rw-r--r--org.eclipse.virgo.kernel.osgi/src/main/java/org/eclipse/virgo/kernel/osgi/region/RegionFilterBuilder.java2
2 files changed, 16 insertions, 5 deletions
diff --git a/org.eclipse.virgo.kernel.osgi/src/main/java/org/eclipse/virgo/kernel/osgi/region/RegionDigraphPersistence.java b/org.eclipse.virgo.kernel.osgi/src/main/java/org/eclipse/virgo/kernel/osgi/region/RegionDigraphPersistence.java
index 6ff9934..4029f70 100644
--- a/org.eclipse.virgo.kernel.osgi/src/main/java/org/eclipse/virgo/kernel/osgi/region/RegionDigraphPersistence.java
+++ b/org.eclipse.virgo.kernel.osgi/src/main/java/org/eclipse/virgo/kernel/osgi/region/RegionDigraphPersistence.java
@@ -17,26 +17,37 @@ import java.io.OutputStream;
/**
* A region digraph persistence is used to persist the state of a {@link RegionDigraph}.
+ * <p />
+ * <strong>Concurrent Semantics</strong><br />
+ *
+ * Implementations of this interface must be thread safe.
*/
public interface RegionDigraphPersistence {
/**
* Creates a new digraph and reads the content of the digraph from the provided input. The provided input must have
- * been persisted using the {@link #load(InputStream)} method.
+ * been persisted using the {@link #save(RegionDigraph, OutputStream)} method.
+ * <p />
+ * Note that the returned digraph is disconnected from the OSGi runtime. Any modifications made to the returned
+ * digraph will not affect the OSGi runtime behavior of the bundles installed in the running framework.
* <p />
* The specified stream remains open after this method returns.
*
- * @param input
+ * @param input an input stream to read a digraph from.
* @return
* @throws IOException if error occurs reading the digraph.
*/
RegionDigraph load(InputStream input) throws IOException;
/**
- * Writes the specified {@link RegionDigraph} to the provided output in a formate suitable for using the
+ * Writes the specified {@link RegionDigraph} to the provided output in a form suitable for using the
* {@link #load(InputStream)} method.
+ * <p />
+ * After the digraph has been written, the output stream is flushed. The output stream remains open after this
+ * method returns.
*
- * @param output
+ * @param digraph a digraph to be written.
+ * @param output an output stream to write a digraph to.
* @throws IOException if error occurs writing the digraph.
*/
void save(RegionDigraph digraph, OutputStream output) throws IOException;
diff --git a/org.eclipse.virgo.kernel.osgi/src/main/java/org/eclipse/virgo/kernel/osgi/region/RegionFilterBuilder.java b/org.eclipse.virgo.kernel.osgi/src/main/java/org/eclipse/virgo/kernel/osgi/region/RegionFilterBuilder.java
index 92152ab..6b95fea 100644
--- a/org.eclipse.virgo.kernel.osgi/src/main/java/org/eclipse/virgo/kernel/osgi/region/RegionFilterBuilder.java
+++ b/org.eclipse.virgo.kernel.osgi/src/main/java/org/eclipse/virgo/kernel/osgi/region/RegionFilterBuilder.java
@@ -16,7 +16,7 @@ import org.osgi.framework.InvalidSyntaxException;
/**
* A builder for creating {@link RegionFilter} instances. A builder instance can be obtained from the
* {@link RegionDigraph#createRegionFilterBuilder()} method.
- *
+ * <p />
* <strong>Concurrent Semantics</strong><br />
*
* Implementations of this interface must be thread safe.