minor: fix some javac & javadoc warnings in core
Project: http://git-wip-us.apache.org/repos/asf/zest-java/repo Commit: http://git-wip-us.apache.org/repos/asf/zest-java/commit/a1b2b242 Tree: http://git-wip-us.apache.org/repos/asf/zest-java/tree/a1b2b242 Diff: http://git-wip-us.apache.org/repos/asf/zest-java/diff/a1b2b242 Branch: refs/heads/develop Commit: a1b2b2429ef75910111bef1bf3ea572b2ec90183 Parents: 5679399 Author: Paul Merlin <[email protected]> Authored: Sat Nov 19 11:42:58 2016 +0100 Committer: Paul Merlin <[email protected]> Committed: Sat Nov 19 11:42:58 2016 +0100 ---------------------------------------------------------------------- .../apache/zest/bootstrap/MixinDeclaration.java | 2 +- .../apache/zest/bootstrap/ModuleAssembly.java | 2 ++ .../layered/LayeredApplicationAssembler.java | 8 ++--- .../bootstrap/CompositeAssemblyImpl.java | 7 +++-- .../runtime/unitofwork/ModuleUnitOfWork.java | 7 ++--- .../org/apache/zest/spi/cache/CachePool.java | 4 +-- .../spi/entitystore/EntityStoreUnitOfWork.java | 2 +- .../spi/entitystore/helpers/MapEntityStore.java | 3 ++ .../org/apache/zest/spi/query/EntityFinder.java | 3 ++ .../spi/value/ValueDeserializerAdapter.java | 32 ++++++++++++-------- .../apache/zest/test/AbstractZestBaseTest.java | 2 ++ .../org/apache/zest/test/util/JSONAssert.java | 8 +++++ 12 files changed, 53 insertions(+), 27 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/zest-java/blob/a1b2b242/core/bootstrap/src/main/java/org/apache/zest/bootstrap/MixinDeclaration.java ---------------------------------------------------------------------- diff --git a/core/bootstrap/src/main/java/org/apache/zest/bootstrap/MixinDeclaration.java b/core/bootstrap/src/main/java/org/apache/zest/bootstrap/MixinDeclaration.java index 8d5f98a..57328f4 100644 --- a/core/bootstrap/src/main/java/org/apache/zest/bootstrap/MixinDeclaration.java +++ b/core/bootstrap/src/main/java/org/apache/zest/bootstrap/MixinDeclaration.java @@ -23,7 +23,7 @@ package org.apache.zest.bootstrap; /** * Fluent API for declaring information about properties * - * @param <T> + * @param <T> Parameterized mixin type */ public interface MixinDeclaration<T> { http://git-wip-us.apache.org/repos/asf/zest-java/blob/a1b2b242/core/bootstrap/src/main/java/org/apache/zest/bootstrap/ModuleAssembly.java ---------------------------------------------------------------------- diff --git a/core/bootstrap/src/main/java/org/apache/zest/bootstrap/ModuleAssembly.java b/core/bootstrap/src/main/java/org/apache/zest/bootstrap/ModuleAssembly.java index 9cfa8d4..8965815 100644 --- a/core/bootstrap/src/main/java/org/apache/zest/bootstrap/ModuleAssembly.java +++ b/core/bootstrap/src/main/java/org/apache/zest/bootstrap/ModuleAssembly.java @@ -169,6 +169,8 @@ public interface ModuleAssembly * @param objectTypes The types that specifies the Object types. * * @return An ObjectDeclaration for the specified Object types. + * + * @throws AssemblyException on invalid assembly */ ObjectDeclaration objects( Class<?>... objectTypes ) throws AssemblyException; http://git-wip-us.apache.org/repos/asf/zest-java/blob/a1b2b242/core/bootstrap/src/main/java/org/apache/zest/bootstrap/layered/LayeredApplicationAssembler.java ---------------------------------------------------------------------- diff --git a/core/bootstrap/src/main/java/org/apache/zest/bootstrap/layered/LayeredApplicationAssembler.java b/core/bootstrap/src/main/java/org/apache/zest/bootstrap/layered/LayeredApplicationAssembler.java index 5aa7fe5..e71c2fb 100644 --- a/core/bootstrap/src/main/java/org/apache/zest/bootstrap/layered/LayeredApplicationAssembler.java +++ b/core/bootstrap/src/main/java/org/apache/zest/bootstrap/layered/LayeredApplicationAssembler.java @@ -282,15 +282,15 @@ public abstract class LayeredApplicationAssembler } /** - * Called from the <code>assemble</code> method to assemble the layers in the applcation. + * Called from the <code>assemble</code> method to assemble the layers in the application. * * <p> - * This method must be implemented, and is typically a list of LayerAssembler instantitations, followed + * This method must be implemented, and is typically a list of LayerAssembler instantiations, followed * by {@link LayerAssembly#uses(LayerAssembly...)} declarations. * </p> - * <pre><code> * - * </code></pre> + * @param assembly Application assembly + * @throws AssemblyException on invalid assembly */ protected abstract void assembleLayers( ApplicationAssembly assembly ) throws AssemblyException; http://git-wip-us.apache.org/repos/asf/zest-java/blob/a1b2b242/core/runtime/src/main/java/org/apache/zest/runtime/bootstrap/CompositeAssemblyImpl.java ---------------------------------------------------------------------- diff --git a/core/runtime/src/main/java/org/apache/zest/runtime/bootstrap/CompositeAssemblyImpl.java b/core/runtime/src/main/java/org/apache/zest/runtime/bootstrap/CompositeAssemblyImpl.java index 1d1f096..b3788bd 100644 --- a/core/runtime/src/main/java/org/apache/zest/runtime/bootstrap/CompositeAssemblyImpl.java +++ b/core/runtime/src/main/java/org/apache/zest/runtime/bootstrap/CompositeAssemblyImpl.java @@ -574,9 +574,10 @@ public abstract class CompositeAssemblyImpl Class<? extends Annotation> annotationType = constraintAnnotation.annotationType(); for( Class<?> constraint : constraintClasses ) { - if( helper.appliesTo( (Class<? extends Constraint<?, ?>>) constraint, annotationType, valueType ) ) + Class<? extends Constraint<?, ?>> constraintType = (Class<? extends Constraint<?, ?>>) constraint; + if( helper.appliesTo( constraintType, annotationType, valueType ) ) { - constraintModels.add( new ConstraintModel( constraintAnnotation, (Class<? extends Constraint<?, ?>>) constraint ) ); + constraintModels.add( new ConstraintModel( constraintAnnotation, constraintType ) ); continue nextConstraint; } } @@ -816,7 +817,7 @@ public abstract class CompositeAssemblyImpl protected Stream<Class<?>> mixinDeclarations( Class<?> type ) { //Stream<? extends Type> types = typesOf( type ); - return mixinDeclarations( Arrays.asList( type ).stream() ); + return mixinDeclarations( Stream.of( type ) ); } private Stream<Class<?>> mixinDeclarations( Stream<? extends Class> types ) http://git-wip-us.apache.org/repos/asf/zest-java/blob/a1b2b242/core/runtime/src/main/java/org/apache/zest/runtime/unitofwork/ModuleUnitOfWork.java ---------------------------------------------------------------------- diff --git a/core/runtime/src/main/java/org/apache/zest/runtime/unitofwork/ModuleUnitOfWork.java b/core/runtime/src/main/java/org/apache/zest/runtime/unitofwork/ModuleUnitOfWork.java index 153d546..beadcf0 100644 --- a/core/runtime/src/main/java/org/apache/zest/runtime/unitofwork/ModuleUnitOfWork.java +++ b/core/runtime/src/main/java/org/apache/zest/runtime/unitofwork/ModuleUnitOfWork.java @@ -542,8 +542,7 @@ public class ModuleUnitOfWork try { - final EntityReference foundEntity = entityFinder.findEntity( resultType, whereClause, variables == null ? Collections - .<String, Object>emptyMap() : variables ); + EntityReference foundEntity = entityFinder.findEntity( resultType, whereClause, variables == null ? Collections.emptyMap() : variables ); if( foundEntity != null ) { try @@ -577,7 +576,7 @@ public class ModuleUnitOfWork try { - return entityFinder.countEntities( resultType, whereClause, variables == null ? Collections.<String, Object>emptyMap() : variables ); + return entityFinder.countEntities( resultType, whereClause, variables == null ? Collections.emptyMap() : variables ); } catch( EntityFinderException e ) { @@ -606,7 +605,7 @@ public class ModuleUnitOfWork Iterables.toArray( OrderBy.class, orderBySegments ), firstResult, maxResults, - variables == null ? Collections.<String, Object>emptyMap() : variables + variables == null ? Collections.emptyMap() : variables ).iterator(); return new Iterator<T>() http://git-wip-us.apache.org/repos/asf/zest-java/blob/a1b2b242/core/spi/src/main/java/org/apache/zest/spi/cache/CachePool.java ---------------------------------------------------------------------- diff --git a/core/spi/src/main/java/org/apache/zest/spi/cache/CachePool.java b/core/spi/src/main/java/org/apache/zest/spi/cache/CachePool.java index c4bf38d..527aec9 100644 --- a/core/spi/src/main/java/org/apache/zest/spi/cache/CachePool.java +++ b/core/spi/src/main/java/org/apache/zest/spi/cache/CachePool.java @@ -45,8 +45,8 @@ public interface CachePool * * @param cacheId The reference of the cache. If the same id is given as a previous fetch, the same cache will be * returned. - * @param valueType - * @param <T> + * @param valueType Value type + * @param <T> Value type * * @return The cache fetched from the pool. */ http://git-wip-us.apache.org/repos/asf/zest-java/blob/a1b2b242/core/spi/src/main/java/org/apache/zest/spi/entitystore/EntityStoreUnitOfWork.java ---------------------------------------------------------------------- diff --git a/core/spi/src/main/java/org/apache/zest/spi/entitystore/EntityStoreUnitOfWork.java b/core/spi/src/main/java/org/apache/zest/spi/entitystore/EntityStoreUnitOfWork.java index b938937..ade4303 100644 --- a/core/spi/src/main/java/org/apache/zest/spi/entitystore/EntityStoreUnitOfWork.java +++ b/core/spi/src/main/java/org/apache/zest/spi/entitystore/EntityStoreUnitOfWork.java @@ -58,7 +58,7 @@ public interface EntityStoreUnitOfWork * if the entity with given {@code anIdentity} is not found. * * - * @param module + * @param module Module descriptor * @param anIdentity The entity reference. This argument must not be {@code null}. * * @return Entity state given the composite descriptor and reference. http://git-wip-us.apache.org/repos/asf/zest-java/blob/a1b2b242/core/spi/src/main/java/org/apache/zest/spi/entitystore/helpers/MapEntityStore.java ---------------------------------------------------------------------- diff --git a/core/spi/src/main/java/org/apache/zest/spi/entitystore/helpers/MapEntityStore.java b/core/spi/src/main/java/org/apache/zest/spi/entitystore/helpers/MapEntityStore.java index 28a661a..2ec20a0 100644 --- a/core/spi/src/main/java/org/apache/zest/spi/entitystore/helpers/MapEntityStore.java +++ b/core/spi/src/main/java/org/apache/zest/spi/entitystore/helpers/MapEntityStore.java @@ -57,6 +57,9 @@ public interface MapEntityStore /** * Visitable MapChanges. + * + * @param changer Map changer + * @throws IOException on error */ void visitMap( MapChanger changer ) throws IOException; http://git-wip-us.apache.org/repos/asf/zest-java/blob/a1b2b242/core/spi/src/main/java/org/apache/zest/spi/query/EntityFinder.java ---------------------------------------------------------------------- diff --git a/core/spi/src/main/java/org/apache/zest/spi/query/EntityFinder.java b/core/spi/src/main/java/org/apache/zest/spi/query/EntityFinder.java index 0508107..c0be61b 100644 --- a/core/spi/src/main/java/org/apache/zest/spi/query/EntityFinder.java +++ b/core/spi/src/main/java/org/apache/zest/spi/query/EntityFinder.java @@ -41,6 +41,7 @@ public interface EntityFinder * @param maxResults Maximum returned entities. * @param variables Query variables * @return Single entity matching the query criterion. + * @throws EntityFinderException on error */ Iterable<EntityReference> findEntities( Class<?> resultType, @Optional Predicate<Composite> whereClause, @@ -58,6 +59,7 @@ public interface EntityFinder * @param whereClause Where clause specification. * @param variables Query variables * @return Single entity matching the query criterion. + * @throws EntityFinderException on error */ EntityReference findEntity( Class<?> resultType, @Optional Predicate<Composite> whereClause, @@ -72,6 +74,7 @@ public interface EntityFinder * @param whereClause Where clause specification. * @param variables Query variables * @return Count entities matching the query criterion. + * @throws EntityFinderException on error */ long countEntities( Class<?> resultType, @Optional Predicate<Composite> whereClause, http://git-wip-us.apache.org/repos/asf/zest-java/blob/a1b2b242/core/spi/src/main/java/org/apache/zest/spi/value/ValueDeserializerAdapter.java ---------------------------------------------------------------------- diff --git a/core/spi/src/main/java/org/apache/zest/spi/value/ValueDeserializerAdapter.java b/core/spi/src/main/java/org/apache/zest/spi/value/ValueDeserializerAdapter.java index e104739..94ffd0f 100644 --- a/core/spi/src/main/java/org/apache/zest/spi/value/ValueDeserializerAdapter.java +++ b/core/spi/src/main/java/org/apache/zest/spi/value/ValueDeserializerAdapter.java @@ -403,7 +403,7 @@ public abstract class ValueDeserializerAdapter<InputType, InputNodeType> } return readArrayInCollection( module, input, - this.<T>buildDeserializeInputFunction( module, collectionType.collectedType() ), + this.buildDeserializeInputFunction( module, collectionType.collectedType() ), collection ); } @@ -719,7 +719,7 @@ public abstract class ValueDeserializerAdapter<InputType, InputNodeType> } putArrayNodeInCollection( module, inputNode, - this.<T>buildDeserializeInputNodeFunction( module, collectionType.collectedType() ), + this.buildDeserializeInputNodeFunction( module, collectionType.collectedType() ), collection ); return collection; } @@ -730,8 +730,8 @@ public abstract class ValueDeserializerAdapter<InputType, InputNodeType> Map<K, V> map = new HashMap<>(); putArrayNodeInMap( module, inputNode, - this.<K>buildDeserializeInputNodeFunction( module, mapType.keyType() ), - this.<V>buildDeserializeInputNodeFunction( module, mapType.valueType() ), + this.buildDeserializeInputNodeFunction( module, mapType.keyType() ), + this.buildDeserializeInputNodeFunction( module, mapType.valueType() ), map ); return map; } @@ -742,7 +742,7 @@ public abstract class ValueDeserializerAdapter<InputType, InputNodeType> Map<String, V> map = new HashMap<>(); putObjectNodeInMap( module, inputNode, - this.<V>buildDeserializeInputNodeFunction( module, mapType.valueType() ), + this.buildDeserializeInputNodeFunction( module, mapType.valueType() ), map ); return map; } @@ -822,6 +822,7 @@ public abstract class ValueDeserializerAdapter<InputType, InputNodeType> /** * Called by the adapter on deserialization start, after {@link #adaptInput(ModuleDescriptor, java.io.InputStream)}. * + * @param module Module descriptor * @param valueType ValueType * @param input Input * @@ -837,6 +838,7 @@ public abstract class ValueDeserializerAdapter<InputType, InputNodeType> /** * Called by the adapter on deserialization end. * + * @param module Module descriptor * @param valueType ValueType * @param input Input * @@ -855,7 +857,8 @@ public abstract class ValueDeserializerAdapter<InputType, InputNodeType> /** * This method is always called first, this is a chance to wrap the input type. * - * @param input InputStream to adapt + * @param module Module descriptor + * @param input InputStream to adapt * * @return Adapted input * @@ -865,7 +868,8 @@ public abstract class ValueDeserializerAdapter<InputType, InputNodeType> throws Exception; /** - * @param input Input + * @param module Module descriptor + * @param input Input * * @return a Plain Value read from the input * @@ -875,10 +879,11 @@ public abstract class ValueDeserializerAdapter<InputType, InputNodeType> throws Exception; /** - * @param <T> Parameterized collection type + * @param module Module descriptor * @param input Input * @param deserializer Deserialization function * @param collection Collection + * @param <T> Parameterized collection type * * @return The filled collection or null if no array * @@ -908,12 +913,13 @@ public abstract class ValueDeserializerAdapter<InputType, InputNodeType> * non-predictible order of key/value inside an entry object. * </p> * - * @param <K> Parameterized map key type - * @param <V> Parameterized map value type + * @param module Module descriptor * @param input Input * @param keyDeserializer Map key deserialization function * @param valueDeserializer Map value deserialization function * @param map Map + * @param <K> Parameterized map key type + * @param <V> Parameterized map value type * * @return The filled map or null if no array * @@ -928,7 +934,8 @@ public abstract class ValueDeserializerAdapter<InputType, InputNodeType> throws Exception; /** - * @param input Input + * @param module Module descriptor + * @param input Input * * @return an InputNodeType or null if the value was null * @@ -952,10 +959,11 @@ public abstract class ValueDeserializerAdapter<InputType, InputNodeType> /** * Return null if the field do not exists. * - * @param <T> Parameterized object field value type + * @param module Module descriptor * @param inputNode Input Node * @param key Object key * @param valueDeserializer Deserialization function + * @param <T> Parameterized object field value type * * @return The value of the field. * http://git-wip-us.apache.org/repos/asf/zest-java/blob/a1b2b242/core/testsupport/src/main/java/org/apache/zest/test/AbstractZestBaseTest.java ---------------------------------------------------------------------- diff --git a/core/testsupport/src/main/java/org/apache/zest/test/AbstractZestBaseTest.java b/core/testsupport/src/main/java/org/apache/zest/test/AbstractZestBaseTest.java index f785247..0e39c4d 100644 --- a/core/testsupport/src/main/java/org/apache/zest/test/AbstractZestBaseTest.java +++ b/core/testsupport/src/main/java/org/apache/zest/test/AbstractZestBaseTest.java @@ -65,6 +65,8 @@ public abstract class AbstractZestBaseTest * the contents of each module. * * @param applicationAssembly the {@link org.apache.zest.bootstrap.ApplicationAssembly} to be populated. + * + * @throws AssemblyException on invalid assembly */ protected abstract void defineApplication( ApplicationAssembly applicationAssembly ) throws AssemblyException; http://git-wip-us.apache.org/repos/asf/zest-java/blob/a1b2b242/core/testsupport/src/main/java/org/apache/zest/test/util/JSONAssert.java ---------------------------------------------------------------------- diff --git a/core/testsupport/src/main/java/org/apache/zest/test/util/JSONAssert.java b/core/testsupport/src/main/java/org/apache/zest/test/util/JSONAssert.java index 10c006d..8baff9d 100644 --- a/core/testsupport/src/main/java/org/apache/zest/test/util/JSONAssert.java +++ b/core/testsupport/src/main/java/org/apache/zest/test/util/JSONAssert.java @@ -34,6 +34,10 @@ public class JSONAssert /** * Assert that two JSONObjects are equals without enforcing field order. + * + * @param o1 First JSON object + * @param o2 Second JSON object + * @throws JSONException on json parsing error */ public static void jsonObjectsEquals( JSONObject o1, JSONObject o2 ) throws JSONException @@ -61,6 +65,10 @@ public class JSONAssert /** * Assert that two JSONArrays are equals. + * + * @param a1 First JSON array + * @param a2 Second JSON array + * @throws JSONException on json parsing error */ public static void jsonArraysEquals( JSONArray a1, JSONArray a2 ) throws JSONException
