polygene-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From nic...@apache.org
Subject [30/50] [abbrv] zest-qi4j git commit: Javadocs
Date Fri, 17 Apr 2015 16:05:50 GMT
Javadocs


Project: http://git-wip-us.apache.org/repos/asf/zest-qi4j/repo
Commit: http://git-wip-us.apache.org/repos/asf/zest-qi4j/commit/d6dc0c9d
Tree: http://git-wip-us.apache.org/repos/asf/zest-qi4j/tree/d6dc0c9d
Diff: http://git-wip-us.apache.org/repos/asf/zest-qi4j/diff/d6dc0c9d

Branch: refs/heads/master
Commit: d6dc0c9dfdbb69ef023b75323c70ed32af32fac6
Parents: 1a447eb
Author: Paul Merlin <paul@nosphere.org>
Authored: Fri Feb 15 16:01:52 2013 +0100
Committer: Paul Merlin <paul@nosphere.org>
Committed: Fri Feb 15 16:01:52 2013 +0100

----------------------------------------------------------------------
 .../api/activation/ActivationException.java     | 21 +++++++++
 .../api/association/GenericAssociationInfo.java |  5 ++-
 .../api/composite/ConstructorDescriptor.java    |  2 +-
 .../org/qi4j/api/composite/PropertyMapper.java  |  2 +-
 .../org/qi4j/api/entity/EntityReference.java    | 47 ++++++++++++++++----
 .../org/qi4j/api/mixin/MixinDescriptor.java     |  2 +-
 .../property/InvalidPropertyTypeException.java  |  3 ++
 .../java/org/qi4j/api/property/Numbers.java     |  8 ++--
 .../org/qi4j/api/service/ServiceReference.java  | 12 +++++
 .../api/sideeffect/SideEffectDescriptor.java    |  2 +-
 .../api/structure/ApplicationDescriptor.java    | 10 ++++-
 .../main/java/org/qi4j/api/structure/Layer.java |  3 ++
 .../org/qi4j/api/structure/LayerDescriptor.java |  8 +++-
 .../java/org/qi4j/api/structure/Module.java     | 24 +++++++++-
 .../java/org/qi4j/api/type/CollectionType.java  |  3 +-
 .../main/java/org/qi4j/api/type/EnumType.java   |  2 +-
 .../main/java/org/qi4j/api/type/MapType.java    |  3 +-
 .../org/qi4j/api/type/ValueCompositeType.java   |  2 +-
 .../main/java/org/qi4j/api/type/ValueType.java  |  5 ++-
 .../api/unitofwork/UnitOfWorkException.java     |  9 ++--
 .../main/java/org/qi4j/api/util/Classes.java    |  3 ++
 .../src/main/java/org/qi4j/api/util/Dates.java  |  8 ++++
 .../composite/AbstractModifierModel.java        |  8 ++--
 .../runtime/composite/ConstructorModel.java     |  6 +--
 .../org/qi4j/runtime/composite/MixinModel.java  | 10 ++---
 .../qi4j/runtime/composite/SideEffectModel.java |  2 +-
 26 files changed, 167 insertions(+), 43 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/d6dc0c9d/core/api/src/main/java/org/qi4j/api/activation/ActivationException.java
----------------------------------------------------------------------
diff --git a/core/api/src/main/java/org/qi4j/api/activation/ActivationException.java b/core/api/src/main/java/org/qi4j/api/activation/ActivationException.java
index 4e8e729..30d06be 100644
--- a/core/api/src/main/java/org/qi4j/api/activation/ActivationException.java
+++ b/core/api/src/main/java/org/qi4j/api/activation/ActivationException.java
@@ -1,7 +1,28 @@
+/*
+ * Copyright 2013 Niclas Hedhman.
+ *
+ * Licensed  under the  Apache License,  Version 2.0  (the "License");
+ * you may not use  this file  except in  compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed  under the  License is distributed on an "AS IS" BASIS,
+ * WITHOUT  WARRANTIES OR CONDITIONS  OF ANY KIND, either  express  or
+ * implied.
+ *
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
 package org.qi4j.api.activation;
 
+/**
+ * Thrown when unable to activate.
+ */
 public class ActivationException extends Exception
 {
+    private static final long serialVersionUID = 1L;
     public ActivationException( String message, Throwable cause )
     {
         super( message, cause );

http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/d6dc0c9d/core/api/src/main/java/org/qi4j/api/association/GenericAssociationInfo.java
----------------------------------------------------------------------
diff --git a/core/api/src/main/java/org/qi4j/api/association/GenericAssociationInfo.java b/core/api/src/main/java/org/qi4j/api/association/GenericAssociationInfo.java
index 974c8b7..7173547 100644
--- a/core/api/src/main/java/org/qi4j/api/association/GenericAssociationInfo.java
+++ b/core/api/src/main/java/org/qi4j/api/association/GenericAssociationInfo.java
@@ -13,7 +13,7 @@
  * implied.
  *
  * See the License for the specific language governing permissions and
- * limitations under the License. 
+ * limitations under the License.
  */
 package org.qi4j.api.association;
 
@@ -23,6 +23,9 @@ import java.lang.reflect.Type;
 
 import static org.qi4j.api.util.Classes.typeOf;
 
+/**
+ * Generic Association info.
+ */
 public final class GenericAssociationInfo
 {
     public static Type associationTypeOf( AccessibleObject accessor )

http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/d6dc0c9d/core/api/src/main/java/org/qi4j/api/composite/ConstructorDescriptor.java
----------------------------------------------------------------------
diff --git a/core/api/src/main/java/org/qi4j/api/composite/ConstructorDescriptor.java b/core/api/src/main/java/org/qi4j/api/composite/ConstructorDescriptor.java
index a7276e3..6e74dd9 100644
--- a/core/api/src/main/java/org/qi4j/api/composite/ConstructorDescriptor.java
+++ b/core/api/src/main/java/org/qi4j/api/composite/ConstructorDescriptor.java
@@ -21,5 +21,5 @@ import java.lang.reflect.Constructor;
  */
 public interface ConstructorDescriptor
 {
-    Constructor constructor();
+    Constructor<?> constructor();
 }

http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/d6dc0c9d/core/api/src/main/java/org/qi4j/api/composite/PropertyMapper.java
----------------------------------------------------------------------
diff --git a/core/api/src/main/java/org/qi4j/api/composite/PropertyMapper.java b/core/api/src/main/java/org/qi4j/api/composite/PropertyMapper.java
index 50ab2a4..7090083 100644
--- a/core/api/src/main/java/org/qi4j/api/composite/PropertyMapper.java
+++ b/core/api/src/main/java/org/qi4j/api/composite/PropertyMapper.java
@@ -26,7 +26,7 @@ import org.qi4j.api.util.Dates;
 import org.qi4j.api.value.ValueComposite;
 
 /**
- * Transfer properties to Composite properties
+ * Transfer java.util.Properties to Composite properties
  */
 public final class PropertyMapper
 {

http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/d6dc0c9d/core/api/src/main/java/org/qi4j/api/entity/EntityReference.java
----------------------------------------------------------------------
diff --git a/core/api/src/main/java/org/qi4j/api/entity/EntityReference.java b/core/api/src/main/java/org/qi4j/api/entity/EntityReference.java
index 0a4a14a..5cdece2 100644
--- a/core/api/src/main/java/org/qi4j/api/entity/EntityReference.java
+++ b/core/api/src/main/java/org/qi4j/api/entity/EntityReference.java
@@ -18,51 +18,77 @@ import java.io.Serializable;
 import org.qi4j.api.util.NullArgumentException;
 
 /**
- * An EntityReference is identity of a specific
- * Entity instance. When stringified, the identity is used as-is. Example:
- * <pre>
- * 123456-abcde
- * </pre>
+ * An EntityReference is identity of a specific Entity instance.
+ * <p>When stringified, the identity is used as-is. Example:</p>
+ * <pre>123456-abcde</pre>
  */
 public final class EntityReference
     implements Serializable
 {
+    /**
+     * Parse an URI to an EntityReference.
+     * @param uri the URI to parse
+     * @return the EntityReference represented by the given URI
+     */
     public static EntityReference parseURI( String uri )
     {
         String identity = uri.substring( "urn:qi4j:entity:".length() );
         return new EntityReference( identity );
     }
 
-    public static EntityReference parseEntityReference( String id )
+    /**
+     * Parse an Entity identity to an EntityReference.
+     * @param identity the EntityReference identity
+     * @return the EntityReference represented by the given identity
+     */
+    public static EntityReference parseEntityReference( String identity )
     {
-        return new EntityReference( id );
+        return new EntityReference( identity );
     }
 
-    public static EntityReference entityReferenceFor( Object o )
+    /**
+     * @param object an EntityComposite
+     * @return the EntityReference for the given EntityComposite
+     */
+    public static EntityReference entityReferenceFor( Object object )
     {
-        return new EntityReference( (EntityComposite) o );
+        return new EntityReference( (EntityComposite) object );
     }
 
     private static final long serialVersionUID = 1L;
 
     private String identity;
 
+    /**
+     * @param entityComposite a non-null EntityComposite
+     * @throws NullPointerException if entityComposite is null
+     */
     public EntityReference( EntityComposite entityComposite )
     {
         this( entityComposite.identity().get() );
     }
 
+    /**
+     * @param identity reference identity
+     * @throws NullArgumentException if identity is null or empty
+     */
     public EntityReference( String identity )
     {
         NullArgumentException.validateNotEmpty( "identity", identity );
         this.identity = identity;
     }
 
+    /**
+     * @return This EntityReference identity.
+     */
     public final String identity()
     {
         return identity;
     }
 
+    /**
+     * @return An URI representation of this EntityReference.
+     */
     public String toURI()
     {
         return "urn:qi4j:entity:" + identity;
@@ -91,6 +117,9 @@ public final class EntityReference
         return result;
     }
 
+    /**
+     * @return This EntityReference identity.
+     */
     @Override
     public String toString()
     {

http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/d6dc0c9d/core/api/src/main/java/org/qi4j/api/mixin/MixinDescriptor.java
----------------------------------------------------------------------
diff --git a/core/api/src/main/java/org/qi4j/api/mixin/MixinDescriptor.java b/core/api/src/main/java/org/qi4j/api/mixin/MixinDescriptor.java
index fe7cad3..288aac3 100644
--- a/core/api/src/main/java/org/qi4j/api/mixin/MixinDescriptor.java
+++ b/core/api/src/main/java/org/qi4j/api/mixin/MixinDescriptor.java
@@ -19,5 +19,5 @@ package org.qi4j.api.mixin;
  */
 public interface MixinDescriptor
 {
-    Class mixinClass();
+    Class<?> mixinClass();
 }

http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/d6dc0c9d/core/api/src/main/java/org/qi4j/api/property/InvalidPropertyTypeException.java
----------------------------------------------------------------------
diff --git a/core/api/src/main/java/org/qi4j/api/property/InvalidPropertyTypeException.java
b/core/api/src/main/java/org/qi4j/api/property/InvalidPropertyTypeException.java
index 033bb85..c98007e 100644
--- a/core/api/src/main/java/org/qi4j/api/property/InvalidPropertyTypeException.java
+++ b/core/api/src/main/java/org/qi4j/api/property/InvalidPropertyTypeException.java
@@ -3,6 +3,9 @@ package org.qi4j.api.property;
 import java.lang.reflect.AccessibleObject;
 import org.qi4j.api.common.ConstructionException;
 
+/**
+ * Thrown when attempting to subclass Property.
+ */
 public class InvalidPropertyTypeException extends ConstructionException
 {
     public InvalidPropertyTypeException( AccessibleObject accessor )

http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/d6dc0c9d/core/api/src/main/java/org/qi4j/api/property/Numbers.java
----------------------------------------------------------------------
diff --git a/core/api/src/main/java/org/qi4j/api/property/Numbers.java b/core/api/src/main/java/org/qi4j/api/property/Numbers.java
index f05a703..00c0e5f 100644
--- a/core/api/src/main/java/org/qi4j/api/property/Numbers.java
+++ b/core/api/src/main/java/org/qi4j/api/property/Numbers.java
@@ -17,10 +17,10 @@ package org.qi4j.api.property;
 import java.math.BigDecimal;
 
 /**
- * Convenience class for mathematical operations on
- * numerical properties.
- * <p/>
- * add(object.number(), 5)
+ * Convenience class for mathematical operations on numerical properties.
+ * <pre>import static org.qi4j.api.property.Numbers.*;
+ * ...
+ * add( object.numberProperty(), 5 );</pre>
  */
 public final class Numbers
 {

http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/d6dc0c9d/core/api/src/main/java/org/qi4j/api/service/ServiceReference.java
----------------------------------------------------------------------
diff --git a/core/api/src/main/java/org/qi4j/api/service/ServiceReference.java b/core/api/src/main/java/org/qi4j/api/service/ServiceReference.java
index 4c0ea2a..7c616c2 100644
--- a/core/api/src/main/java/org/qi4j/api/service/ServiceReference.java
+++ b/core/api/src/main/java/org/qi4j/api/service/ServiceReference.java
@@ -25,11 +25,23 @@ import org.qi4j.api.type.HasTypes;
 public interface ServiceReference<T>
     extends HasTypes, ActivationEventListenerRegistration, MetaInfoHolder
 {
+    /**
+     * @return the service's identity
+     */
     String identity();
 
+    /**
+     * @return the actual service
+     */
     T get();
 
+    /**
+     * @return TRUE if the service is active, otherwise return FALSE
+     */
     boolean isActive();
 
+    /**
+     * @return TRUE if the service is available, otherwise return FALSE
+     */
     boolean isAvailable();
 }

http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/d6dc0c9d/core/api/src/main/java/org/qi4j/api/sideeffect/SideEffectDescriptor.java
----------------------------------------------------------------------
diff --git a/core/api/src/main/java/org/qi4j/api/sideeffect/SideEffectDescriptor.java b/core/api/src/main/java/org/qi4j/api/sideeffect/SideEffectDescriptor.java
index 4f4955a..85e8610 100644
--- a/core/api/src/main/java/org/qi4j/api/sideeffect/SideEffectDescriptor.java
+++ b/core/api/src/main/java/org/qi4j/api/sideeffect/SideEffectDescriptor.java
@@ -19,5 +19,5 @@ package org.qi4j.api.sideeffect;
  */
 public interface SideEffectDescriptor
 {
-    Class modifierClass();
+    Class<?> modifierClass();
 }

http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/d6dc0c9d/core/api/src/main/java/org/qi4j/api/structure/ApplicationDescriptor.java
----------------------------------------------------------------------
diff --git a/core/api/src/main/java/org/qi4j/api/structure/ApplicationDescriptor.java b/core/api/src/main/java/org/qi4j/api/structure/ApplicationDescriptor.java
index 7a753b6..42e7b61 100644
--- a/core/api/src/main/java/org/qi4j/api/structure/ApplicationDescriptor.java
+++ b/core/api/src/main/java/org/qi4j/api/structure/ApplicationDescriptor.java
@@ -11,7 +11,6 @@
  * limitations under the License.
  *
  */
-
 package org.qi4j.api.structure;
 
 import org.qi4j.api.Qi4j;
@@ -23,7 +22,16 @@ import org.qi4j.functional.VisitableHierarchy;
 public interface ApplicationDescriptor
     extends VisitableHierarchy<Object, Object>
 {
+    /**
+     * Create a new instance of the Application.
+     * @param runtime Qi4j Runtime
+     * @param importedServiceInstances Imported Services instances
+     * @return a new instance of the Application.
+     */
     Application newInstance( Qi4j runtime, Object... importedServiceInstances );
 
+    /**
+     * @return the Application's name
+     */
     String name();
 }

http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/d6dc0c9d/core/api/src/main/java/org/qi4j/api/structure/Layer.java
----------------------------------------------------------------------
diff --git a/core/api/src/main/java/org/qi4j/api/structure/Layer.java b/core/api/src/main/java/org/qi4j/api/structure/Layer.java
index 104a6a9..fbde8c4 100644
--- a/core/api/src/main/java/org/qi4j/api/structure/Layer.java
+++ b/core/api/src/main/java/org/qi4j/api/structure/Layer.java
@@ -24,5 +24,8 @@ import org.qi4j.api.activation.ActivationEventListenerRegistration;
 public interface Layer
     extends ActivationEventListenerRegistration, Activation, MetaInfoHolder
 {
+    /**
+     * @return the Layer's name
+     */
     String name();
 }

http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/d6dc0c9d/core/api/src/main/java/org/qi4j/api/structure/LayerDescriptor.java
----------------------------------------------------------------------
diff --git a/core/api/src/main/java/org/qi4j/api/structure/LayerDescriptor.java b/core/api/src/main/java/org/qi4j/api/structure/LayerDescriptor.java
index fdb8108..db0c56a 100644
--- a/core/api/src/main/java/org/qi4j/api/structure/LayerDescriptor.java
+++ b/core/api/src/main/java/org/qi4j/api/structure/LayerDescriptor.java
@@ -11,7 +11,6 @@
  * limitations under the License.
  *
  */
-
 package org.qi4j.api.structure;
 
 /**
@@ -19,7 +18,14 @@ package org.qi4j.api.structure;
  */
 public interface LayerDescriptor
 {
+
+    /**
+     * @return the Layer's name
+     */
     String name();
 
+    /**
+     * @return Layers used by this Layer
+     */
     UsedLayersDescriptor usedLayers();
 }
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/d6dc0c9d/core/api/src/main/java/org/qi4j/api/structure/Module.java
----------------------------------------------------------------------
diff --git a/core/api/src/main/java/org/qi4j/api/structure/Module.java b/core/api/src/main/java/org/qi4j/api/structure/Module.java
index 5d21656..7360f96 100644
--- a/core/api/src/main/java/org/qi4j/api/structure/Module.java
+++ b/core/api/src/main/java/org/qi4j/api/structure/Module.java
@@ -12,7 +12,6 @@
  * limitations under the License.
  *
  */
-
 package org.qi4j.api.structure;
 
 import org.qi4j.api.activation.ActivationEventListenerRegistration;
@@ -43,15 +42,38 @@ public interface Module
             QueryBuilderFactory,
             ServiceFinder
 {
+
+    /**
+     * @return the Module's name
+     */
     String name();
 
+    /**
+     * @return the Module's ClassLoader
+     */
     ClassLoader classLoader();
 
+    /**
+     * @param typeName name of a transient composite type
+     * @return the descriptor for a transient composite or null if the class could not be
found or the transient composite is not visible
+     */
     TransientDescriptor transientDescriptor( String typeName );
 
+    /**
+     * @param typeName name of an entity composite type
+     * @return the descriptor for an entity composite or null if the class could not be found
or the entity composite is not visible
+     */
     EntityDescriptor entityDescriptor( String typeName );
 
+    /**
+     * @param typeName name of an object type
+     * @return the descriptor for an object or null if the class could not be found or the
object is not visible
+     */
     ObjectDescriptor objectDescriptor( String typeName );
 
+    /**
+     * @param typeName name of a value composite type
+     * @return the descriptor for a value composite or null if the class could not be found
or the value composite is not visible
+     */
     ValueDescriptor valueDescriptor( String typeName );
 }

http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/d6dc0c9d/core/api/src/main/java/org/qi4j/api/type/CollectionType.java
----------------------------------------------------------------------
diff --git a/core/api/src/main/java/org/qi4j/api/type/CollectionType.java b/core/api/src/main/java/org/qi4j/api/type/CollectionType.java
index 7e051f5..1b85b5f 100644
--- a/core/api/src/main/java/org/qi4j/api/type/CollectionType.java
+++ b/core/api/src/main/java/org/qi4j/api/type/CollectionType.java
@@ -20,7 +20,8 @@ import java.util.Set;
 import org.qi4j.api.util.Classes;
 
 /**
- * Collection type. This handles Collection, List and Set types
+ * Collection ValueType.
+ * <p>This handles Collection, List and Set types.</p>
  */
 public final class CollectionType
     extends ValueType

http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/d6dc0c9d/core/api/src/main/java/org/qi4j/api/type/EnumType.java
----------------------------------------------------------------------
diff --git a/core/api/src/main/java/org/qi4j/api/type/EnumType.java b/core/api/src/main/java/org/qi4j/api/type/EnumType.java
index f535a6b..aa4ff31 100644
--- a/core/api/src/main/java/org/qi4j/api/type/EnumType.java
+++ b/core/api/src/main/java/org/qi4j/api/type/EnumType.java
@@ -16,7 +16,7 @@ package org.qi4j.api.type;
 import java.lang.reflect.Type;
 
 /**
- * Enumeration type
+ * Enum ValueType.
  */
 public final class EnumType
     extends ValueType

http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/d6dc0c9d/core/api/src/main/java/org/qi4j/api/type/MapType.java
----------------------------------------------------------------------
diff --git a/core/api/src/main/java/org/qi4j/api/type/MapType.java b/core/api/src/main/java/org/qi4j/api/type/MapType.java
index c90690f..ddf03c5 100644
--- a/core/api/src/main/java/org/qi4j/api/type/MapType.java
+++ b/core/api/src/main/java/org/qi4j/api/type/MapType.java
@@ -18,7 +18,8 @@ import java.util.Map;
 import org.qi4j.api.util.Classes;
 
 /**
- * Map type. This handles instances of Map
+ * Map ValueType.
+ * <p>This handles instances of Map.</p>
  */
 public final class MapType
     extends ValueType

http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/d6dc0c9d/core/api/src/main/java/org/qi4j/api/type/ValueCompositeType.java
----------------------------------------------------------------------
diff --git a/core/api/src/main/java/org/qi4j/api/type/ValueCompositeType.java b/core/api/src/main/java/org/qi4j/api/type/ValueCompositeType.java
index fb99d0b..00f5723 100644
--- a/core/api/src/main/java/org/qi4j/api/type/ValueCompositeType.java
+++ b/core/api/src/main/java/org/qi4j/api/type/ValueCompositeType.java
@@ -22,7 +22,7 @@ import org.qi4j.api.value.ValueComposite;
 import org.qi4j.api.value.ValueDescriptor;
 
 /**
- * ValueComposite type
+ * ValueComposite ValueType.
  */
 public final class ValueCompositeType
     extends ValueType

http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/d6dc0c9d/core/api/src/main/java/org/qi4j/api/type/ValueType.java
----------------------------------------------------------------------
diff --git a/core/api/src/main/java/org/qi4j/api/type/ValueType.java b/core/api/src/main/java/org/qi4j/api/type/ValueType.java
index 92e7857..ede914c 100644
--- a/core/api/src/main/java/org/qi4j/api/type/ValueType.java
+++ b/core/api/src/main/java/org/qi4j/api/type/ValueType.java
@@ -23,8 +23,6 @@ import static org.qi4j.functional.Iterables.first;
 
 /**
  * Base class for types of values in ValueComposites and Properties.
- *
- * TODO I think the ValueType system requires some major re-thinking.
  */
 public class ValueType
     implements HasTypes
@@ -92,6 +90,9 @@ public class ValueType
         return isPrimitiveValueType( valueType.mainType() );
     }
 
+    /**
+     * @see ValueType#isPrimitiveValue(java.lang.Object) 
+     */
     public static boolean isPrimitiveValueType( Class<?> type )
     {
         NullArgumentException.validateNotNull( "type", type );

http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/d6dc0c9d/core/api/src/main/java/org/qi4j/api/unitofwork/UnitOfWorkException.java
----------------------------------------------------------------------
diff --git a/core/api/src/main/java/org/qi4j/api/unitofwork/UnitOfWorkException.java b/core/api/src/main/java/org/qi4j/api/unitofwork/UnitOfWorkException.java
index f961177..03b15d7 100644
--- a/core/api/src/main/java/org/qi4j/api/unitofwork/UnitOfWorkException.java
+++ b/core/api/src/main/java/org/qi4j/api/unitofwork/UnitOfWorkException.java
@@ -3,19 +3,22 @@
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
- *  
+ *
  * http://www.apache.org/licenses/LICENSE-2.0
- * 
+ *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
  * implied.
- * 
+ *
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
 package org.qi4j.api.unitofwork;
 
+/**
+ * Base Exception for UnitOfWork related concerns.
+ */
 public class UnitOfWorkException
     extends RuntimeException
 {

http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/d6dc0c9d/core/api/src/main/java/org/qi4j/api/util/Classes.java
----------------------------------------------------------------------
diff --git a/core/api/src/main/java/org/qi4j/api/util/Classes.java b/core/api/src/main/java/org/qi4j/api/util/Classes.java
index 04cf656..5f2e1ca 100644
--- a/core/api/src/main/java/org/qi4j/api/util/Classes.java
+++ b/core/api/src/main/java/org/qi4j/api/util/Classes.java
@@ -108,6 +108,9 @@ public final class Classes
         }
     };
 
+    /**
+     * Function that extract the raw class of a type.
+     */
     public static final Function<Type, Class<?>> RAW_CLASS = new Function<Type,
Class<?>>()
     {
         @Override

http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/d6dc0c9d/core/api/src/main/java/org/qi4j/api/util/Dates.java
----------------------------------------------------------------------
diff --git a/core/api/src/main/java/org/qi4j/api/util/Dates.java b/core/api/src/main/java/org/qi4j/api/util/Dates.java
index 3e7e39a..641a5b4 100644
--- a/core/api/src/main/java/org/qi4j/api/util/Dates.java
+++ b/core/api/src/main/java/org/qi4j/api/util/Dates.java
@@ -50,6 +50,10 @@ public final class Dates
         }
     };
 
+    /**
+     * @param stringDate a string representing a date as either ISO8601, @millis@ or /Date()
formats
+     * @return a Date
+     */
     public static Date fromString( String stringDate )
     {
         try
@@ -84,6 +88,10 @@ public final class Dates
         }
     }
 
+    /**
+     * @param date a Date
+     * @return String representation in ISO8601 UTC
+     */
     public static String toUtcString( Date date )
     {
         return ISO8601_UTC.get().format( date );

http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/d6dc0c9d/core/runtime/src/main/java/org/qi4j/runtime/composite/AbstractModifierModel.java
----------------------------------------------------------------------
diff --git a/core/runtime/src/main/java/org/qi4j/runtime/composite/AbstractModifierModel.java
b/core/runtime/src/main/java/org/qi4j/runtime/composite/AbstractModifierModel.java
index 8e8d032..58086f2 100644
--- a/core/runtime/src/main/java/org/qi4j/runtime/composite/AbstractModifierModel.java
+++ b/core/runtime/src/main/java/org/qi4j/runtime/composite/AbstractModifierModel.java
@@ -37,15 +37,15 @@ import static org.qi4j.functional.Iterables.*;
 public abstract class AbstractModifierModel
     implements Dependencies, VisitableHierarchy<Object, Object>
 {
-    private final Class modifierClass;
+    private final Class<?> modifierClass;
 
     private ConstructorsModel constructorsModel;
     private InjectedFieldsModel injectedFieldsModel;
     private InjectedMethodsModel injectedMethodsModel;
 
-    private Class[] nextInterfaces;
+    private Class<?>[] nextInterfaces;
 
-    public AbstractModifierModel( Class declaredModifierClass, Class instantiationClass )
+    public AbstractModifierModel( Class<?> declaredModifierClass, Class<?> instantiationClass
)
     {
         this.modifierClass = instantiationClass;
         constructorsModel = new ConstructorsModel( modifierClass );
@@ -55,7 +55,7 @@ public abstract class AbstractModifierModel
         nextInterfaces = toArray( componentType, unique( map( RAW_CLASS, interfacesOf( declaredModifierClass
) ) ));
     }
 
-    public Class modifierClass()
+    public Class<?> modifierClass()
     {
         return modifierClass;
     }

http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/d6dc0c9d/core/runtime/src/main/java/org/qi4j/runtime/composite/ConstructorModel.java
----------------------------------------------------------------------
diff --git a/core/runtime/src/main/java/org/qi4j/runtime/composite/ConstructorModel.java b/core/runtime/src/main/java/org/qi4j/runtime/composite/ConstructorModel.java
index dbb699d..072168e 100644
--- a/core/runtime/src/main/java/org/qi4j/runtime/composite/ConstructorModel.java
+++ b/core/runtime/src/main/java/org/qi4j/runtime/composite/ConstructorModel.java
@@ -32,11 +32,11 @@ import org.qi4j.runtime.injection.InjectionContext;
 public final class ConstructorModel
     implements ConstructorDescriptor, VisitableHierarchy<Object, Object>
 {
-    private Constructor constructor;
+    private Constructor<?> constructor;
 
     private InjectedParametersModel parameters;
 
-    public ConstructorModel( Constructor constructor, InjectedParametersModel parameters
)
+    public ConstructorModel( Constructor<?> constructor, InjectedParametersModel parameters
)
     {
         this.constructor = constructor;
         this.parameters = parameters;
@@ -44,7 +44,7 @@ public final class ConstructorModel
     }
 
     @Override
-    public Constructor constructor()
+    public Constructor<?> constructor()
     {
         return constructor;
     }

http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/d6dc0c9d/core/runtime/src/main/java/org/qi4j/runtime/composite/MixinModel.java
----------------------------------------------------------------------
diff --git a/core/runtime/src/main/java/org/qi4j/runtime/composite/MixinModel.java b/core/runtime/src/main/java/org/qi4j/runtime/composite/MixinModel.java
index 64fcb2e..4b281d7 100644
--- a/core/runtime/src/main/java/org/qi4j/runtime/composite/MixinModel.java
+++ b/core/runtime/src/main/java/org/qi4j/runtime/composite/MixinModel.java
@@ -42,14 +42,14 @@ import static org.qi4j.functional.Iterables.unique;
 public final class MixinModel
     implements MixinDescriptor, VisitableHierarchy<Object, Object>
 {
-    private final Class mixinClass;
-    private final Class instantiationClass;
+    private final Class<?> mixinClass;
+    private final Class<?> instantiationClass;
     private final ConstructorsModel constructorsModel;
     private final InjectedFieldsModel injectedFieldsModel;
     private final InjectedMethodsModel injectedMethodsModel;
     private final Iterable<Class<?>> thisMixinTypes;
 
-    public MixinModel( Class declaredMixinClass, Class instantiationClass )
+    public MixinModel( Class<?> declaredMixinClass, Class<?> instantiationClass
)
     {
         injectedFieldsModel = new InjectedFieldsModel( declaredMixinClass );
         injectedMethodsModel = new InjectedMethodsModel( declaredMixinClass );
@@ -62,12 +62,12 @@ public final class MixinModel
     }
 
     @Override
-    public Class mixinClass()
+    public Class<?> mixinClass()
     {
         return mixinClass;
     }
 
-    public Class instantiationClass()
+    public Class<?> instantiationClass()
     {
         return instantiationClass;
     }

http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/d6dc0c9d/core/runtime/src/main/java/org/qi4j/runtime/composite/SideEffectModel.java
----------------------------------------------------------------------
diff --git a/core/runtime/src/main/java/org/qi4j/runtime/composite/SideEffectModel.java b/core/runtime/src/main/java/org/qi4j/runtime/composite/SideEffectModel.java
index acd2680..cc3e377 100644
--- a/core/runtime/src/main/java/org/qi4j/runtime/composite/SideEffectModel.java
+++ b/core/runtime/src/main/java/org/qi4j/runtime/composite/SideEffectModel.java
@@ -23,7 +23,7 @@ public final class SideEffectModel
     extends AbstractModifierModel
     implements SideEffectDescriptor
 {
-    public SideEffectModel( Class sideEffectClass, Class instantiationClass )
+    public SideEffectModel( Class<?> sideEffectClass, Class<?> instantiationClass
)
     {
         super( sideEffectClass, instantiationClass );
     }


Mime
View raw message