From 321a2b3b349c9046eebac22e90778eab367dcae2 Mon Sep 17 00:00:00 2001 From: "Brian S. O'Neill" Date: Sun, 29 Apr 2007 19:33:18 +0000 Subject: Added @since tags. --- src/main/java/com/amazon/carbonado/Automatic.java | 1 + src/main/java/com/amazon/carbonado/Derived.java | 1 + .../amazon/carbonado/OptimisticLockException.java | 1 + src/main/java/com/amazon/carbonado/Storage.java | 2 + .../amazon/carbonado/cursor/FilteredCursor.java | 1 + .../com/amazon/carbonado/gen/CodeBuilderUtil.java | 1 + .../amazon/carbonado/gen/CommonMethodNames.java | 1 + .../com/amazon/carbonado/gen/MasterFeature.java | 1 + .../carbonado/gen/MasterStorableGenerator.java | 1 + .../com/amazon/carbonado/gen/MasterSupport.java | 1 + .../amazon/carbonado/gen/StorableGenerator.java | 1 + .../amazon/carbonado/gen/StorableSerializer.java | 1 + .../com/amazon/carbonado/gen/StorableSupport.java | 1 + .../com/amazon/carbonado/gen/TriggerSupport.java | 1 + .../com/amazon/carbonado/gen/WrappedSupport.java | 1 + .../com/amazon/carbonado/gen/package-info.java | 2 + .../com/amazon/carbonado/info/ChainedProperty.java | 1 + .../carbonado/info/ConversionComparator.java | 1 + .../amazon/carbonado/info/StorableProperty.java | 7 ++ .../com/amazon/carbonado/qe/FilteringScore.java | 8 ++ .../amazon/carbonado/raw/CustomStorableCodec.java | 10 +++ .../carbonado/raw/CustomStorableCodecFactory.java | 2 + .../amazon/carbonado/raw/GenericStorableCodec.java | 5 ++ .../carbonado/raw/GenericStorableCodecFactory.java | 1 + .../com/amazon/carbonado/raw/StorableCodec.java | 4 + .../amazon/carbonado/raw/StorableCodecFactory.java | 1 + .../repo/indexed/DependentStorableFetcher.java | 1 + .../repo/indexed/DerivedIndexesTrigger.java | 1 + .../carbonado/repo/indexed/IndexAnalysis.java | 1 + .../repo/indexed/IndexedRepositoryBuilder.java | 4 + .../carbonado/repo/jdbc/JDBCRepositoryBuilder.java | 13 +++ .../repo/jdbc/JDBCSequenceValueProducer.java | 3 + .../carbonado/repo/jdbc/JDBCStorableInfo.java | 2 + .../carbonado/repo/jdbc/JDBCStorableProperty.java | 2 + .../amazon/carbonado/repo/jdbc/JDBCStorage.java | 3 + .../carbonado/repo/jdbc/JDBCSupportStrategy.java | 20 ++++- .../repo/jdbc/LoggingCallableStatement.java | 96 ++++++++++++++++++++++ .../carbonado/repo/jdbc/LoggingConnection.java | 39 +++++++++ .../carbonado/repo/jdbc/LoggingDataSource.java | 9 ++ .../repo/jdbc/LoggingPreparedStatement.java | 54 ++++++++++++ .../carbonado/repo/jdbc/LoggingStatement.java | 15 ++++ .../carbonado/repo/jdbc/SimpleDataSource.java | 9 ++ .../carbonado/repo/logging/LoggingStorage.java | 3 + .../repo/replicated/ReplicatedStorage.java | 3 + .../carbonado/repo/sleepycat/BDBStorage.java | 3 + .../sequence/AbstractSequenceValueProducer.java | 1 + .../carbonado/sequence/SequenceCapability.java | 2 +- .../carbonado/sequence/SequenceValueGenerator.java | 1 + .../carbonado/sequence/SequenceValueProducer.java | 1 + .../sequence/SequenceValueProducerPool.java | 1 + .../amazon/carbonado/sequence/StoredSequence.java | 1 + .../amazon/carbonado/sequence/package-info.java | 1 + .../amazon/carbonado/spi/AbstractRepository.java | 1 + .../java/com/amazon/carbonado/spi/LobEngine.java | 2 + .../com/amazon/carbonado/spi/StorableIndexSet.java | 1 + .../java/com/amazon/carbonado/spi/StoragePool.java | 1 + .../com/amazon/carbonado/spi/WrappedStorage.java | 3 + .../com/amazon/carbonado/util/AbstractPool.java | 1 + .../amazon/carbonado/util/AbstractWeakPool.java | 1 + .../carbonado/util/WeakReentrantLockPool.java | 1 + .../util/WeakReentrantReadWriteLockPool.java | 1 + 61 files changed, 357 insertions(+), 2 deletions(-) (limited to 'src/main/java') diff --git a/src/main/java/com/amazon/carbonado/Automatic.java b/src/main/java/com/amazon/carbonado/Automatic.java index 96200e1..03806c6 100644 --- a/src/main/java/com/amazon/carbonado/Automatic.java +++ b/src/main/java/com/amazon/carbonado/Automatic.java @@ -45,6 +45,7 @@ import java.lang.annotation.*; * * @author Brian S O'Neill * @see Sequence + * @since 1.2 */ @Documented @Retention(RetentionPolicy.RUNTIME) diff --git a/src/main/java/com/amazon/carbonado/Derived.java b/src/main/java/com/amazon/carbonado/Derived.java index 77ffd2a..901a583 100644 --- a/src/main/java/com/amazon/carbonado/Derived.java +++ b/src/main/java/com/amazon/carbonado/Derived.java @@ -50,6 +50,7 @@ import java.lang.annotation.*; * * * @author Brian S O'Neill + * @since 1.2 */ @Documented @Retention(RetentionPolicy.RUNTIME) diff --git a/src/main/java/com/amazon/carbonado/OptimisticLockException.java b/src/main/java/com/amazon/carbonado/OptimisticLockException.java index 03004c2..aa54c1c 100644 --- a/src/main/java/com/amazon/carbonado/OptimisticLockException.java +++ b/src/main/java/com/amazon/carbonado/OptimisticLockException.java @@ -94,6 +94,7 @@ public class OptimisticLockException extends PersistException { * @param savedVersion actual persistent version number of storable * @param s Storable which was acted upon * @param newVersion new version which was provided + * @since 1.2 */ public OptimisticLockException(Object savedVersion, Storable s, Object newVersion) { super(makeMessage(savedVersion, s, newVersion)); diff --git a/src/main/java/com/amazon/carbonado/Storage.java b/src/main/java/com/amazon/carbonado/Storage.java index 75b9985..bb4b8b7 100644 --- a/src/main/java/com/amazon/carbonado/Storage.java +++ b/src/main/java/com/amazon/carbonado/Storage.java @@ -118,6 +118,8 @@ public interface Storage { *

If this Storage has any registered triggers which act on deletes, all * Storables are deleted via {@code query().deleteAll()} instead to ensure * these triggers get run. + * + * @since 1.2 */ void truncate() throws PersistException; diff --git a/src/main/java/com/amazon/carbonado/cursor/FilteredCursor.java b/src/main/java/com/amazon/carbonado/cursor/FilteredCursor.java index faf990d..264f7a9 100644 --- a/src/main/java/com/amazon/carbonado/cursor/FilteredCursor.java +++ b/src/main/java/com/amazon/carbonado/cursor/FilteredCursor.java @@ -47,6 +47,7 @@ public abstract class FilteredCursor extends AbstractCursor { * @return wrapped cursor which filters results * @throws IllegalStateException if any values are not specified * @throws IllegalArgumentException if any argument is null + * @since 1.2 */ public static Cursor applyFilter(Cursor cursor, Class type, diff --git a/src/main/java/com/amazon/carbonado/gen/CodeBuilderUtil.java b/src/main/java/com/amazon/carbonado/gen/CodeBuilderUtil.java index 297656d..1f01872 100644 --- a/src/main/java/com/amazon/carbonado/gen/CodeBuilderUtil.java +++ b/src/main/java/com/amazon/carbonado/gen/CodeBuilderUtil.java @@ -42,6 +42,7 @@ import static com.amazon.carbonado.gen.CommonMethodNames.*; * * @author Don Schneider * @author Brian S O'Neill + * @since 1.2 */ public class CodeBuilderUtil { diff --git a/src/main/java/com/amazon/carbonado/gen/CommonMethodNames.java b/src/main/java/com/amazon/carbonado/gen/CommonMethodNames.java index 4e56e0a..d9db47c 100644 --- a/src/main/java/com/amazon/carbonado/gen/CommonMethodNames.java +++ b/src/main/java/com/amazon/carbonado/gen/CommonMethodNames.java @@ -22,6 +22,7 @@ package com.amazon.carbonado.gen; * Collection of constant method names for the public API. * * @author Brian S O'Neill + * @since 1.2 */ public class CommonMethodNames { /** Storable API method name */ diff --git a/src/main/java/com/amazon/carbonado/gen/MasterFeature.java b/src/main/java/com/amazon/carbonado/gen/MasterFeature.java index 7875d49..a1bb278 100644 --- a/src/main/java/com/amazon/carbonado/gen/MasterFeature.java +++ b/src/main/java/com/amazon/carbonado/gen/MasterFeature.java @@ -22,6 +22,7 @@ package com.amazon.carbonado.gen; * Master feature to enable when using {@link MasterStorableGenerator}. * * @author Brian S O'Neill + * @since 1.2 */ public enum MasterFeature { /** Insert and update operations implement record versioning, if version property exists */ diff --git a/src/main/java/com/amazon/carbonado/gen/MasterStorableGenerator.java b/src/main/java/com/amazon/carbonado/gen/MasterStorableGenerator.java index 581a7d6..bf5503f 100644 --- a/src/main/java/com/amazon/carbonado/gen/MasterStorableGenerator.java +++ b/src/main/java/com/amazon/carbonado/gen/MasterStorableGenerator.java @@ -58,6 +58,7 @@ import static com.amazon.carbonado.gen.CommonMethodNames.*; * transactions since this class takes care of that. * * @author Brian S O'Neill + * @since 1.2 */ public final class MasterStorableGenerator { // Note: All generated fields/methods have a "$" character in them to diff --git a/src/main/java/com/amazon/carbonado/gen/MasterSupport.java b/src/main/java/com/amazon/carbonado/gen/MasterSupport.java index cd1a183..555b254 100644 --- a/src/main/java/com/amazon/carbonado/gen/MasterSupport.java +++ b/src/main/java/com/amazon/carbonado/gen/MasterSupport.java @@ -26,6 +26,7 @@ import com.amazon.carbonado.sequence.SequenceValueProducer; * Provides runtime support for Storable classes generated by {@link MasterStorableGenerator}. * * @author Brian S O'Neill + * @since 1.2 */ public interface MasterSupport extends TriggerSupport { /** diff --git a/src/main/java/com/amazon/carbonado/gen/StorableGenerator.java b/src/main/java/com/amazon/carbonado/gen/StorableGenerator.java index a28f7e6..be23563 100644 --- a/src/main/java/com/amazon/carbonado/gen/StorableGenerator.java +++ b/src/main/java/com/amazon/carbonado/gen/StorableGenerator.java @@ -77,6 +77,7 @@ import static com.amazon.carbonado.gen.CommonMethodNames.*; * @author Brian S O'Neill * @author Don Schneider * @see MasterStorableGenerator + * @since 1.2 */ public final class StorableGenerator { diff --git a/src/main/java/com/amazon/carbonado/gen/StorableSerializer.java b/src/main/java/com/amazon/carbonado/gen/StorableSerializer.java index 09eff96..c3ae207 100644 --- a/src/main/java/com/amazon/carbonado/gen/StorableSerializer.java +++ b/src/main/java/com/amazon/carbonado/gen/StorableSerializer.java @@ -63,6 +63,7 @@ import com.amazon.carbonado.raw.GenericEncodingStrategy; * Storables. When that happens, this class will be deprecated. * * @author Brian S O'Neill + * @since 1.2 */ public abstract class StorableSerializer { private static final String ENCODE_METHOD_NAME = "encode"; diff --git a/src/main/java/com/amazon/carbonado/gen/StorableSupport.java b/src/main/java/com/amazon/carbonado/gen/StorableSupport.java index 16fed67..925bbfd 100644 --- a/src/main/java/com/amazon/carbonado/gen/StorableSupport.java +++ b/src/main/java/com/amazon/carbonado/gen/StorableSupport.java @@ -25,6 +25,7 @@ import com.amazon.carbonado.Storable; * Provides runtime support for Storable classes generated by {@link StorableGenerator}. * * @author Brian S O'Neill + * @since 1.2 */ public interface StorableSupport { /** diff --git a/src/main/java/com/amazon/carbonado/gen/TriggerSupport.java b/src/main/java/com/amazon/carbonado/gen/TriggerSupport.java index 39b7806..32b4e0b 100644 --- a/src/main/java/com/amazon/carbonado/gen/TriggerSupport.java +++ b/src/main/java/com/amazon/carbonado/gen/TriggerSupport.java @@ -25,6 +25,7 @@ import com.amazon.carbonado.Trigger; * Provides runtime support for Storable classes generated by {@link StorableGenerator}. * * @author Brian S O'Neill + * @since 1.2 */ public interface TriggerSupport extends StorableSupport { /** diff --git a/src/main/java/com/amazon/carbonado/gen/WrappedSupport.java b/src/main/java/com/amazon/carbonado/gen/WrappedSupport.java index 78f58b3..d4712e7 100644 --- a/src/main/java/com/amazon/carbonado/gen/WrappedSupport.java +++ b/src/main/java/com/amazon/carbonado/gen/WrappedSupport.java @@ -26,6 +26,7 @@ import com.amazon.carbonado.Storable; * Provides runtime support for Storable classes generated by {@link StorableGenerator}. * * @author Brian S O'Neill + * @since 1.2 */ public interface WrappedSupport extends TriggerSupport { /** diff --git a/src/main/java/com/amazon/carbonado/gen/package-info.java b/src/main/java/com/amazon/carbonado/gen/package-info.java index 007ee0b..8b3bfba 100644 --- a/src/main/java/com/amazon/carbonado/gen/package-info.java +++ b/src/main/java/com/amazon/carbonado/gen/package-info.java @@ -18,5 +18,7 @@ /** * Storable code generation support intended for use by repository implementations. + * + * @since 1.2 */ package com.amazon.carbonado.gen; diff --git a/src/main/java/com/amazon/carbonado/info/ChainedProperty.java b/src/main/java/com/amazon/carbonado/info/ChainedProperty.java index ab01c5f..d5b41a8 100644 --- a/src/main/java/com/amazon/carbonado/info/ChainedProperty.java +++ b/src/main/java/com/amazon/carbonado/info/ChainedProperty.java @@ -168,6 +168,7 @@ public class ChainedProperty implements Appender { * Returns true if any property in the chain can be null. * * @see com.amazon.carbonado.Nullable + * @since 1.2 */ public boolean isNullable() { if (mPrime.isNullable()) { diff --git a/src/main/java/com/amazon/carbonado/info/ConversionComparator.java b/src/main/java/com/amazon/carbonado/info/ConversionComparator.java index dc88f95..6582d27 100644 --- a/src/main/java/com/amazon/carbonado/info/ConversionComparator.java +++ b/src/main/java/com/amazon/carbonado/info/ConversionComparator.java @@ -26,6 +26,7 @@ import org.cojen.classfile.TypeDesc; * Compares type conversions, finding the one that is nearest. * * @author Brian S O'Neill + * @since 1.2 */ class ConversionComparator implements Comparator { private final TypeDesc mFrom; diff --git a/src/main/java/com/amazon/carbonado/info/StorableProperty.java b/src/main/java/com/amazon/carbonado/info/StorableProperty.java index b3362c6..e61c5e9 100644 --- a/src/main/java/com/amazon/carbonado/info/StorableProperty.java +++ b/src/main/java/com/amazon/carbonado/info/StorableProperty.java @@ -125,6 +125,7 @@ public interface StorableProperty extends Appender { * Returns true if this property is one-to-one joined to another Storable. * * @see com.amazon.carbonado.Join + * @since 1.2 */ boolean isOneToOneJoin(); @@ -200,6 +201,7 @@ public interface StorableProperty extends Appender { * Returns true of this property is given an automatic value upon insert. * * @see com.amazon.carbonado.Automatic + * @since 1.2 */ boolean isAutomatic(); @@ -222,6 +224,7 @@ public interface StorableProperty extends Appender { * Returns true if this property is derived. * * @see com.amazon.carbonado.Derived + * @since 1.2 */ boolean isDerived(); @@ -230,6 +233,8 @@ public interface StorableProperty extends Appender { * if this is not a derived property. Otherwise, the set is the transitive * closure of all dependent properties. This set may include joins and * other derived properties. + * + * @since 1.2 */ ChainedProperty[] getDerivedFromProperties(); @@ -242,6 +247,8 @@ public interface StorableProperty extends Appender { * property is the actual dependent property, and the tail is the path to * reach this property's enclosing type. If a derived property resides in * the same enclosing type as this one, the chain count is zero. + * + * @since 1.2 */ ChainedProperty[] getDerivedToProperties(); diff --git a/src/main/java/com/amazon/carbonado/qe/FilteringScore.java b/src/main/java/com/amazon/carbonado/qe/FilteringScore.java index 5ea6009..2661f69 100644 --- a/src/main/java/com/amazon/carbonado/qe/FilteringScore.java +++ b/src/main/java/com/amazon/carbonado/qe/FilteringScore.java @@ -550,6 +550,8 @@ public class FilteringScore { * Returns number of extra property filters which are supported by the * evaluated index. This count is no more than the remainder count. If * hasAnyMatches returns false, then the extra match count is zero. + * + * @since 1.2 */ public int getExtraMatchCount() { return mExtraMatchFilters.size(); @@ -558,6 +560,8 @@ public class FilteringScore { /** * Returns the extra filters which are supported by the evaluated index, * which is a subset of the remainder filters. + * + * @since 1.2 */ public List> getExtraMatchFilters() { return mExtraMatchFilters; @@ -566,6 +570,8 @@ public class FilteringScore { /** * Returns the composite extra match filter supported by the evaluated * index, or null if no extra match. + * + * @since 1.2 */ public Filter getExtraMatchFilter() { if (mExtraMatchFilter == null) { @@ -577,6 +583,8 @@ public class FilteringScore { /** * Returns the composite remainder filter without including the extra match * filter. Returns null if no remainder. + * + * @since 1.2 */ public Filter getExtraMatchRemainderFilter() { if (mExtraMatchRemainderFilter == null) { diff --git a/src/main/java/com/amazon/carbonado/raw/CustomStorableCodec.java b/src/main/java/com/amazon/carbonado/raw/CustomStorableCodec.java index cfb0883..b13a761 100644 --- a/src/main/java/com/amazon/carbonado/raw/CustomStorableCodec.java +++ b/src/main/java/com/amazon/carbonado/raw/CustomStorableCodec.java @@ -255,6 +255,7 @@ public abstract class CustomStorableCodec implements Storabl /** * @param isMaster when true, version properties and sequences are managed * @throws SupportException if Storable is not supported + * @since 1.2 */ public CustomStorableCodec(Class type, boolean isMaster, RawSupport support) throws SupportException @@ -271,11 +272,17 @@ public abstract class CustomStorableCodec implements Storabl return mType; } + /** + * @since 1.2 + */ @SuppressWarnings("unchecked") public S instantiate() { return (S) mInstanceFactory.instantiate(support(), this); } + /** + * @since 1.2 + */ @SuppressWarnings("unchecked") public S instantiate(byte[] key, byte[] value) throws FetchException @@ -303,6 +310,9 @@ public abstract class CustomStorableCodec implements Storabl return encodePrimaryKey(values, 0, mPkPropertyCount); } + /** + * @since 1.2 + */ public RawSupport getSupport() { return mSupport; } diff --git a/src/main/java/com/amazon/carbonado/raw/CustomStorableCodecFactory.java b/src/main/java/com/amazon/carbonado/raw/CustomStorableCodecFactory.java index a3af33f..43efe57 100644 --- a/src/main/java/com/amazon/carbonado/raw/CustomStorableCodecFactory.java +++ b/src/main/java/com/amazon/carbonado/raw/CustomStorableCodecFactory.java @@ -65,6 +65,7 @@ public abstract class CustomStorableCodecFactory implements StorableCodecFactory * generation value in each storable * @param support binds generated storable with a storage layer * @throws SupportException if type is not supported + * @since 1.2 */ public CustomStorableCodec createCodec(Class type, StorableIndex pkIndex, @@ -99,6 +100,7 @@ public abstract class CustomStorableCodecFactory implements StorableCodecFactory * generation value in each storable * @param support binds generated storable with a storage layer * @throws SupportException if type is not supported + * @since 1.2 */ // Note: This factory method is not abstract for backwards compatibility. protected CustomStorableCodec diff --git a/src/main/java/com/amazon/carbonado/raw/GenericStorableCodec.java b/src/main/java/com/amazon/carbonado/raw/GenericStorableCodec.java index 2532556..6a5d89d 100644 --- a/src/main/java/com/amazon/carbonado/raw/GenericStorableCodec.java +++ b/src/main/java/com/amazon/carbonado/raw/GenericStorableCodec.java @@ -376,6 +376,7 @@ public class GenericStorableCodec implements StorableCodec implements StorableCodec implements StorableCodec getSupport() { return mSupport; } diff --git a/src/main/java/com/amazon/carbonado/raw/GenericStorableCodecFactory.java b/src/main/java/com/amazon/carbonado/raw/GenericStorableCodecFactory.java index 3885505..770e4e2 100644 --- a/src/main/java/com/amazon/carbonado/raw/GenericStorableCodecFactory.java +++ b/src/main/java/com/amazon/carbonado/raw/GenericStorableCodecFactory.java @@ -69,6 +69,7 @@ public class GenericStorableCodecFactory implements StorableCodecFactory { * 128..max is encoded in four bytes, with the most significant bit set. * @param support binds generated storable with a storage layer * @throws SupportException if type is not supported + * @since 1.2 */ @SuppressWarnings("unchecked") public GenericStorableCodec createCodec(Class type, diff --git a/src/main/java/com/amazon/carbonado/raw/StorableCodec.java b/src/main/java/com/amazon/carbonado/raw/StorableCodec.java index f9e347c..fefb0fe 100644 --- a/src/main/java/com/amazon/carbonado/raw/StorableCodec.java +++ b/src/main/java/com/amazon/carbonado/raw/StorableCodec.java @@ -39,6 +39,7 @@ public interface StorableCodec { * {@link RawSupport} is supplied to the instance. * * @throws IllegalStateException if no default support exists + * @since 1.2 */ S instantiate(); @@ -47,6 +48,7 @@ public interface StorableCodec { * {@link RawSupport} is supplied to the instance. * * @throws IllegalStateException if no default support exists + * @since 1.2 */ S instantiate(byte[] key, byte[] value) throws FetchException; @@ -134,6 +136,8 @@ public interface StorableCodec { /** * Returns the default {@link RawSupport} object that is supplied to * Storable instances produced by this codec. + * + * @since 1.2 */ RawSupport getSupport(); } diff --git a/src/main/java/com/amazon/carbonado/raw/StorableCodecFactory.java b/src/main/java/com/amazon/carbonado/raw/StorableCodecFactory.java index db05a9e..8cc5be2 100644 --- a/src/main/java/com/amazon/carbonado/raw/StorableCodecFactory.java +++ b/src/main/java/com/amazon/carbonado/raw/StorableCodecFactory.java @@ -60,6 +60,7 @@ public interface StorableCodecFactory { * generation value in each storable * @param support binds generated storable with a storage layer * @throws SupportException if type is not supported + * @since 1.2 */ StorableCodec createCodec(Class type, StorableIndex pkIndex, diff --git a/src/main/java/com/amazon/carbonado/repo/indexed/DependentStorableFetcher.java b/src/main/java/com/amazon/carbonado/repo/indexed/DependentStorableFetcher.java index 31afb36..ce37f5f 100644 --- a/src/main/java/com/amazon/carbonado/repo/indexed/DependentStorableFetcher.java +++ b/src/main/java/com/amazon/carbonado/repo/indexed/DependentStorableFetcher.java @@ -42,6 +42,7 @@ import com.amazon.carbonado.info.StorableProperty; * Fetches Storables that have indexed derived-to properties which depend on S. * * @author Brian S O'Neill + * @since 1.2 */ class DependentStorableFetcher { private final IndexedRepository mRepository; diff --git a/src/main/java/com/amazon/carbonado/repo/indexed/DerivedIndexesTrigger.java b/src/main/java/com/amazon/carbonado/repo/indexed/DerivedIndexesTrigger.java index 0a99fdd..21c7215 100644 --- a/src/main/java/com/amazon/carbonado/repo/indexed/DerivedIndexesTrigger.java +++ b/src/main/java/com/amazon/carbonado/repo/indexed/DerivedIndexesTrigger.java @@ -35,6 +35,7 @@ import com.amazon.carbonado.info.ChainedProperty; * Handles index updates for derived-to properties. * * @author Brian S O'Neill + * @since 1.2 */ class DerivedIndexesTrigger extends Trigger { private final DependentStorableFetcher mFetcher; diff --git a/src/main/java/com/amazon/carbonado/repo/indexed/IndexAnalysis.java b/src/main/java/com/amazon/carbonado/repo/indexed/IndexAnalysis.java index d0e3405..31f5d7e 100644 --- a/src/main/java/com/amazon/carbonado/repo/indexed/IndexAnalysis.java +++ b/src/main/java/com/amazon/carbonado/repo/indexed/IndexAnalysis.java @@ -42,6 +42,7 @@ import com.amazon.carbonado.spi.StorableIndexSet; * Collection of static methods which perform index analysis. * * @author Brian S O'Neill + * @since 1.2 */ class IndexAnalysis { static StorableIndexSet gatherDesiredIndexes(StorableInfo info) { diff --git a/src/main/java/com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.java b/src/main/java/com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.java index e7ad8ed..d37c50d 100644 --- a/src/main/java/com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.java +++ b/src/main/java/com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.java @@ -172,6 +172,8 @@ public class IndexedRepositoryBuilder extends AbstractRepositoryBuilder { /** * Returns true if all indexes should be identified as clustered. This * affects how indexes are selected by the query analyzer. + * + * @since 1.2 */ public boolean isAllClustered() { return mAllClustered; @@ -181,6 +183,8 @@ public class IndexedRepositoryBuilder extends AbstractRepositoryBuilder { * When all indexes are identified as clustered, the query analyzer treats * all indexes as performing equally well. This is suitable for indexing * repositories that never read from a slow storage medium. + * + * @since 1.2 */ public void setAllClustered(boolean clustered) { mAllClustered = clustered; diff --git a/src/main/java/com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.java b/src/main/java/com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.java index b078e14..2329206 100644 --- a/src/main/java/com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.java +++ b/src/main/java/com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.java @@ -151,6 +151,8 @@ public class JDBCRepositoryBuilder extends AbstractRepositoryBuilder { /** * Pass true to cause the DataSource to be closed when the repository is * closed or shutdown. By default, this option is false. + * + * @since 1.2 */ public void setDataSourceCloseOnShutdown(boolean b) { mDataSourceClose = b; @@ -159,6 +161,8 @@ public class JDBCRepositoryBuilder extends AbstractRepositoryBuilder { /** * Returns true if DataSource is closed when the repository is closed or * shutdown. By default, this option is false. + * + * @since 1.2 */ public boolean getDataSourceCloseOnShutdown() { return mDataSourceClose; @@ -278,6 +282,7 @@ public class JDBCRepositoryBuilder extends AbstractRepositoryBuilder { * @param enabled true to enable, false to disable * @param className name of Storable type to enable automatic version * management on; pass null to enable all + * @since 1.2 */ public void setAutoVersioningEnabled(boolean enabled, String className) { if (mAutoVersioningMap == null) { @@ -296,6 +301,8 @@ public class JDBCRepositoryBuilder extends AbstractRepositoryBuilder { /** * Returns the native sequence select statement, which is null if the * default is chosen. + * + * @since 1.2 */ public String getSequenceSelectStatement() { return mSequenceSelectStatement; @@ -304,6 +311,8 @@ public class JDBCRepositoryBuilder extends AbstractRepositoryBuilder { /** * Override the default native sequence select statement with a printf. * For example, "SELECT %s.NEXTVAL FROM DUAL". + * + * @since 1.2 */ public void setSequenceSelectStatement(String sequenceSelectStatement) { mSequenceSelectStatement = sequenceSelectStatement; @@ -311,6 +320,8 @@ public class JDBCRepositoryBuilder extends AbstractRepositoryBuilder { /** * Returns true if native sequences should not be used. + * + * @since 1.2 */ public boolean isForceStoredSequence() { return mForceStoredSequence; @@ -321,6 +332,8 @@ public class JDBCRepositoryBuilder extends AbstractRepositoryBuilder { * named "CARBONADO_SEQUENCE" or "CARBONADO_SEQUENCES" is used instead to * hold sequence values. When forced, the table is always used instead of * native sequences. + * + * @since 1.2 */ public void setForceStoredSequence(boolean forceStoredSequence) { mForceStoredSequence = forceStoredSequence; diff --git a/src/main/java/com/amazon/carbonado/repo/jdbc/JDBCSequenceValueProducer.java b/src/main/java/com/amazon/carbonado/repo/jdbc/JDBCSequenceValueProducer.java index e2fb9a8..dd672ae 100644 --- a/src/main/java/com/amazon/carbonado/repo/jdbc/JDBCSequenceValueProducer.java +++ b/src/main/java/com/amazon/carbonado/repo/jdbc/JDBCSequenceValueProducer.java @@ -65,6 +65,9 @@ class JDBCSequenceValueProducer extends AbstractSequenceValueProducer { } } + /** + * @since 1.2 + */ public boolean returnReservedValues() { return false; } diff --git a/src/main/java/com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.java b/src/main/java/com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.java index 109725c..8eac9b4 100644 --- a/src/main/java/com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.java +++ b/src/main/java/com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.java @@ -74,6 +74,8 @@ public interface JDBCStorableInfo extends StorableInfo { /** * Returns auto-increment properties which are primary key members. The map * should almost always be empty or contain one property. + * + * @since 1.2 */ Map> getIdentityProperties(); diff --git a/src/main/java/com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.java b/src/main/java/com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.java index 9102c17..c86895a 100644 --- a/src/main/java/com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.java +++ b/src/main/java/com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.java @@ -48,6 +48,8 @@ public interface JDBCStorableProperty extends StorableProper /** * Returns true if property is declared as @Automatic and column is * designated as auto-increment. + * + * @since 1.2 */ boolean isAutoIncrement(); diff --git a/src/main/java/com/amazon/carbonado/repo/jdbc/JDBCStorage.java b/src/main/java/com/amazon/carbonado/repo/jdbc/JDBCStorage.java index 12d6790..70894b6 100644 --- a/src/main/java/com/amazon/carbonado/repo/jdbc/JDBCStorage.java +++ b/src/main/java/com/amazon/carbonado/repo/jdbc/JDBCStorage.java @@ -128,6 +128,9 @@ class JDBCStorage extends StandardQueryFactory return property != null && property.isSupported(); } + /** + * @since 1.2 + */ public void truncate() throws PersistException { String truncateFormat = mSupportStrategy.getTruncateTableStatement(); diff --git a/src/main/java/com/amazon/carbonado/repo/jdbc/JDBCSupportStrategy.java b/src/main/java/com/amazon/carbonado/repo/jdbc/JDBCSupportStrategy.java index 8a27c3d..3643c65 100644 --- a/src/main/java/com/amazon/carbonado/repo/jdbc/JDBCSupportStrategy.java +++ b/src/main/java/com/amazon/carbonado/repo/jdbc/JDBCSupportStrategy.java @@ -92,6 +92,9 @@ class JDBCSupportStrategy { return new JDBCExceptionTransformer(); } + /** + * @since 1.2 + */ SequenceValueProducer createSequenceValueProducer(String name) throws RepositoryException { @@ -239,20 +242,30 @@ class JDBCSupportStrategy { * Returns the optional sequence select statement format. The format is * printf style with 1 string parameter which can be passed through {@link * String#format(String, Object[])} to create a sql statement. - * @return + * + * @since 1.2 */ String getSequenceSelectStatement() { return mSequenceSelectStatement; } + /** + * @since 1.2 + */ void setSequenceSelectStatement(String sequenceSelectStatement) { mSequenceSelectStatement = sequenceSelectStatement; } + /** + * @since 1.2 + */ boolean isForceStoredSequence() { return mForceStoredSequence; } + /** + * @since 1.2 + */ void setForceStoredSequence(boolean forceStoredSequence) { mForceStoredSequence = forceStoredSequence; } @@ -261,11 +274,16 @@ class JDBCSupportStrategy { * Return the optional truncate table statement format. The format is * printf style with 1 string parameter which can be passed through {@link * String#format(String, Object[])} to create a sql statement. + * + * @since 1.2 */ String getTruncateTableStatement() { return mTruncateTableStatement; } + /** + * @since 1.2 + */ void setTruncateTableStatement(String truncateTableStatement) { mTruncateTableStatement = truncateTableStatement; } diff --git a/src/main/java/com/amazon/carbonado/repo/jdbc/LoggingCallableStatement.java b/src/main/java/com/amazon/carbonado/repo/jdbc/LoggingCallableStatement.java index 140fbd0..c3958a9 100644 --- a/src/main/java/com/amazon/carbonado/repo/jdbc/LoggingCallableStatement.java +++ b/src/main/java/com/amazon/carbonado/repo/jdbc/LoggingCallableStatement.java @@ -386,114 +386,189 @@ class LoggingCallableStatement extends LoggingPreparedStatement implements Calla return cs().getURL(parameterName); } + /** + * @since 1.2 + */ public RowId getRowId(int parameterIndex) throws SQLException { return cs().getRowId(parameterIndex); } + /** + * @since 1.2 + */ public RowId getRowId(String parameterName) throws SQLException { return cs().getRowId(parameterName); } + /** + * @since 1.2 + */ public void setRowId(String parameterName, RowId x) throws SQLException { cs().setRowId(parameterName, x); } + /** + * @since 1.2 + */ public void setNString(String parameterName, String value) throws SQLException { cs().setNString(parameterName, value); } + /** + * @since 1.2 + */ public void setNCharacterStream(String parameterName, java.io.Reader value, long length) throws SQLException { cs().setNCharacterStream(parameterName, value, length); } + /** + * @since 1.2 + */ public void setNClob(String parameterName, NClob value) throws SQLException { cs().setNClob(parameterName, value); } + /** + * @since 1.2 + */ public void setClob(String parameterName, java.io.Reader reader, long length) throws SQLException { cs().setClob(parameterName, reader, length); } + /** + * @since 1.2 + */ public void setBlob(String parameterName, java.io.InputStream inputStream, long length) throws SQLException { cs().setBlob(parameterName, inputStream, length); } + /** + * @since 1.2 + */ public void setNClob(String parameterName, java.io.Reader reader, long length) throws SQLException { cs().setNClob(parameterName, reader, length); } + /** + * @since 1.2 + */ public NClob getNClob (int parameterIndex) throws SQLException { return cs().getNClob(parameterIndex); } + /** + * @since 1.2 + */ public NClob getNClob (String parameterName) throws SQLException { return cs().getNClob(parameterName); } + /** + * @since 1.2 + */ public void setSQLXML(String parameterName, SQLXML xmlObject) throws SQLException { cs().setSQLXML(parameterName, xmlObject); } + /** + * @since 1.2 + */ public SQLXML getSQLXML(int parameterIndex) throws SQLException { return cs().getSQLXML(parameterIndex); } + /** + * @since 1.2 + */ public SQLXML getSQLXML(String parameterName) throws SQLException { return cs().getSQLXML(parameterName); } + /** + * @since 1.2 + */ public String getNString(int parameterIndex) throws SQLException { return cs().getNString(parameterIndex); } + /** + * @since 1.2 + */ public String getNString(String parameterName) throws SQLException { return cs().getNString(parameterName); } + /** + * @since 1.2 + */ public java.io.Reader getNCharacterStream(int parameterIndex) throws SQLException { return cs().getNCharacterStream(parameterIndex); } + /** + * @since 1.2 + */ public java.io.Reader getNCharacterStream(String parameterName) throws SQLException { return cs().getNCharacterStream(parameterName); } + /** + * @since 1.2 + */ public java.io.Reader getCharacterStream(int parameterIndex) throws SQLException { return cs().getCharacterStream(parameterIndex); } + /** + * @since 1.2 + */ public java.io.Reader getCharacterStream(String parameterName) throws SQLException { return cs().getCharacterStream(parameterName); } + /** + * @since 1.2 + */ public void setBlob(String parameterName, Blob x) throws SQLException { cs().setBlob(parameterName, x); } + /** + * @since 1.2 + */ public void setClob(String parameterName, Clob x) throws SQLException { cs().setClob(parameterName, x); } + /** + * @since 1.2 + */ public void setAsciiStream(String parameterName, java.io.InputStream x, long length) throws SQLException { cs().setAsciiStream(parameterName, x, length); } + /** + * @since 1.2 + */ public void setBinaryStream(String parameterName, java.io.InputStream x, long length) throws SQLException { cs().setBinaryStream(parameterName, x, length); } + /** + * @since 1.2 + */ public void setCharacterStream(String parameterName, java.io.Reader reader, long length) @@ -502,40 +577,61 @@ class LoggingCallableStatement extends LoggingPreparedStatement implements Calla cs().setCharacterStream(parameterName, reader, length); } + /** + * @since 1.2 + */ public void setAsciiStream(String parameterName, java.io.InputStream x) throws SQLException { cs().setAsciiStream(parameterName, x); } + /** + * @since 1.2 + */ public void setBinaryStream(String parameterName, java.io.InputStream x) throws SQLException { cs().setBinaryStream(parameterName, x); } + /** + * @since 1.2 + */ public void setCharacterStream(String parameterName, java.io.Reader reader) throws SQLException { cs().setCharacterStream(parameterName, reader); } + /** + * @since 1.2 + */ public void setNCharacterStream(String parameterName, java.io.Reader value) throws SQLException { cs().setNCharacterStream(parameterName, value); } + /** + * @since 1.2 + */ public void setClob(String parameterName, java.io.Reader reader) throws SQLException { cs().setClob(parameterName, reader); } + /** + * @since 1.2 + */ public void setBlob(String parameterName, java.io.InputStream inputStream) throws SQLException { cs().setBlob(parameterName, inputStream); } + /** + * @since 1.2 + */ public void setNClob(String parameterName, java.io.Reader reader) throws SQLException { diff --git a/src/main/java/com/amazon/carbonado/repo/jdbc/LoggingConnection.java b/src/main/java/com/amazon/carbonado/repo/jdbc/LoggingConnection.java index 3a2a6cb..8ca4226 100644 --- a/src/main/java/com/amazon/carbonado/repo/jdbc/LoggingConnection.java +++ b/src/main/java/com/amazon/carbonado/repo/jdbc/LoggingConnection.java @@ -225,54 +225,93 @@ class LoggingConnection implements Connection { mCon.releaseSavepoint(savepoint); } + /** + * @since 1.2 + */ public Clob createClob() throws SQLException { return mCon.createClob(); } + /** + * @since 1.2 + */ public Blob createBlob() throws SQLException { return mCon.createBlob(); } + /** + * @since 1.2 + */ public NClob createNClob() throws SQLException { return mCon.createNClob(); } + /** + * @since 1.2 + */ public SQLXML createSQLXML() throws SQLException { return mCon.createSQLXML(); } + /** + * @since 1.2 + */ public boolean isValid(int timeout) throws SQLException { return mCon.isValid(timeout); } + /** + * @since 1.2 + */ public void setClientInfo(String name, String value) throws SQLClientInfoException { mCon.setClientInfo(name, value); } + /** + * @since 1.2 + */ public void setClientInfo(java.util.Properties properties) throws SQLClientInfoException { mCon.setClientInfo(properties); } + /** + * @since 1.2 + */ public String getClientInfo(String name) throws SQLException { return mCon.getClientInfo(name); } + /** + * @since 1.2 + */ public java.util.Properties getClientInfo() throws SQLException { return mCon.getClientInfo(); } + /** + * @since 1.2 + */ public Array createArrayOf(String typeName, Object[] elements) throws SQLException { return mCon.createArrayOf(typeName, elements); } + /** + * @since 1.2 + */ public Struct createStruct(String typeName, Object[] attributes) throws SQLException { return mCon.createStruct(typeName, attributes); } + /** + * @since 1.2 + */ public T unwrap(Class iface) throws SQLException { throw new UnsupportedOperationException(); } + /** + * @since 1.2 + */ public boolean isWrapperFor(Class iface) throws SQLException { throw new UnsupportedOperationException(); } diff --git a/src/main/java/com/amazon/carbonado/repo/jdbc/LoggingDataSource.java b/src/main/java/com/amazon/carbonado/repo/jdbc/LoggingDataSource.java index ab6a2f9..0ba53fd 100644 --- a/src/main/java/com/amazon/carbonado/repo/jdbc/LoggingDataSource.java +++ b/src/main/java/com/amazon/carbonado/repo/jdbc/LoggingDataSource.java @@ -91,6 +91,9 @@ public class LoggingDataSource implements DataSource { return mDataSource.getLoginTimeout(); } + /** + * @since 1.2 + */ public void close() throws SQLException { mLog.debug("DataSource.close()"); if (!JDBCRepository.closeDataSource(mDataSource)) { @@ -99,10 +102,16 @@ public class LoggingDataSource implements DataSource { } } + /** + * @since 1.2 + */ public T unwrap(Class iface) throws SQLException { throw new UnsupportedOperationException(); } + /** + * @since 1.2 + */ public boolean isWrapperFor(Class iface) throws SQLException { throw new UnsupportedOperationException(); } diff --git a/src/main/java/com/amazon/carbonado/repo/jdbc/LoggingPreparedStatement.java b/src/main/java/com/amazon/carbonado/repo/jdbc/LoggingPreparedStatement.java index 6fbfa9b..9406005 100644 --- a/src/main/java/com/amazon/carbonado/repo/jdbc/LoggingPreparedStatement.java +++ b/src/main/java/com/amazon/carbonado/repo/jdbc/LoggingPreparedStatement.java @@ -249,58 +249,91 @@ class LoggingPreparedStatement extends LoggingStatement implements PreparedState return ps().getParameterMetaData(); } + /** + * @since 1.2 + */ public void setRowId(int parameterIndex, RowId x) throws SQLException { ps().setRowId(parameterIndex, x); } + /** + * @since 1.2 + */ public void setNString(int parameterIndex, String value) throws SQLException { ps().setNString(parameterIndex, value); } + /** + * @since 1.2 + */ public void setNCharacterStream(int parameterIndex, java.io.Reader value, long length) throws SQLException { ps().setNCharacterStream(parameterIndex, value, length); } + /** + * @since 1.2 + */ public void setNClob(int parameterIndex, NClob value) throws SQLException { ps().setNClob(parameterIndex, value); } + /** + * @since 1.2 + */ public void setClob(int parameterIndex, java.io.Reader reader, long length) throws SQLException { ps().setClob(parameterIndex, reader, length); } + /** + * @since 1.2 + */ public void setBlob(int parameterIndex, java.io.InputStream inputStream, long length) throws SQLException { ps().setBlob(parameterIndex, inputStream, length); } + /** + * @since 1.2 + */ public void setNClob(int parameterIndex, java.io.Reader reader, long length) throws SQLException { ps().setNClob(parameterIndex, reader, length); } + /** + * @since 1.2 + */ public void setSQLXML(int parameterIndex, SQLXML xmlObject) throws SQLException { ps().setSQLXML(parameterIndex, xmlObject); } + /** + * @since 1.2 + */ public void setAsciiStream(int parameterIndex, java.io.InputStream x, long length) throws SQLException { ps().setAsciiStream(parameterIndex, x, length); } + /** + * @since 1.2 + */ public void setBinaryStream(int parameterIndex, java.io.InputStream x, long length) throws SQLException { ps().setBinaryStream(parameterIndex, x, length); } + /** + * @since 1.2 + */ public void setCharacterStream(int parameterIndex, java.io.Reader reader, long length) @@ -309,32 +342,53 @@ class LoggingPreparedStatement extends LoggingStatement implements PreparedState ps().setCharacterStream(parameterIndex, reader, length); } + /** + * @since 1.2 + */ public void setAsciiStream(int parameterIndex, java.io.InputStream x) throws SQLException { ps().setAsciiStream(parameterIndex, x); } + /** + * @since 1.2 + */ public void setBinaryStream(int parameterIndex, java.io.InputStream x) throws SQLException { ps().setBinaryStream(parameterIndex, x); } + /** + * @since 1.2 + */ public void setCharacterStream(int parameterIndex, java.io.Reader reader) throws SQLException { ps().setCharacterStream(parameterIndex, reader); } + /** + * @since 1.2 + */ public void setNCharacterStream(int parameterIndex, java.io.Reader value) throws SQLException { ps().setNCharacterStream(parameterIndex, value); } + /** + * @since 1.2 + */ public void setClob(int parameterIndex, java.io.Reader reader) throws SQLException { ps().setClob(parameterIndex, reader); } + /** + * @since 1.2 + */ public void setBlob(int parameterIndex, java.io.InputStream inputStream) throws SQLException { ps().setBlob(parameterIndex, inputStream); } + /** + * @since 1.2 + */ public void setNClob(int parameterIndex, java.io.Reader reader) throws SQLException { ps().setNClob(parameterIndex, reader); } diff --git a/src/main/java/com/amazon/carbonado/repo/jdbc/LoggingStatement.java b/src/main/java/com/amazon/carbonado/repo/jdbc/LoggingStatement.java index 5dc8d5e..ea5be89 100644 --- a/src/main/java/com/amazon/carbonado/repo/jdbc/LoggingStatement.java +++ b/src/main/java/com/amazon/carbonado/repo/jdbc/LoggingStatement.java @@ -198,22 +198,37 @@ class LoggingStatement implements Statement { return mStatement.getResultSetHoldability(); } + /** + * @since 1.2 + */ public boolean isClosed() throws SQLException { return mStatement.isClosed(); } + /** + * @since 1.2 + */ public void setPoolable(boolean poolable) throws SQLException { mStatement.setPoolable(poolable); } + /** + * @since 1.2 + */ public boolean isPoolable() throws SQLException { return mStatement.isPoolable(); } + /** + * @since 1.2 + */ public T unwrap(Class iface) throws SQLException { throw new UnsupportedOperationException(); } + /** + * @since 1.2 + */ public boolean isWrapperFor(Class iface) throws SQLException { throw new UnsupportedOperationException(); } diff --git a/src/main/java/com/amazon/carbonado/repo/jdbc/SimpleDataSource.java b/src/main/java/com/amazon/carbonado/repo/jdbc/SimpleDataSource.java index ee355de..fb01b4b 100644 --- a/src/main/java/com/amazon/carbonado/repo/jdbc/SimpleDataSource.java +++ b/src/main/java/com/amazon/carbonado/repo/jdbc/SimpleDataSource.java @@ -87,13 +87,22 @@ public class SimpleDataSource implements DataSource { return 0; } + /** + * @since 1.2 + */ public void close() throws SQLException { } + /** + * @since 1.2 + */ public T unwrap(Class iface) throws SQLException { throw new UnsupportedOperationException(); } + /** + * @since 1.2 + */ public boolean isWrapperFor(Class iface) throws SQLException { throw new UnsupportedOperationException(); } diff --git a/src/main/java/com/amazon/carbonado/repo/logging/LoggingStorage.java b/src/main/java/com/amazon/carbonado/repo/logging/LoggingStorage.java index de1118f..a6a56a1 100644 --- a/src/main/java/com/amazon/carbonado/repo/logging/LoggingStorage.java +++ b/src/main/java/com/amazon/carbonado/repo/logging/LoggingStorage.java @@ -41,6 +41,9 @@ class LoggingStorage extends WrappedStorage { mRepo = repo; } + /** + * @since 1.2 + */ public void truncate() throws PersistException { Log log = mRepo.getLog(); if (log.isEnabled()) { diff --git a/src/main/java/com/amazon/carbonado/repo/replicated/ReplicatedStorage.java b/src/main/java/com/amazon/carbonado/repo/replicated/ReplicatedStorage.java index 5d3f47b..e3a0ec5 100644 --- a/src/main/java/com/amazon/carbonado/repo/replicated/ReplicatedStorage.java +++ b/src/main/java/com/amazon/carbonado/repo/replicated/ReplicatedStorage.java @@ -106,6 +106,9 @@ class ReplicatedStorage implements Storage { return mReplicaStorage.query(filter); } + /** + * @since 1.2 + */ public void truncate() throws PersistException { mMasterStorage.truncate(); mReplicaStorage.truncate(); diff --git a/src/main/java/com/amazon/carbonado/repo/sleepycat/BDBStorage.java b/src/main/java/com/amazon/carbonado/repo/sleepycat/BDBStorage.java index d42b89f..c33acba 100644 --- a/src/main/java/com/amazon/carbonado/repo/sleepycat/BDBStorage.java +++ b/src/main/java/com/amazon/carbonado/repo/sleepycat/BDBStorage.java @@ -173,6 +173,9 @@ abstract class BDBStorage implements Storage, Storag return mQueryEngine.query(filter); } + /** + * @since 1.2 + */ public void truncate() throws PersistException { if (mTriggerManager.getDeleteTrigger() != null || mRepository.mSingleFileName != null) { final int batchSize = 100; diff --git a/src/main/java/com/amazon/carbonado/sequence/AbstractSequenceValueProducer.java b/src/main/java/com/amazon/carbonado/sequence/AbstractSequenceValueProducer.java index 8deb3d7..d00caae 100644 --- a/src/main/java/com/amazon/carbonado/sequence/AbstractSequenceValueProducer.java +++ b/src/main/java/com/amazon/carbonado/sequence/AbstractSequenceValueProducer.java @@ -26,6 +26,7 @@ import com.amazon.carbonado.PersistException; * * * @author Brian S O'Neill + * @since 1.2 */ public abstract class AbstractSequenceValueProducer implements SequenceValueProducer { protected AbstractSequenceValueProducer() { diff --git a/src/main/java/com/amazon/carbonado/sequence/SequenceCapability.java b/src/main/java/com/amazon/carbonado/sequence/SequenceCapability.java index 0e26eec..c5b7738 100644 --- a/src/main/java/com/amazon/carbonado/sequence/SequenceCapability.java +++ b/src/main/java/com/amazon/carbonado/sequence/SequenceCapability.java @@ -25,7 +25,7 @@ import com.amazon.carbonado.capability.Capability; * Capability to use sequences. * * @author bcastill - * + * @since 1.2 */ public interface SequenceCapability extends Capability { diff --git a/src/main/java/com/amazon/carbonado/sequence/SequenceValueGenerator.java b/src/main/java/com/amazon/carbonado/sequence/SequenceValueGenerator.java index 1371a32..6d8e655 100644 --- a/src/main/java/com/amazon/carbonado/sequence/SequenceValueGenerator.java +++ b/src/main/java/com/amazon/carbonado/sequence/SequenceValueGenerator.java @@ -32,6 +32,7 @@ import com.amazon.carbonado.Transaction; * @author bcastill * @see com.amazon.carbonado.Sequence * @see StoredSequence + * @since 1.2 */ public class SequenceValueGenerator extends AbstractSequenceValueProducer { public static final int DEFAULT_RESERVE_AMOUNT = 100; diff --git a/src/main/java/com/amazon/carbonado/sequence/SequenceValueProducer.java b/src/main/java/com/amazon/carbonado/sequence/SequenceValueProducer.java index 5f7fa03..324a95f 100644 --- a/src/main/java/com/amazon/carbonado/sequence/SequenceValueProducer.java +++ b/src/main/java/com/amazon/carbonado/sequence/SequenceValueProducer.java @@ -27,6 +27,7 @@ import com.amazon.carbonado.PersistException; * @author Brian S O'Neill * @author bcastill * @see com.amazon.carbonado.Sequence + * @since 1.2 */ public interface SequenceValueProducer { /** diff --git a/src/main/java/com/amazon/carbonado/sequence/SequenceValueProducerPool.java b/src/main/java/com/amazon/carbonado/sequence/SequenceValueProducerPool.java index 9b9cb8c..ccebda3 100644 --- a/src/main/java/com/amazon/carbonado/sequence/SequenceValueProducerPool.java +++ b/src/main/java/com/amazon/carbonado/sequence/SequenceValueProducerPool.java @@ -31,6 +31,7 @@ import com.amazon.carbonado.util.AbstractPool; * * @author bcastill * @author Brian S O'Neill + * @since 1.2 */ public abstract class SequenceValueProducerPool extends AbstractPool diff --git a/src/main/java/com/amazon/carbonado/sequence/StoredSequence.java b/src/main/java/com/amazon/carbonado/sequence/StoredSequence.java index 3fa770e..b3ecd88 100644 --- a/src/main/java/com/amazon/carbonado/sequence/StoredSequence.java +++ b/src/main/java/com/amazon/carbonado/sequence/StoredSequence.java @@ -38,6 +38,7 @@ import com.amazon.carbonado.Version; * * * @author Brian S O'Neill + * @since 1.2 */ @PrimaryKey("name") @Authoritative diff --git a/src/main/java/com/amazon/carbonado/sequence/package-info.java b/src/main/java/com/amazon/carbonado/sequence/package-info.java index d464166..8a87e52 100644 --- a/src/main/java/com/amazon/carbonado/sequence/package-info.java +++ b/src/main/java/com/amazon/carbonado/sequence/package-info.java @@ -22,5 +22,6 @@ * control over sequences might be desired. * * @see com.amazon.carbonado.Sequence + * @since 1.2 */ package com.amazon.carbonado.sequence; diff --git a/src/main/java/com/amazon/carbonado/spi/AbstractRepository.java b/src/main/java/com/amazon/carbonado/spi/AbstractRepository.java index d1c1843..0dc1e74 100644 --- a/src/main/java/com/amazon/carbonado/spi/AbstractRepository.java +++ b/src/main/java/com/amazon/carbonado/spi/AbstractRepository.java @@ -50,6 +50,7 @@ import com.amazon.carbonado.sequence.SequenceValueProducerPool; * * @param Transaction type * @author Brian S O'Neill + * @since 1.2 */ public abstract class AbstractRepository implements Repository, ShutdownCapability, SequenceCapability diff --git a/src/main/java/com/amazon/carbonado/spi/LobEngine.java b/src/main/java/com/amazon/carbonado/spi/LobEngine.java index d91ce5e..d6ab994 100644 --- a/src/main/java/com/amazon/carbonado/spi/LobEngine.java +++ b/src/main/java/com/amazon/carbonado/spi/LobEngine.java @@ -94,6 +94,7 @@ public class LobEngine { * @param lobRepo storage for Lobs - should not be replicated * @param locatorRepo storage for producing unique values for Lob locators * - should be root repository + * @since 1.2 */ public LobEngine(Repository lobRepo, Repository locatorRepo) throws RepositoryException { // Cannot reliably use sequences provided by Lob repository, since @@ -104,6 +105,7 @@ public class LobEngine { /** * @param lobRepo storage for Lobs - should not be replicated * @param locatorSequenceProducer source of unique values for Lob locators + * @since 1.2 */ public LobEngine(Repository lobRepo, SequenceValueProducer locatorSequenceProducer) throws RepositoryException diff --git a/src/main/java/com/amazon/carbonado/spi/StorableIndexSet.java b/src/main/java/com/amazon/carbonado/spi/StorableIndexSet.java index 2f943ea..f43bdd4 100644 --- a/src/main/java/com/amazon/carbonado/spi/StorableIndexSet.java +++ b/src/main/java/com/amazon/carbonado/spi/StorableIndexSet.java @@ -205,6 +205,7 @@ public class StorableIndexSet extends TreeSet, StorableIndex> replacements = null; diff --git a/src/main/java/com/amazon/carbonado/spi/StoragePool.java b/src/main/java/com/amazon/carbonado/spi/StoragePool.java index 9382723..98472b0 100644 --- a/src/main/java/com/amazon/carbonado/spi/StoragePool.java +++ b/src/main/java/com/amazon/carbonado/spi/StoragePool.java @@ -31,6 +31,7 @@ import com.amazon.carbonado.util.AbstractPool; * Storable type. Storage instances are lazily created and pooled. * * @author Brian S O'Neill + * @since 1.2 */ public abstract class StoragePool extends AbstractPool diff --git a/src/main/java/com/amazon/carbonado/spi/WrappedStorage.java b/src/main/java/com/amazon/carbonado/spi/WrappedStorage.java index ea12223..54db355 100644 --- a/src/main/java/com/amazon/carbonado/spi/WrappedStorage.java +++ b/src/main/java/com/amazon/carbonado/spi/WrappedStorage.java @@ -81,6 +81,9 @@ public abstract class WrappedStorage implements Storage { return wrap(mStorage.query(filter)); } + /** + * @since 1.2 + */ public void truncate() throws PersistException { mStorage.truncate(); } diff --git a/src/main/java/com/amazon/carbonado/util/AbstractPool.java b/src/main/java/com/amazon/carbonado/util/AbstractPool.java index 896802d..05d2c09 100644 --- a/src/main/java/com/amazon/carbonado/util/AbstractPool.java +++ b/src/main/java/com/amazon/carbonado/util/AbstractPool.java @@ -29,6 +29,7 @@ import java.util.concurrent.locks.Lock; * lazily created and pooled. * * @author Brian S O'Neill + * @since 1.2 */ public abstract class AbstractPool { private final ConcurrentMap mValues; diff --git a/src/main/java/com/amazon/carbonado/util/AbstractWeakPool.java b/src/main/java/com/amazon/carbonado/util/AbstractWeakPool.java index 8ae5476..79bc4d5 100644 --- a/src/main/java/com/amazon/carbonado/util/AbstractWeakPool.java +++ b/src/main/java/com/amazon/carbonado/util/AbstractWeakPool.java @@ -31,6 +31,7 @@ import java.util.concurrent.ConcurrentMap; * * @author Brian S O'Neill * @see AbstractPool + * @since 1.2 */ abstract class AbstractWeakPool { private final ConcurrentMap> mValues; diff --git a/src/main/java/com/amazon/carbonado/util/WeakReentrantLockPool.java b/src/main/java/com/amazon/carbonado/util/WeakReentrantLockPool.java index 5bfd58c..b44a823 100644 --- a/src/main/java/com/amazon/carbonado/util/WeakReentrantLockPool.java +++ b/src/main/java/com/amazon/carbonado/util/WeakReentrantLockPool.java @@ -25,6 +25,7 @@ import java.util.concurrent.locks.ReentrantLock; * mapped by key. Locks are created (and recreated) as needed. * * @author Brian S O'Neill + * @since 1.2 */ class WeakReentrantLockPool extends AbstractWeakPool diff --git a/src/main/java/com/amazon/carbonado/util/WeakReentrantReadWriteLockPool.java b/src/main/java/com/amazon/carbonado/util/WeakReentrantReadWriteLockPool.java index b41ad1f..3b0663e 100644 --- a/src/main/java/com/amazon/carbonado/util/WeakReentrantReadWriteLockPool.java +++ b/src/main/java/com/amazon/carbonado/util/WeakReentrantReadWriteLockPool.java @@ -25,6 +25,7 @@ import java.util.concurrent.locks.ReentrantReadWriteLock; * instances mapped by key. Locks are created (and recreated) as needed. * * @author Brian S O'Neill + * @since 1.2 */ class WeakReentrantReadWriteLockPool extends AbstractWeakPool -- cgit v1.2.3