core/api: fix all javadoc warnings
Project: http://git-wip-us.apache.org/repos/asf/zest-java/repo Commit: http://git-wip-us.apache.org/repos/asf/zest-java/commit/1fc02df3 Tree: http://git-wip-us.apache.org/repos/asf/zest-java/tree/1fc02df3 Diff: http://git-wip-us.apache.org/repos/asf/zest-java/diff/1fc02df3 Branch: refs/heads/develop Commit: 1fc02df3a2ec153f1066a0940b779cc76a83a581 Parents: c21df5f Author: Paul Merlin <[email protected]> Authored: Sun Dec 18 00:10:25 2016 +0100 Committer: Paul Merlin <[email protected]> Committed: Sun Dec 18 00:10:25 2016 +0100 ---------------------------------------------------------------------- .../api/association/AssociationStateHolder.java | 3 +++ .../api/composite/TransientBuilder.java | 3 +++ .../api/composite/TransientBuilderFactory.java | 3 +++ .../api/configuration/Configuration.java | 6 +++-- .../polygene/api/entity/EntityBuilder.java | 3 +++ .../polygene/api/metrics/MetricsTimer.java | 2 ++ .../polygene/api/object/ObjectFactory.java | 4 +++- .../polygene/api/property/StateHolder.java | 1 + .../org/apache/polygene/api/query/Query.java | 3 +++ .../apache/polygene/api/query/QueryBuilder.java | 2 ++ .../polygene/api/query/QueryBuilderFactory.java | 1 + .../polygene/api/query/QueryExpressions.java | 24 ++++++++++++++++++++ .../polygene/api/service/ServiceActivation.java | 4 ++++ .../polygene/api/service/ServiceFinder.java | 4 ++++ .../polygene/api/structure/MetaInfoHolder.java | 1 + .../org/apache/polygene/api/type/ValueType.java | 5 +++- .../polygene/api/unitofwork/UnitOfWork.java | 6 +++++ .../api/unitofwork/UnitOfWorkCallback.java | 9 ++++---- .../api/unitofwork/UnitOfWorkFactory.java | 5 ++++ .../apache/polygene/api/value/ValueBuilder.java | 3 +++ .../polygene/api/value/ValueBuilderFactory.java | 5 ++++ .../polygene/api/value/ValueDeserializer.java | 10 ++++++-- 22 files changed, 96 insertions(+), 11 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/zest-java/blob/1fc02df3/core/api/src/main/java/org/apache/polygene/api/association/AssociationStateHolder.java ---------------------------------------------------------------------- diff --git a/core/api/src/main/java/org/apache/polygene/api/association/AssociationStateHolder.java b/core/api/src/main/java/org/apache/polygene/api/association/AssociationStateHolder.java index 6b1cf42..9cf336b 100644 --- a/core/api/src/main/java/org/apache/polygene/api/association/AssociationStateHolder.java +++ b/core/api/src/main/java/org/apache/polygene/api/association/AssociationStateHolder.java @@ -32,6 +32,7 @@ public interface AssociationStateHolder /** * Get an association for a specific accessor method. * + * @param <T> Association type * @param associationMethod for the association * * @return the association @@ -48,6 +49,7 @@ public interface AssociationStateHolder /** * Get a many-association for a specific accessor method. * + * @param <T> Association type * @param manyassociationMethod for the many-association * * @return the association @@ -64,6 +66,7 @@ public interface AssociationStateHolder /** * Get a named-association for a specific accessor method. * + * @param <T> Association type * @param namedassociationMethod for the named-association * * @return the association http://git-wip-us.apache.org/repos/asf/zest-java/blob/1fc02df3/core/api/src/main/java/org/apache/polygene/api/composite/TransientBuilder.java ---------------------------------------------------------------------- diff --git a/core/api/src/main/java/org/apache/polygene/api/composite/TransientBuilder.java b/core/api/src/main/java/org/apache/polygene/api/composite/TransientBuilder.java index e42a904..76e755a 100644 --- a/core/api/src/main/java/org/apache/polygene/api/composite/TransientBuilder.java +++ b/core/api/src/main/java/org/apache/polygene/api/composite/TransientBuilder.java @@ -25,6 +25,8 @@ import org.apache.polygene.api.common.ConstructionException; * TransientBuilders are used to instantiate TransientComposites. They can be acquired from * {@link TransientBuilderFactory#newTransientBuilder(Class)} and allows the client * to provide additional settings before instantiating the TransientComposite. + * + * @param <T> Transient type */ public interface TransientBuilder<T> { @@ -53,6 +55,7 @@ public interface TransientBuilder<T> * Get a representation of the state of the given type for the new Composite. * This is primarily used if you want to provide state for a private mixin type. * + * @param <K> Mixin type * @param mixinType the mixin which you want to provide state for * * @return a proxy implementing the given mixin type http://git-wip-us.apache.org/repos/asf/zest-java/blob/1fc02df3/core/api/src/main/java/org/apache/polygene/api/composite/TransientBuilderFactory.java ---------------------------------------------------------------------- diff --git a/core/api/src/main/java/org/apache/polygene/api/composite/TransientBuilderFactory.java b/core/api/src/main/java/org/apache/polygene/api/composite/TransientBuilderFactory.java index 7c6c7a1..5656c71 100644 --- a/core/api/src/main/java/org/apache/polygene/api/composite/TransientBuilderFactory.java +++ b/core/api/src/main/java/org/apache/polygene/api/composite/TransientBuilderFactory.java @@ -34,6 +34,7 @@ public interface TransientBuilderFactory /** * Create a builder for creating new TransientComposites that implements the given TransientComposite type. * + * @param <T> Transient type * @param mixinType an interface that describes the TransientComposite to be instantiated * * @return a TransientBuilder for creation of TransientComposites implementing the interface @@ -46,7 +47,9 @@ public interface TransientBuilderFactory /** * Instantiate a TransientComposite of the given type. * + * @param <T> Transient type * @param mixinType the TransientComposite type to instantiate + * @param uses The objects that can be injected into mixins * * @return a new TransientComposite instance * http://git-wip-us.apache.org/repos/asf/zest-java/blob/1fc02df3/core/api/src/main/java/org/apache/polygene/api/configuration/Configuration.java ---------------------------------------------------------------------- diff --git a/core/api/src/main/java/org/apache/polygene/api/configuration/Configuration.java b/core/api/src/main/java/org/apache/polygene/api/configuration/Configuration.java index 60da8eb..96822a0 100644 --- a/core/api/src/main/java/org/apache/polygene/api/configuration/Configuration.java +++ b/core/api/src/main/java/org/apache/polygene/api/configuration/Configuration.java @@ -118,6 +118,8 @@ import org.apache.polygene.api.value.ValueSerialization; * : * } * </code></pre> + * + * @param <T> Configuration type */ @SuppressWarnings( "JavadocReference" ) @Mixins( Configuration.ConfigurationMixin.class ) @@ -155,9 +157,9 @@ public interface Configuration<T> * This is effectively an internal class in Polygene and should never be used directly by user code. * </p> * - * @param <T> + * @param <T> Configuration type */ - public class ConfigurationMixin<T> + class ConfigurationMixin<T> implements Configuration<T> { private T configuration; http://git-wip-us.apache.org/repos/asf/zest-java/blob/1fc02df3/core/api/src/main/java/org/apache/polygene/api/entity/EntityBuilder.java ---------------------------------------------------------------------- diff --git a/core/api/src/main/java/org/apache/polygene/api/entity/EntityBuilder.java b/core/api/src/main/java/org/apache/polygene/api/entity/EntityBuilder.java index 0fcdeff..2e31766 100644 --- a/core/api/src/main/java/org/apache/polygene/api/entity/EntityBuilder.java +++ b/core/api/src/main/java/org/apache/polygene/api/entity/EntityBuilder.java @@ -27,6 +27,8 @@ import org.apache.polygene.api.common.ConstructionException; * to provide additional settings before instantiating the Composite. * * After calling newInstance() the builder becomes invalid, and may not be called again. + * + * @param <T> Entity type */ public interface EntityBuilder<T> { @@ -43,6 +45,7 @@ public interface EntityBuilder<T> * Get a representation of the state of the given type for the new Composite. * This is primarily used if you want to provide state for a private mixin type. * + * @param <K> Mixin type * @param mixinType the mixin which you want to provide state for * * @return a proxy implementing the given mixin type http://git-wip-us.apache.org/repos/asf/zest-java/blob/1fc02df3/core/api/src/main/java/org/apache/polygene/api/metrics/MetricsTimer.java ---------------------------------------------------------------------- diff --git a/core/api/src/main/java/org/apache/polygene/api/metrics/MetricsTimer.java b/core/api/src/main/java/org/apache/polygene/api/metrics/MetricsTimer.java index c1eb9e1..1a2cc2c 100644 --- a/core/api/src/main/java/org/apache/polygene/api/metrics/MetricsTimer.java +++ b/core/api/src/main/java/org/apache/polygene/api/metrics/MetricsTimer.java @@ -27,6 +27,8 @@ public interface MetricsTimer extends Metric { /** * Start the Timer Metrics. + * + * @return the timer context */ Context start(); http://git-wip-us.apache.org/repos/asf/zest-java/blob/1fc02df3/core/api/src/main/java/org/apache/polygene/api/object/ObjectFactory.java ---------------------------------------------------------------------- diff --git a/core/api/src/main/java/org/apache/polygene/api/object/ObjectFactory.java b/core/api/src/main/java/org/apache/polygene/api/object/ObjectFactory.java index bd9a723..fddeeb1 100644 --- a/core/api/src/main/java/org/apache/polygene/api/object/ObjectFactory.java +++ b/core/api/src/main/java/org/apache/polygene/api/object/ObjectFactory.java @@ -29,7 +29,9 @@ public interface ObjectFactory /** * Create new objects of the given type. * - * @param type an object class which will be instantiated. + * @param <T> Object type + * @param type an object class which will be instantiated + * @param uses objects that can be injected into mixins * * @return new objects. * http://git-wip-us.apache.org/repos/asf/zest-java/blob/1fc02df3/core/api/src/main/java/org/apache/polygene/api/property/StateHolder.java ---------------------------------------------------------------------- diff --git a/core/api/src/main/java/org/apache/polygene/api/property/StateHolder.java b/core/api/src/main/java/org/apache/polygene/api/property/StateHolder.java index 28c3620..bd80f13 100644 --- a/core/api/src/main/java/org/apache/polygene/api/property/StateHolder.java +++ b/core/api/src/main/java/org/apache/polygene/api/property/StateHolder.java @@ -31,6 +31,7 @@ public interface StateHolder /** * Get a property for a specific accessor * + * @param <T> Property type * @param accessor of the property * * @return the property http://git-wip-us.apache.org/repos/asf/zest-java/blob/1fc02df3/core/api/src/main/java/org/apache/polygene/api/query/Query.java ---------------------------------------------------------------------- diff --git a/core/api/src/main/java/org/apache/polygene/api/query/Query.java b/core/api/src/main/java/org/apache/polygene/api/query/Query.java index dda526d..8ab52f1 100644 --- a/core/api/src/main/java/org/apache/polygene/api/query/Query.java +++ b/core/api/src/main/java/org/apache/polygene/api/query/Query.java @@ -36,6 +36,8 @@ import org.apache.polygene.api.query.grammar.OrderBy; * DDD tip: typically Queries are created in the Domain Model and passed to the UI, * which sets the order and paging before executing it. * </p> + * + * @param <T> Entity type */ public interface Query<T> extends Iterable<T>, Serializable @@ -112,6 +114,7 @@ public interface Query<T> /** * Get the value of a named variable. * + * @param <V> Variable type * @param name of the variable * * @return value of the variable http://git-wip-us.apache.org/repos/asf/zest-java/blob/1fc02df3/core/api/src/main/java/org/apache/polygene/api/query/QueryBuilder.java ---------------------------------------------------------------------- diff --git a/core/api/src/main/java/org/apache/polygene/api/query/QueryBuilder.java b/core/api/src/main/java/org/apache/polygene/api/query/QueryBuilder.java index cd65e39..b130e13 100644 --- a/core/api/src/main/java/org/apache/polygene/api/query/QueryBuilder.java +++ b/core/api/src/main/java/org/apache/polygene/api/query/QueryBuilder.java @@ -32,6 +32,8 @@ import org.apache.polygene.api.composite.Composite; * should be constructed in the domain model and handed over to * the UI, which can then further constrain it before actual * execution. + * + * @param <T> Entity type */ public interface QueryBuilder<T> { http://git-wip-us.apache.org/repos/asf/zest-java/blob/1fc02df3/core/api/src/main/java/org/apache/polygene/api/query/QueryBuilderFactory.java ---------------------------------------------------------------------- diff --git a/core/api/src/main/java/org/apache/polygene/api/query/QueryBuilderFactory.java b/core/api/src/main/java/org/apache/polygene/api/query/QueryBuilderFactory.java index be2666d..19ee958 100644 --- a/core/api/src/main/java/org/apache/polygene/api/query/QueryBuilderFactory.java +++ b/core/api/src/main/java/org/apache/polygene/api/query/QueryBuilderFactory.java @@ -29,6 +29,7 @@ public interface QueryBuilderFactory /** * Create a new QueryBuilder. * + * @param <T> Result type * @param resultType the type of the result that you want * * @return a QueryBuilder http://git-wip-us.apache.org/repos/asf/zest-java/blob/1fc02df3/core/api/src/main/java/org/apache/polygene/api/query/QueryExpressions.java ---------------------------------------------------------------------- diff --git a/core/api/src/main/java/org/apache/polygene/api/query/QueryExpressions.java b/core/api/src/main/java/org/apache/polygene/api/query/QueryExpressions.java index ca83940..6b26751 100644 --- a/core/api/src/main/java/org/apache/polygene/api/query/QueryExpressions.java +++ b/core/api/src/main/java/org/apache/polygene/api/query/QueryExpressions.java @@ -332,6 +332,7 @@ public final class QueryExpressions /** * Create a new EQUALS specification for a Property. * + * @param <T> Property type * @param property a Property * @param value its value * @@ -345,6 +346,7 @@ public final class QueryExpressions /** * Create a new EQUALS specification for a Property using a named Variable. * + * @param <T> Property type * @param property a Property * @param variable a Query Variable * @@ -359,6 +361,7 @@ public final class QueryExpressions /** * Create a new EQUALS specification for an Association. * + * @param <T> Association type * @param association an Association * @param value its value * @@ -379,6 +382,7 @@ public final class QueryExpressions /** * Create a new GREATER OR EQUALS specification for a Property. * + * @param <T> Property type * @param property a Property * @param value its value * @@ -392,6 +396,7 @@ public final class QueryExpressions /** * Create a new GREATER OR EQUALS specification for a Property using a named Variable. * + * @param <T> Property type * @param property a Property * @param variable a Query Variable * @@ -406,6 +411,7 @@ public final class QueryExpressions /** * Create a new GREATER THAN specification for a Property. * + * @param <T> Property type * @param property a Property * @param value its value * @@ -419,6 +425,7 @@ public final class QueryExpressions /** * Create a new GREATER THAN specification for a Property using a named Variable. * + * @param <T> Property type * @param property a Property * @param variable a Query Variable * @@ -433,6 +440,7 @@ public final class QueryExpressions /** * Create a new LESS OR EQUALS specification for a Property. * + * @param <T> Property type * @param property a Property * @param value its value * @@ -446,6 +454,7 @@ public final class QueryExpressions /** * Create a new LESS OR EQUALS specification for a Property using a named Variable. * + * @param <T> Property type * @param property a Property * @param variable a Query Variable * @@ -460,6 +469,7 @@ public final class QueryExpressions /** * Create a new LESSER THAN specification for a Property. * + * @param <T> Property type * @param property a Property * @param value its value * @@ -473,6 +483,7 @@ public final class QueryExpressions /** * Create a new LESSER THAN specification for a Property using a named Variable. * + * @param <T> Property type * @param property a Property * @param variable a Query Variable * @@ -487,6 +498,7 @@ public final class QueryExpressions /** * Create a new NOT EQUALS specification for a Property. * + * @param <T> Property type * @param property a Property * @param value its value * @@ -500,6 +512,7 @@ public final class QueryExpressions /** * Create a new NOT EQUALS specification for a Property using a named Variable. * + * @param <T> Property type * @param property a Property * @param variable a Query Variable * @@ -542,6 +555,7 @@ public final class QueryExpressions /** * Create a new NOT NULL specification for a Property. * + * @param <T> Property type * @param property a Property * * @return a new NOT NULL specification for a Property. @@ -554,6 +568,7 @@ public final class QueryExpressions /** * Create a new NULL specification for a Property. * + * @param <T> Property type * @param property a Property * * @return a new NULL specification for a Property. @@ -566,6 +581,7 @@ public final class QueryExpressions /** * Create a new NOT NULL specification for an Association. * + * @param <T> Association type * @param association an Association * * @return a new NOT NULL specification for an Association. @@ -578,6 +594,7 @@ public final class QueryExpressions /** * Create a new NULL specification for an Association. * + * @param <T> Association type * @param association an Association * * @return a new NULL specification for an Association. @@ -592,6 +609,7 @@ public final class QueryExpressions /** * Create a new CONTAINS ALL specification for a Collection Property. * + * @param <T> Collection property type * @param collectionProperty a Collection Property * @param values its values * @@ -607,6 +625,7 @@ public final class QueryExpressions /** * Create a new CONTAINS ALL specification for a Collection Property using named Variables. * + * @param <T> Collection property type * @param collectionProperty a Collection Property * @param variables named Variables * @@ -624,6 +643,7 @@ public final class QueryExpressions /** * Create a new CONTAINS specification for a Collection Property. * + * @param <T> Collection property type * @param collectionProperty a Collection Property * @param value the value * @@ -639,6 +659,7 @@ public final class QueryExpressions /** * Create a new CONTAINS specification for a Collection Property using named Variables. * + * @param <T> Collection property type * @param collectionProperty a Collection Property * @param variable named Variable * @@ -655,6 +676,7 @@ public final class QueryExpressions /** * Create a new CONTAINS specification for a ManyAssociation. * + * @param <T> ManyAssociation type * @param manyAssoc a ManyAssociation * @param value the value * @@ -668,6 +690,7 @@ public final class QueryExpressions /** * Create a new CONTAINS specification for a NamedAssociation. * + * @param <T> NamedAssociation type * @param namedAssoc a NamedAssociation * @param value the value * @@ -681,6 +704,7 @@ public final class QueryExpressions /** * Create a new CONTAINS NAME specification for a NamedAssociation. * + * @param <T> NamedAssociation type * @param namedAssoc a NamedAssociation * @param name the name * http://git-wip-us.apache.org/repos/asf/zest-java/blob/1fc02df3/core/api/src/main/java/org/apache/polygene/api/service/ServiceActivation.java ---------------------------------------------------------------------- diff --git a/core/api/src/main/java/org/apache/polygene/api/service/ServiceActivation.java b/core/api/src/main/java/org/apache/polygene/api/service/ServiceActivation.java index 38c4020..33ac055 100644 --- a/core/api/src/main/java/org/apache/polygene/api/service/ServiceActivation.java +++ b/core/api/src/main/java/org/apache/polygene/api/service/ServiceActivation.java @@ -33,12 +33,16 @@ public interface ServiceActivation /** * Called after ServiceComposite Activation. + * + * @throws Exception if unable to activate */ void activateService() throws Exception; /** * Called before ServiceComposite Passivation. + * + * @throws Exception if unable to passivate */ void passivateService() throws Exception; http://git-wip-us.apache.org/repos/asf/zest-java/blob/1fc02df3/core/api/src/main/java/org/apache/polygene/api/service/ServiceFinder.java ---------------------------------------------------------------------- diff --git a/core/api/src/main/java/org/apache/polygene/api/service/ServiceFinder.java b/core/api/src/main/java/org/apache/polygene/api/service/ServiceFinder.java index 038d8a3..8e7e9d5 100644 --- a/core/api/src/main/java/org/apache/polygene/api/service/ServiceFinder.java +++ b/core/api/src/main/java/org/apache/polygene/api/service/ServiceFinder.java @@ -45,6 +45,7 @@ public interface ServiceFinder /** * Find a ServiceReference that implements the given type. * + * @param <T> Service type * @param serviceType the type that the Service must implement * * @return a ServiceReference if one is found @@ -57,6 +58,7 @@ public interface ServiceFinder /** * Find a ServiceReference that implements the given type. * + * @param <T> Service type * @param serviceType the type that the Service must implement * * @return a ServiceReference if one is found @@ -73,6 +75,7 @@ public interface ServiceFinder * Module is earlier in the list. * </p> * + * @param <T> Service type * @param serviceType the type that the Services must implement * * @return a stream of ServiceReferences for the given type. It is empty if none exist @@ -86,6 +89,7 @@ public interface ServiceFinder * Module is earlier in the list. * </p> * + * @param <T> Service type * @param serviceType the type that the Services must implement * * @return a stream of ServiceReferences for the given type. It is empty if none exist http://git-wip-us.apache.org/repos/asf/zest-java/blob/1fc02df3/core/api/src/main/java/org/apache/polygene/api/structure/MetaInfoHolder.java ---------------------------------------------------------------------- diff --git a/core/api/src/main/java/org/apache/polygene/api/structure/MetaInfoHolder.java b/core/api/src/main/java/org/apache/polygene/api/structure/MetaInfoHolder.java index eea762e..acfd747 100644 --- a/core/api/src/main/java/org/apache/polygene/api/structure/MetaInfoHolder.java +++ b/core/api/src/main/java/org/apache/polygene/api/structure/MetaInfoHolder.java @@ -30,6 +30,7 @@ public interface MetaInfoHolder * Get metadata that implements the given type. * The info is registered during assembly of the application. * + * @param <T> metadata type * @param infoType the type of metadata to be returned * * @return the metadata for the given type, or <code>null</code> if http://git-wip-us.apache.org/repos/asf/zest-java/blob/1fc02df3/core/api/src/main/java/org/apache/polygene/api/type/ValueType.java ---------------------------------------------------------------------- diff --git a/core/api/src/main/java/org/apache/polygene/api/type/ValueType.java b/core/api/src/main/java/org/apache/polygene/api/type/ValueType.java index 13277d7..768750e 100644 --- a/core/api/src/main/java/org/apache/polygene/api/type/ValueType.java +++ b/core/api/src/main/java/org/apache/polygene/api/type/ValueType.java @@ -49,6 +49,7 @@ public class ValueType * Date, BigInteger, BigDecimal and JodaTime types are not considered as Primitive Value Types. * </p> * + * @param object Object * @return true if object is a primitive value or an array of primitive values * @throws IllegalArgumentException if object is null */ @@ -102,7 +103,9 @@ public class ValueType } /** - * @see ValueType#isPrimitiveValue(java.lang.Object) + * @see ValueType#isPrimitiveValue(java.lang.Object) + * @param type Type + * @return true if object is a primitive value or an array of primitive values */ public static boolean isPrimitiveValueType( Class<?> type ) { http://git-wip-us.apache.org/repos/asf/zest-java/blob/1fc02df3/core/api/src/main/java/org/apache/polygene/api/unitofwork/UnitOfWork.java ---------------------------------------------------------------------- diff --git a/core/api/src/main/java/org/apache/polygene/api/unitofwork/UnitOfWork.java b/core/api/src/main/java/org/apache/polygene/api/unitofwork/UnitOfWork.java index 10e4216..974f8eb 100644 --- a/core/api/src/main/java/org/apache/polygene/api/unitofwork/UnitOfWork.java +++ b/core/api/src/main/java/org/apache/polygene/api/unitofwork/UnitOfWork.java @@ -134,6 +134,7 @@ public interface UnitOfWork extends MetaInfoHolder, AutoCloseable * The reference of the Entity will be generated by the IdentityGenerator of the Module of the EntityComposite. * </p> * + * @param <T> Entity type * @param type the mixin type that the EntityComposite must implement * * @return a new Entity @@ -151,6 +152,7 @@ public interface UnitOfWork extends MetaInfoHolder, AutoCloseable * for Modules and Layers will be considered. If several * EntityComposites implement the type then an AmbiguousTypeException will be thrown. * + * @param <T> Entity type * @param type the mixin type that the EntityComposite must implement * @param identity the reference of the new Entity * @@ -169,6 +171,7 @@ public interface UnitOfWork extends MetaInfoHolder, AutoCloseable * for Modules and Layers will be considered. If several * EntityComposites implement the type then an AmbiguousTypeException will be thrown. * + * @param <T> Entity type * @param type the mixin type that the EntityComposite must implement * * @return a new EntityBuilder @@ -185,6 +188,7 @@ public interface UnitOfWork extends MetaInfoHolder, AutoCloseable * for Modules and Layers will be considered. If several * mixins implement the type then an AmbiguousTypeException will be thrown. * + * @param <T> Entity type * @param type the mixin type that the EntityComposite must implement * @param identity the reference of the new Entity * @@ -255,6 +259,7 @@ public interface UnitOfWork extends MetaInfoHolder, AutoCloseable * Find an Entity of the given mixin type with the give reference. This * method verifies that it exists by asking the underlying EntityStore. * + * @param <T> Entity type * @param type of the entity * @param identity of the entity * @@ -271,6 +276,7 @@ public interface UnitOfWork extends MetaInfoHolder, AutoCloseable * UnitOfWork and want to create a reference to it in this * UnitOfWork, then call this method. * + * @param <T> Entity type * @param entity the Entity to be dereferenced * * @return an Entity from this UnitOfWork http://git-wip-us.apache.org/repos/asf/zest-java/blob/1fc02df3/core/api/src/main/java/org/apache/polygene/api/unitofwork/UnitOfWorkCallback.java ---------------------------------------------------------------------- diff --git a/core/api/src/main/java/org/apache/polygene/api/unitofwork/UnitOfWorkCallback.java b/core/api/src/main/java/org/apache/polygene/api/unitofwork/UnitOfWorkCallback.java index f8e467b..b52ddce 100644 --- a/core/api/src/main/java/org/apache/polygene/api/unitofwork/UnitOfWorkCallback.java +++ b/core/api/src/main/java/org/apache/polygene/api/unitofwork/UnitOfWorkCallback.java @@ -30,11 +30,10 @@ public interface UnitOfWorkCallback { /** * This is called before the completion of the UnitOfWork. - * The callback may do any validation checks and throw - * UnitOfWorkCompletionException if there is any reason - * why the UnitOfWork is not in a valid state to be completed. + * The callback may do any validation checks. * - * @throws UnitOfWorkCompletionException + * @throws UnitOfWorkCompletionException if there is any reason why the UnitOfWork is not in a valid state to be + * completed */ void beforeCompletion() throws UnitOfWorkCompletionException; @@ -46,7 +45,7 @@ public interface UnitOfWorkCallback * UnitOfWork is no longer active when this method is * called, so no methods on it may be invoked. * - * @param status + * @param status the UnitOfWork status */ void afterCompletion( UnitOfWorkStatus status ); http://git-wip-us.apache.org/repos/asf/zest-java/blob/1fc02df3/core/api/src/main/java/org/apache/polygene/api/unitofwork/UnitOfWorkFactory.java ---------------------------------------------------------------------- diff --git a/core/api/src/main/java/org/apache/polygene/api/unitofwork/UnitOfWorkFactory.java b/core/api/src/main/java/org/apache/polygene/api/unitofwork/UnitOfWorkFactory.java index 98d23ba..c59e154 100644 --- a/core/api/src/main/java/org/apache/polygene/api/unitofwork/UnitOfWorkFactory.java +++ b/core/api/src/main/java/org/apache/polygene/api/unitofwork/UnitOfWorkFactory.java @@ -46,6 +46,9 @@ public interface UnitOfWorkFactory * <p> * The UnitOfWork will use the default Usecase settings. * </p> + * + * @param currentTime the current time for this UnitOfWork + * * @return a new UnitOfWork */ UnitOfWork newUnitOfWork( Instant currentTime ); @@ -65,6 +68,8 @@ public interface UnitOfWorkFactory * Create a new UnitOfWork for the given Usecase and associate it with the current thread. * * @param usecase the Usecase for this UnitOfWork + * @param currentTime the current time for this UnitOfWork + * * * @return a new UnitOfWork */ http://git-wip-us.apache.org/repos/asf/zest-java/blob/1fc02df3/core/api/src/main/java/org/apache/polygene/api/value/ValueBuilder.java ---------------------------------------------------------------------- diff --git a/core/api/src/main/java/org/apache/polygene/api/value/ValueBuilder.java b/core/api/src/main/java/org/apache/polygene/api/value/ValueBuilder.java index fe7a8e1..2698305 100644 --- a/core/api/src/main/java/org/apache/polygene/api/value/ValueBuilder.java +++ b/core/api/src/main/java/org/apache/polygene/api/value/ValueBuilder.java @@ -25,6 +25,8 @@ import org.apache.polygene.api.common.ConstructionException; /** * Builder for Values. + * + * @param <T> Value type */ public interface ValueBuilder<T> { @@ -43,6 +45,7 @@ public interface ValueBuilder<T> * Get a representation of the state of the given type for the new ValueComposite. * This is primarily used if you want to provide state for a private mixin type. * + * @param <K> Mixin type * @param mixinType the mixin which you want to provide state for * * @return a proxy implementing the given mixin type http://git-wip-us.apache.org/repos/asf/zest-java/blob/1fc02df3/core/api/src/main/java/org/apache/polygene/api/value/ValueBuilderFactory.java ---------------------------------------------------------------------- diff --git a/core/api/src/main/java/org/apache/polygene/api/value/ValueBuilderFactory.java b/core/api/src/main/java/org/apache/polygene/api/value/ValueBuilderFactory.java index b23889c..510c373 100644 --- a/core/api/src/main/java/org/apache/polygene/api/value/ValueBuilderFactory.java +++ b/core/api/src/main/java/org/apache/polygene/api/value/ValueBuilderFactory.java @@ -36,6 +36,7 @@ public interface ValueBuilderFactory /** * Instantiate a Value of the given type. * + * @param <T> Value type * @param valueType the Value type to instantiate * * @return a new Value instance @@ -50,6 +51,7 @@ public interface ValueBuilderFactory * Create a builder for creating new Values that implements the given Value type. * <p>The returned ValueBuilder can be reused to create several Values instances.</p> * + * @param <T> Value type * @param valueType an interface that describes the Composite to be instantiated * * @return a ValueBuilder for creation of ValueComposites implementing the interface @@ -63,6 +65,7 @@ public interface ValueBuilderFactory * Create a builder for creating a new Value starting with the given prototype. * <p>The returned ValueBuilder can only be used ONCE.</p> * + * @param <T> Value type * @param prototype a prototype the builder will use * * @return a ValueBuilder for creation of ValueComposites implementing the interface of the prototype @@ -75,6 +78,7 @@ public interface ValueBuilderFactory * Create a builder for creating a new Value starting with the given state. * <p>The returned ValueBuilder can only be used ONCE.</p> * + * @param <T> Value type * @param mixinType an interface that describes the Composite to be instantiated * @param propertyFunction a function providing the state of properties * @param associationFunction a function providing the state of associations @@ -94,6 +98,7 @@ public interface ValueBuilderFactory /** * Instantiate a Value of the given type using the serialized state given as String. * + * @param <T> Value type * @param valueType the Value type to instantiate * @param serializedState the state of the Value * http://git-wip-us.apache.org/repos/asf/zest-java/blob/1fc02df3/core/api/src/main/java/org/apache/polygene/api/value/ValueDeserializer.java ---------------------------------------------------------------------- diff --git a/core/api/src/main/java/org/apache/polygene/api/value/ValueDeserializer.java b/core/api/src/main/java/org/apache/polygene/api/value/ValueDeserializer.java index 5f2628c..88afc3a 100644 --- a/core/api/src/main/java/org/apache/polygene/api/value/ValueDeserializer.java +++ b/core/api/src/main/java/org/apache/polygene/api/value/ValueDeserializer.java @@ -79,8 +79,9 @@ public interface ValueDeserializer * * <p>The returned Function may throw {@link ValueSerializationException}.</p> * - * @param type the value type * @param <T> the parametrized function return type + * @param module the module + * @param type the value type * * @return a deserialization function */ @@ -91,8 +92,9 @@ public interface ValueDeserializer * * <p>The returned Function may throw {@link ValueSerializationException}.</p> * + * @param <T> the parametrized function return type + * @param module the module * @param valueType the value type - * @param <T> the parametrized function return type * * @return a deserialization function */ @@ -112,6 +114,7 @@ public interface ValueDeserializer * Deserialize a value from a state. * * @param <T> the parametrized returned type + * @param module the module * @param type the value type * @param input the state * @@ -126,6 +129,7 @@ public interface ValueDeserializer * Deserialize a value from a state. * * @param <T> the parametrized returned type + * @param module the module * @param valueType the value type * @param input the state * @@ -140,6 +144,7 @@ public interface ValueDeserializer * Deserialize a value from a state. * * @param <T> the parametrized returned type + * @param module the module * @param type the value type * @param input the state stream * @@ -154,6 +159,7 @@ public interface ValueDeserializer * Deserialize a value from a state. * * @param <T> the parametrized returned type + * @param module the module * @param valueType the value type * @param input the state stream *
