Skip to content
Browse files

javadoc improvements, removed guessing of alternate Id expression by …

…PojoConverter.java

Signed-off-by: gburgett <gordon.burgett@gmail.com>
  • Loading branch information...
1 parent d4eba56 commit b3621fc71f42d3bcaf544cb579003e9f53c332a3 @gburgett committed Feb 15, 2013
Showing with 64 additions and 104 deletions.
  1. +1 −1 java/XFlat/nbproject/project.properties
  2. +9 −6 java/XFlat/src/org/xflatdb/xflat/DatabaseConfig.java
  3. +4 −4 java/XFlat/src/org/xflatdb/xflat/Id.java
  4. +5 −5 java/XFlat/src/org/xflatdb/xflat/Table.java
  5. +1 −2 java/XFlat/src/org/xflatdb/xflat/TableConfig.java
  6. +1 −1 java/XFlat/src/org/xflatdb/xflat/convert/ConversionService.java
  7. +1 −19 java/XFlat/src/org/xflatdb/xflat/convert/PojoConverter.java
  8. +0 −1 java/XFlat/src/org/xflatdb/xflat/convert/converters/JAXBPojoConverter.java
  9. +0 −1 java/XFlat/src/org/xflatdb/xflat/db/Engine.java
  10. +2 −6 java/XFlat/src/org/xflatdb/xflat/db/EngineBase.java
  11. +2 −2 java/XFlat/src/org/xflatdb/xflat/db/EngineFactory.java
  12. +8 −6 java/XFlat/src/org/xflatdb/xflat/db/EngineTransactionManager.java
  13. +1 −1 java/XFlat/src/org/xflatdb/xflat/db/IdAccessor.java
  14. +2 −2 java/XFlat/src/org/xflatdb/xflat/db/IdGenerator.java
  15. +5 −4 java/XFlat/src/org/xflatdb/xflat/db/ShardedEngineBase.java
  16. +0 −6 java/XFlat/src/org/xflatdb/xflat/db/TableMetadata.java
  17. +2 −2 java/XFlat/src/org/xflatdb/xflat/db/TableMetadataFactory.java
  18. +2 −2 java/XFlat/src/org/xflatdb/xflat/db/package-info.java
  19. +6 −6 java/XFlat/src/org/xflatdb/xflat/engine/DefaultEngineFactory.java
  20. +0 −1 java/XFlat/src/org/xflatdb/xflat/engine/IdShardedEngine.java
  21. +1 −1 java/XFlat/src/org/xflatdb/xflat/package-info.java
  22. +0 −4 java/XFlat/src/org/xflatdb/xflat/query/Interval.java
  23. +4 −5 java/XFlat/src/org/xflatdb/xflat/query/IntervalSet.java
  24. +0 −2 java/XFlat/src/org/xflatdb/xflat/query/XPathQuery.java
  25. +2 −2 java/XFlat/src/org/xflatdb/xflat/transaction/Transaction.java
  26. +0 −2 java/XFlat/src/org/xflatdb/xflat/transaction/TransactionEventObject.java
  27. +1 −1 java/XFlat/src/org/xflatdb/xflat/transaction/TransactionManager.java
  28. +1 −1 java/XFlat/src/org/xflatdb/xflat/transaction/TransactionScope.java
  29. +1 −1 java/XFlat/src/org/xflatdb/xflat/util/ComparableComparator.java
  30. +2 −2 java/XFlat/src/org/xflatdb/xflat/util/XPathExpressionEqualityMatcher.java
  31. +0 −5 java/XFlat/test/org/xflatdb/xflat/engine/IdShardedEngineTest.java
View
2 java/XFlat/nbproject/project.properties
@@ -29,7 +29,7 @@ endorsed.classpath=
excludes=
includes=**
jar.archive.disabled=${jnlp.enabled}
-jar.compress=false
+jar.compress=true
jar.index=${jnlp.enabled}
javac.classpath=\
${libs.Apache_Commons_Logging.classpath}:\
View
15 java/XFlat/src/org/xflatdb/xflat/DatabaseConfig.java
@@ -62,20 +62,22 @@
* <p/>
* This is unused if an executor service is provided to the Database upon construction.
* @return the size of the database's thread pool
- * @see #setThreadCount(int)
+ * @see #withThreadCount(int)
*/
public int getThreadCount(){
return this.threadCount;
}
private String pojoConverterClass;
/**
- * Gets the binary name of the class used by the database to convert
- * POJOs for the database.
+ * Gets the binary name of the class used by the database to automatically map
+ * and convert POJOs to XML for the database. This class must implement
+ * {@link PojoConverter}.
* <p/>
* The database will load this class using its {@link ClassLoader} in order
* to convert pojos.
- * @return
+ * @return The binary name of the class which will be loaded in order to
+ * automatically map POJOs for conversion to XML.
*/
public String getPojoConverterClass(){
return this.pojoConverterClass;
@@ -167,8 +169,9 @@ public TableConfig getDefaultTableConfig(){
/**
* Sets the {@link TableConfig} used for new tables that have not been
* manually configured.
- * If {@link Database#getTable(java.lang.String, java.lang.Class) } is called
- * for a table that has not been manually configured using {@link Database#configureTable(java.lang.String, org.xflatdb.xflat.db.TableConfig) },
+ * If {@link Database#getTable(java.lang.Class) } is called
+ * for a table that has not been manually configured using
+ * {@link XFlatDatabase#configureTable(java.lang.String, org.xflatdb.xflat.TableConfig) },
* this configuration is used.
* @param tableConfig The default table config to use.
* @return A new instance with the defaultTableConfig property set.
View
8 java/XFlat/src/org/xflatdb/xflat/Id.java
@@ -27,7 +27,7 @@
* <p/>
* The {@link #value() } property instructs XFlat that this object serializes
* its ID property to the XML Element, and gives the XPath expression that should
- * be treated as equivalent to {@link XpathQuery#Id} when XFlat inspects a query.
+ * be treated as equivalent to {@link XPathQuery#Id} when XFlat inspects a query.
* <p/>
* Example (inside class Foo):<br/>
* <pre>
@@ -41,12 +41,12 @@
/**
* The XPath expression which selects this property once it has been converted to an {@link Element}.
* <br/>
- * This tells XFlat that this expression is equivalent to {@link XpathQuery#Id}, so that XFlat can
+ * This tells XFlat that this expression is equivalent to {@link XPathQuery#Id}, so that XFlat can
* apply optimizations based on ID if it encounters this expression in a query.<br/>
* This must be the exact same expression used in queries in order for XFlat to match it.
* <p/>
* If this is not set, the {@link PojoConverter} will be invoked to take a "best guess".
- * @return
+ * @return The string value of the raw XPath selecting the ID in a query.
*/
String value() default "";
@@ -59,7 +59,7 @@
* xmlns:a="http://www.example.com/ns"
* </pre>
*
- * @return
+ * @return An array of namespaces used in the XPath expression.
*/
String[] namespaces() default "";
}
View
10 java/XFlat/src/org/xflatdb/xflat/Table.java
@@ -60,7 +60,7 @@ public void insert(T row)
/**
* Gets a list of all the values matching the Xpath query.
- * This is the same as {@link #find(org.xflatdb.xflat.query.XpathQuery) }
+ * This is the same as {@link #find(org.xflatdb.xflat.query.XPathQuery) }
* but without the hassle of a cursor.
* @param query The query to match.
* @return A list of all the matching values.
@@ -80,15 +80,15 @@ public void replace(T newValue)
* Replaces the first value matched by the query with the new value.
* @param query The query to match.
* @param newValue The new value to replace the row.
- * @returns true if the query matched any rows, false otherwise. If false,
+ * @return true if the query matched any rows, false otherwise. If false,
* the new value was not inserted.
*/
public boolean replaceOne(XPathQuery query, T newValue);
/**
* Updates or inserts the row by ID.
* @param newValue The new value to replace or insert.
- * @returns false if an existing row was updated, true if a row was inserted.
+ * @return false if an existing row was updated, true if a row was inserted.
*/
public boolean upsert(T newValue);
@@ -107,7 +107,7 @@ public boolean update(Object id, XPathUpdate update)
* Applies an update to all data matching a given query.
* @param query The query to match.
* @param update The update to apply to each matching row.
- * @returns the number of rows that were updated.
+ * @return the number of rows that were updated.
*/
public int update(XPathQuery query, XPathUpdate update);
@@ -123,7 +123,7 @@ public void delete(Object id)
/**
* Deletes all rows matching the given query.
* @param query The query selecting elements to delete.
- * @returns the number of rows that were deleted.
+ * @return the number of rows that were deleted.
*/
public int deleteAll(XPathQuery query);
}
View
3 java/XFlat/src/org/xflatdb/xflat/TableConfig.java
@@ -51,8 +51,7 @@ private TableConfig(TableConfig other){
private Class<? extends IdGenerator> idGenerator;
/**
* Gets the ID generator class used for this table.
- * @return
- * @see #setIdGenerator(java.lang.Class)
+ * @see #withIdGenerator(java.lang.Class)
*/
public Class<? extends IdGenerator> getIdGenerator(){
return this.idGenerator;
View
2 java/XFlat/src/org/xflatdb/xflat/convert/ConversionService.java
@@ -33,7 +33,7 @@
* converting an instance of sourceType to targetType.
* @param source the source type to convert from (may be null if source is null)
* @param target the target type to convert to (required)
- * @return
+ * @return true if the conversion service has a conversion from the source to the target.
*/
public boolean canConvert(Class<?> source, Class<?> target);
View
20 java/XFlat/src/org/xflatdb/xflat/convert/PojoConverter.java
@@ -15,7 +15,6 @@
*/
package org.xflatdb.xflat.convert;
-import org.jdom2.xpath.XPathExpression;
/**
* The interface for a PojoConverter. The implementation is loaded dynamically
@@ -33,22 +32,5 @@
* @return The new conversion service that the database should use.
*/
public ConversionService extend(ConversionService service);
-
- /**
- * Gets an XPath expression which will select the ID property
- * of the converted data inside a row. Can be null if the class has no ID property.
- * <p/>
- * The context of the expression is the root of the row. For example, if your
- * class "Foo" has a property "FooInt" which is your ID, and the class is converted
- * to the following XML:<br/>
- * {@code
- * <foo>
- * <fooInt>17</FooInt>
- * </foo>
- * }
- * then the expression should be "foo/fooInt".
- * @param clazz
- * @return
- */
- public XPathExpression<Object> idSelector(Class<?> clazz);
+
}
View
1 java/XFlat/src/org/xflatdb/xflat/convert/converters/JAXBPojoConverter.java
@@ -79,7 +79,6 @@ public ConversionService extend(ConversionService service) {
* @param clazz The class for which an alternate ID selector is required.
* @return The alternate ID selector, or null if the class hass no ID property.
*/
- @Override
public XPathExpression<Object> idSelector(Class<?> clazz) {
if(!idSelectorCache.containsKey(clazz)){
View
1 java/XFlat/src/org/xflatdb/xflat/db/Engine.java
@@ -108,7 +108,6 @@ public boolean update(String id, XPathUpdate update)
/**
* Deletes the given row. The row is removed from the table.
* @param id The ID of the row to delete.
- * @return The data that was deleted.
*/
public void deleteRow(String id)
throws KeyNotFoundException;
View
8 java/XFlat/src/org/xflatdb/xflat/db/EngineBase.java
@@ -67,7 +67,7 @@ public EngineState getState(){
/**
* Initializes the engine and instructs it to begin acquiring the resources
* necessary to function. At this point the engine may begin to respond to
- * read-only requests, but any write requests MUST block until {@link #beginOperations() )
+ * read-only requests, but any write requests MUST block until {@link #beginOperations() } )
* is called.
*/
protected abstract boolean spinUp();
@@ -147,7 +147,6 @@ protected void setLastActivity(long time){
public static class SpinDownEvent extends java.util.EventObject{
/**
* The Engine that has spun down.
- * @return
*/
@Override
public Engine getSource(){
@@ -550,7 +549,7 @@ public RowData chooseMostRecentCommitted(Transaction currentTransaction, long tr
/**
* Chooses the most recent committed RowData that was committed before the given transaction ID.
* This prevents dirty reads in a non-transactional context by having a synchronizing transaction ID
- * which can be obtained from {@link TransactionManager#transactionlessCommitId() }
+ * which can be obtained from {@link EngineTransactionManager#transactionlessCommitId() }
* <p/>
* ALWAYS invoke this while synchronized on the Row.
* @param snapshotId The Transaction ID representing the time at which a snapshot of the data should be obtained.
@@ -563,9 +562,6 @@ public RowData chooseMostRecentCommitted(long snapshotId){
/**
* Cleans up the transactional data in this row.
* Returns true if this row can then be removed because it contains no data.
- * @param (optional) A set of transaction IDs that is added to when it is discovered
- * that a transaction has been newly committed (and the associated RowData's commit ID
- * is updated).
* @return true if this row has no RowData or its only RowData is "nothing".
*/
public boolean cleanup(){
View
4 java/XFlat/src/org/xflatdb/xflat/db/EngineFactory.java
@@ -24,12 +24,12 @@
*/
public interface EngineFactory {
/**
- * Creates a new Engine in the {@link EngineBase.EngineState#Uninitialized} state.
+ * Creates a new Engine in the {@link EngineState#Uninitialized} state.
* The engine should be one that is appropriate for the given table.
* @param file A file representing one table in the database, for which an engine is
* needed.
* @param tableName The name of the table for which an engine is needed.
- * @param TableConfig The TableConfig for the table.
+ * @param config The TableConfig for the table.
* @return An appropriate engine for the given file.
*/
public EngineBase newEngine(File file, String tableName, TableConfig config);
View
14 java/XFlat/src/org/xflatdb/xflat/db/EngineTransactionManager.java
@@ -31,9 +31,10 @@
/**
* Gets a new commit ID for a transactionless write operation.
* All transactionless writes can be thought of as transactions that are
- * automatically committed. This allows us to provide isolation between
+ * automatically committed. This allows us to provide snapshot isolation between
* transactions and transactionless writes.
- * @return
+ * @return A transaction ID that functions as a "snapshot ID" for this particular
+ * transactionless operation.
*/
public abstract long transactionlessCommitId();
@@ -58,7 +59,6 @@
/**
* Unbinds the engine from all its bound and closed transactions except the given collection.<br/>
* The engine will not be unbound from any open transactions.
- * @see #unbindEngineFromTransaction(org.xflatdb.xflat.db.EngineBase, java.lang.Long)
* @param engine The engine to unbind.
* @param transactionIds The transactions to remain bound to.
*/
@@ -140,13 +140,15 @@ protected long generateNewId(){
/**
* Returns true if any transactions are currently open.
- * @return
*/
public abstract boolean anyOpenTransactions();
/**
- * Attempts to recover from an unexpected shutdown if necessary.
- * @param db
+ * Attempts to recover from an unexpected shutdown if necessary. The
+ * transaction manager ought to use journaling so that it can revert partially-
+ * committed transactions here.
+ * @param db The database that initiated the recovery. It is used to spin
+ * up the tables that any partially-committed transactions were bound to.
*/
public abstract void recover(XFlatDatabase db);
View
2 java/XFlat/src/org/xflatdb/xflat/db/IdAccessor.java
@@ -235,7 +235,7 @@ private static void verify(IdAccessor accessor, Class<?> pojoType){
/**
* Indicates whether the POJO introspected by this accessor has an ID property.
- * @return
+ * @return true if an ID property or field was detected.
*/
public boolean hasId(){
return this.idProperty != null ||
View
4 java/XFlat/src/org/xflatdb/xflat/db/IdGenerator.java
@@ -15,14 +15,14 @@
*/
package org.xflatdb.xflat.db;
-import org.xflatdb.xflat.Database;
import org.jdom2.Element;
+import org.xflatdb.xflat.Database;
/**
* The base class for an ID generator. ID generators are selected on a per-table
* basis by the {@link Database} based on an ID generation strategy. The strategy
* selects the first IdGenerator in the strategy that supports the ID property's
- * type. The strategy can be overridden by a custom {@link TableConfig}.
+ * type. The strategy can be overridden by a custom {@link org.xflatdb.xflat.TableConfig }.
*
* All IdGenerator implementations MUST have a no-args constructor so that they
* can be constructed by reflection when necessary.
View
9 java/XFlat/src/org/xflatdb/xflat/db/ShardedEngineBase.java
@@ -61,7 +61,7 @@
* The metadata factory is set up to read and write metadata from the same
* {@link File} given to the {@link EngineFactory#newEngine(java.io.File, java.lang.String, org.xflatdb.xflat.TableConfig) } method,
* so if the engine uses this it must also use that file as a directory.
- * @return
+ * @return The metadata factory in use by the database, injected into this sharded engine.
*/
protected TableMetadataFactory getMetadataFactory(){
return this.metadataFactory;
@@ -229,7 +229,7 @@ protected void updateTask(){
/**
* Returns true if any of the individual shards have uncommitted data.
- * @return
+ * @return true if any open shards return true.
*/
@Override
protected boolean hasUncomittedData() {
@@ -389,8 +389,9 @@ else if(state == EngineState.Running){
/**
* Invoked in a synchronized context to see if the sharded engine is
* fully spun down. Default implementation checks whether the spinning
- * down engines have all spun down.
- * @return
+ * down engines have all spun down. ALWAYS synchronize on {@link #spinDownSyncRoot}
+ * before calling this.
+ * @return Whether there are no more {@link #spinningDownEngines}.
*/
protected boolean isSpunDown(){
return spinningDownEngines.isEmpty();
View
6 java/XFlat/src/org/xflatdb/xflat/db/TableMetadata.java
@@ -137,12 +137,6 @@ public TableBase getTable(Class<?> clazz){
if(alternateId != null){
ret.setAlternateIdExpression(alternateId);
}
- else{
- PojoConverter converter = this.db.getPojoConverter();
- if(converter != null){
- ret.setAlternateIdExpression(converter.idSelector(clazz));
- }
- }
}
return ret;
View
4 java/XFlat/src/org/xflatdb/xflat/db/TableMetadataFactory.java
@@ -41,7 +41,7 @@
/**
* Creates a new TableMetadataFactory with the given dependencies.
* @param db The XFlatDatabase from which dependencies are retrieved when engines are provided.
- * @param wrapper The metadata directory to which the factory should read and save table metadata.
+ * @param metadataDirectory The metadata directory to which the factory should read and save table metadata.
*/
public TableMetadataFactory(XFlatDatabase db, File metadataDirectory){
this(db, db.getConfig(), new DocumentFileWrapper(metadataDirectory));
@@ -125,7 +125,7 @@ public TableMetadata makeTableMetadata(String name, File engineFile){
* Creates a TableMetadata for the given table information.
* @param name The name of the table
* @param engineFile The file locating the engine.
- * @param config The configuration of the table, null to use {@link TableConfig#defaultConfig}
+ * @param config The configuration of the table, null to use {@link TableConfig#DEFAULT}
* @param idType The type of the ID property for the table.
* @return A table metadata for the given table.
*/
View
4 java/XFlat/src/org/xflatdb/xflat/db/package-info.java
@@ -17,8 +17,8 @@
/**
* This package contains the core classes for XFlat.
* <p/>
- * The {@link XFlatDatabase},
- * which is the primary implementation of {@link Database}, is the entry point
+ * The XFlatDatabase,
+ * which is the primary implementation of the Database interface, is the entry point
* for applications requiring XFlat. A new instance should be constructed and
* initialized, after which the public interfaces can be used.
*/
View
12 java/XFlat/src/org/xflatdb/xflat/engine/DefaultEngineFactory.java
@@ -25,8 +25,8 @@
import org.xflatdb.xflat.util.XPathExpressionEqualityMatcher;
/**
- * The default engine factory, which chooses from among the engines available to
- * the core of XFlat.
+ * The default engine factory, which chooses from among the engines packaged with
+ * the core XFlat Jar.
* @author Gordon
*/
public class DefaultEngineFactory implements EngineFactory {
@@ -36,10 +36,10 @@
/**
* Creates either an {@link IdShardedEngine} or a {@link CachedDocumentEngine}
* based on whether the table is sharded.
- * @param file
- * @param tableName
- * @param config
- * @return
+ * @param file The file for which an engine.
+ * @param tableName The name of the table we are getting an engine for.
+ * @param config The configuration of the table we are getting an engine for.
+ * @return A new engine implementation.
*/
@Override
public EngineBase newEngine(File file, String tableName, TableConfig config) {
View
1 java/XFlat/src/org/xflatdb/xflat/engine/IdShardedEngine.java
@@ -69,7 +69,6 @@ public IdShardedEngine(File file, String tableName, ShardsetConfig<T> config){
/**
* Returns true if all cross-shard queries are finished.
- * @return
*/
@Override
protected boolean isSpunDown(){
View
2 java/XFlat/src/org/xflatdb/xflat/package-info.java
@@ -16,7 +16,7 @@
/**
* This package contains the public interface for XFlat.
- * All the classes important to the user excepting {@link XFlatDatabase}
+ * All the classes important for accessing and modifying data in the database
* go here.
*/
package org.xflatdb.xflat;
View
4 java/XFlat/src/org/xflatdb/xflat/query/Interval.java
@@ -33,15 +33,13 @@
/**
* Gets the begin value of this interval. A null value means negative infinity.
- * @return
*/
public T getBegin() {
return begin;
}
/**
* Gets the end value of this interval. A null value means positive infinity.
- * @return
*/
public T getEnd() {
return end;
@@ -50,7 +48,6 @@ public T getEnd() {
/**
* Gets whether the interval is inclusive of the beginning.
* True means inclusive, false means exclusive.
- * @return
*/
public boolean getBeginInclusive() {
//Too late I realized it would have been better to do this having the booleans mean inclusive.
@@ -63,7 +60,6 @@ public boolean getBeginInclusive() {
/**
* Gets whether the interval is inclusive of the end.
* True means inclusive, false means exclusive.
- * @return
*/
public boolean getEndInclusive() {
return this.endInclusive;
View
9 java/XFlat/src/org/xflatdb/xflat/query/IntervalSet.java
@@ -34,7 +34,6 @@
/**
* Gets all the intervals in this IntervalSet in ascending order.
- * @return
*/
public List<Interval<T>> getIntervals(){
return intervals;
@@ -109,7 +108,7 @@ private IntervalSet(List<Interval<T>> intervals){
* @param <U>
* @param lower The exclusive lower bound of the interval set.
* @param upper The inclusive upper bound of the interval set.
- * @return
+ * @return the interval "(lower, upper)"
*/
public static <U> IntervalSet<U> between(U lower, U upper){
Interval i = new Interval<>(lower, false, upper, false);
@@ -146,7 +145,7 @@ private IntervalSet(List<Interval<T>> intervals){
* Creates an interval set containing the entire number range.
* That is, the interval (-∞, ∞)
* @param <U>
- * @return
+ * @return the interval "(-∞, ∞)"
*/
public static <U> IntervalSet<U> all(){
Interval i = new Interval<>(null, false, null, false);
@@ -157,7 +156,7 @@ private IntervalSet(List<Interval<T>> intervals){
* Creates an interval set containing no intervals.
* That is, the empty set.
* @param <U>
- * @return
+ * @return the empty interval.
*/
public static <U> IntervalSet<U> none(){
Interval i = new Interval<>(null, false, null, false);
@@ -201,7 +200,7 @@ private IntervalSet(List<Interval<T>> intervals){
* The returned interval set is a new instance.
* @param other The other interval set which has intersecting intervals.
* @param comparer The comparer for values of the interval set.
- * @return
+ * @return the intersection of this interval and the given interval.
*/
public IntervalSet<T> intersection(IntervalSet<T> other, final Comparator<T> comparer){
Comparator<Interval<T>> sorter = sortingComparer(comparer);
View
2 java/XFlat/src/org/xflatdb/xflat/query/XPathQuery.java
@@ -359,7 +359,6 @@ private XPathQuery(){
* @param <U> the type of the value
* @param selector The xpath selector to query
* @param object The object that the result of the xpath selection should be less than.
- * @param converter A function to convert a string to the appropriate type for comparison.
* @return An XpathQuery object
*/
public static <U extends Comparable<U>> XPathQuery lt(XPathExpression<?> selector, U object){
@@ -626,7 +625,6 @@ public void describeTo(Description description) {
/**
* Returns the string representation of this query.
- * @return
*/
@Override
public String toString(){
View
4 java/XFlat/src/org/xflatdb/xflat/transaction/Transaction.java
@@ -53,7 +53,7 @@
* This refers to the
* entire transaction scope; if this transaction's scope was opened within
* a larger transaction scope (except
- * by {@link Propagation#NESTED}), then calling {@link #commit() } on this object
+ * by {@link Propagation#NESTED}), then calling {@link TransactionScope#commit() } on the scope
* will not result in a commit and this will return false until the larger
* scope is committed.
* @return true iff the entire ambient transaction successfully committed.
@@ -64,7 +64,7 @@
* Returns true if the transaction scope to which this transaction belongs has been reverted.
* <p/>
* If this transaction's scope was propagated from a larger transaction scope (except
- * by {@link Propagation#NESTED}), then this will return true if {@link #revert() }
+ * by {@link Propagation#NESTED}), then this will return true if {@link TransactionScope#revert() }
* has been called on ANY transaction scope participating in the transaction.
* @return true iff the entire ambient transaction was reverted.
*/
View
2 java/XFlat/src/org/xflatdb/xflat/transaction/TransactionEventObject.java
@@ -34,7 +34,6 @@
/**
* Gets the transaction event type.
* one of {@link #COMMITTED} or {@link #REVERTED}
- * @return
*/
public int getEventType(){
return eventType;
@@ -43,7 +42,6 @@ public int getEventType(){
private Transaction tx;
/**
* Gets the transaction in which the event occurred.
- * @return
*/
public Transaction getTransaction(){
return tx;
View
2 java/XFlat/src/org/xflatdb/xflat/transaction/TransactionManager.java
@@ -29,7 +29,7 @@
public Transaction getTransaction();
/**
- * Opens a new transaction scope, using the {@link TransactionOptions#Default} options.
+ * Opens a new transaction scope, using the {@link TransactionOptions#DEFAULT} options.
* If a transaction is already open in this context, an IllegalStateException
* is thrown.
* @return A new Transaction object representing the transaction open in this context.
View
2 java/XFlat/src/org/xflatdb/xflat/transaction/TransactionScope.java
@@ -62,7 +62,7 @@
/**
* Gets the options with which this transaction was opened.
- * @Return the TransactionOptions object provided when the transaction
+ * @return the TransactionOptions object provided when the transaction
* was opened.
*/
TransactionOptions getOptions();
View
2 java/XFlat/src/org/xflatdb/xflat/util/ComparableComparator.java
@@ -37,7 +37,7 @@ public int compare(T o1, T o2) {
/**
* Gets the singleton comparator instance typed as needed.
* @param <U>
- * @return
+ * @return The singleton, typed as necessary.
*/
public static <U extends Comparable<U>> ComparableComparator<U> getComparator(Class<U> clazz){
return singleton;
View
4 java/XFlat/src/org/xflatdb/xflat/util/XPathExpressionEqualityMatcher.java
@@ -68,8 +68,8 @@ public XPathExpressionEqualityMatcher(XPathExpression<U> toMatch) {
/**
* Returns true if the matcher matches the given XPath expression.
- * @param item
- * @return
+ * @param item The XPath expression to match.
+ * @return true if they are a match.
*/
@Override
protected boolean matchesSafely(XPathExpression<U> item) {
View
5 java/XFlat/test/org/xflatdb/xflat/engine/IdShardedEngineTest.java
@@ -93,11 +93,6 @@ public TransactionManager getTransactionManager(){
public ConversionService extend(ConversionService service) {
return conversionService;
}
-
- @Override
- public XPathExpression<Object> idSelector(Class<?> clazz) {
- return null;
- }
});
db.setEngineFactory(new EngineFactory(){
@Override

0 comments on commit b3621fc

Please sign in to comment.
Something went wrong with that request. Please try again.