build(maven): fix javadoc, add github repository

Author: fhussonnois

connect-file-pulse-api/pom.xml

@@ -40,6 +40,35 @@
                 <filtering>true</filtering>
             </resource>
         </resources>
+
+        <plugins>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-source-plugin</artifactId>
+                <version>2.2.1</version>
+                <executions>
+                    <execution>
+                        <id>attach-sources</id>
+                        <goals>
+                            <goal>jar-no-fork</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-javadoc-plugin</artifactId>
+                <version>2.9.1</version>
+                <executions>
+                    <execution>
+                        <id>attach-javadocs</id>
+                        <goals>
+                            <goal>jar</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>
+        </plugins>
     </build>
 
     <dependencies>

connect-file-pulse-api/src/main/java/io/streamthoughts/kafka/connect/filepulse/data/ArraySchema.java

@@ -30,6 +30,8 @@ public class ArraySchema implements Schema {
 
     /**
      * Creates a new MapSchema for the specified type.
+     *
+     * @param valueSchema the {@link Schema} instance.
      */
     ArraySchema(final Schema valueSchema) {
         this.type = Type.ARRAY;

connect-file-pulse-api/src/main/java/io/streamthoughts/kafka/connect/filepulse/data/GettableByName.java

@@ -39,71 +39,105 @@ public interface GettableByName extends Serializable {
     /**
      * Returns the {@code field} content as a Map.
      *
+     * @param field   the field name.
+     * @param <K>     the key type
+     * @param <V>     the value type.
+     * @return        the field as map.
+     *
      * @throws DataException if content {@code field} is not of type MAP.
      */
+
     <K, V> Map<K, V> getMap(final String field) throws DataException;
 
     TypedValue get(final String field) throws DataException;
 
     /**
      * Returns the {@code field} content as a values.
      *
+     * @param         field the field name.
+     * @return        the field as struct.
+     *
      * @throws DataException if content {@code field} is not of type VALUE.
      */
     TypedStruct getStruct(final String field) throws DataException;
 
     /**
      * Returns the {@code field} content as a collection.
      *
+     * @param field   the field name.
+     * @param <T>     the value type.
+     * @return        the field as array.
+     *
      * @throws DataException if content {@code field} is not of type ARRAY.
      */
     <T> Collection<T> getArray(final String field) throws DataException;
 
     /**
      * Returns the {@code field} content as a boolean.
      *
+     * @param         field the field name.
+     * @return        the field as short.
+     *
      * @throws DataException if content {@code field} is not of type INT-16.
      */
     Short getShort(final String field) throws DataException;
 
     /**
      * Returns the {@code field} content as a double.
      *
+     * @param         field the field name.
+     * @return        the field as boolean.
+     *
      * @throws DataException if content {@code field} is not of type BOOLEAN.
      */
     Boolean getBoolean(final String field) throws DataException;
 
     /**
      * Returns the {@code field} content as an integer.
      *
+     * @param         field the field name.
+     * @return        the field as integer.
+     *
      * @throws DataException if content {@code field} is not of type INT32.
      */
     Integer getInt(final String field) throws DataException;
 
     /**
      * Returns the {@code field} content as a long.
      *
+     * @param         field the field name.
+     * @return        the field as long.
+     *
      * @throws DataException if content {@code field} is not of type INT64.
      */
     Long getLong(final String field) throws DataException;
 
     /**
      * Returns the {@code field} content as a float.
      *
+     * @param         field the field name.
+     * @return        the field as float.
+     *
      * @throws DataException if content {@code field} is not of type FLOAT.
      */
     Float getFloat(final String field) throws DataException;
 
     /**
      * Returns the {@code field} content as a double.
      *
+     * @param         field the field double.
+     * @return        the field as float.
+     *
      * @throws DataException if content {@code field} is not of type DOUBLE.
      */
     Double getDouble(final String field) throws DataException;
 
     /**
      * Returns the {@code field} content as a string.
      *
+     * @param         field the field string.
+     * @return        the field as float.
+     *
      * @throws DataException if content {@code field} is not of STRING.
      */
     String getString(final String field) throws DataException;

connect-file-pulse-api/src/main/java/io/streamthoughts/kafka/connect/filepulse/data/LazyArraySchema.java

@@ -27,14 +27,19 @@ public class LazyArraySchema extends ArraySchema implements Schema {
     private Schema valueSchema;
 
     /**
-     * Creates a new LazyArraySchema for the specified type.
+     * Creates a new {@link LazyArraySchema} for the specified type.
+     *
+     * @param list the {@link List} instance.
      */
     LazyArraySchema(final List list) {
         super(null);
         this.list = list;
 
     }
 
+    /**
+     * {@inheritDoc}
+     */
     @Override
     public Schema valueSchema() {
         if (valueSchema == null) {

connect-file-pulse-api/src/main/java/io/streamthoughts/kafka/connect/filepulse/data/MapSchema.java

@@ -33,6 +33,8 @@ public class MapSchema implements Schema {
 
     /**
      * Creates a new MapSchema for the specified type.
+     *
+     * @param valueSchema the {@link Schema} instance.
      */
     MapSchema(final Schema valueSchema) {
         this.type = Type.MAP;

connect-file-pulse-api/src/main/java/io/streamthoughts/kafka/connect/filepulse/data/Schema.java

@@ -124,6 +124,8 @@ static StructSchema struct() {
     /**
      * Gets the schema for type MAP.
      *
+     * @param valueSchema the {@link Schema} instance.
+     *
      * @return  the {@link Schema} instance.
      */
     static MapSchema map(final Schema valueSchema) {
@@ -133,6 +135,8 @@ static MapSchema map(final Schema valueSchema) {
     /**
      * Gets the schema for type ARRAY.
      *
+     * @param valueSchema the {@link Schema} instance.
+     *
      * @return  the {@link Schema} instance.
      */
     static ArraySchema array(final Schema valueSchema) {

connect-file-pulse-api/src/main/java/io/streamthoughts/kafka/connect/filepulse/data/SettableByName.java

@@ -24,6 +24,8 @@
 
 /**
  * Collection of (typed) values that can be retrieved by name.
+ *
+ * @param <T>   the {@link SettableByName} type.
  */
 public interface SettableByName<T extends SettableByName> extends Serializable {
 
@@ -33,6 +35,8 @@ public interface SettableByName<T extends SettableByName> extends Serializable {
      * @param field the name of the field.
      * @param object the object to put.
      * @param type the object type.
+     *
+     * @return        this instance.
      */
     T put(final String field, final Type type, final Object object)
             throws DataException;
@@ -42,7 +46,9 @@ T put(final String field, final Type type, final Object object)
      *
      * @param field   the name of the field.
      * @param value   the object to put.
+     * @return        this instance.
      */
+
     T put(final String field, final TypedStruct value)
             throws DataException;
 
@@ -51,6 +57,9 @@ T put(final String field, final TypedStruct value)
      *
      * @param field   the name of the field.
      * @param value   the object to put.
+     * @param <E>     the element type.
+     *
+     * @return        this instance.
      */
     <E> T put(final String field, final List<E> value)
             throws DataException;
@@ -60,6 +69,9 @@ <E> T put(final String field, final List<E> value)
      *
      * @param field   the name of the field.
      * @param value   the object to put.
+     * @param <E>     the element type.
+     *
+     * @return        this instance.
      */
     <E> T put(final String field, final E[] value)
             throws DataException;
@@ -69,6 +81,10 @@ <E> T put(final String field, final E[] value)
      *
      * @param field   the name of the field.
      * @param object  the object to put.
+     * @param <K>     the key type.
+     * @param <V>     the value type.
+     *
+     * @return        this instance.
      */
     <K, V> T put(final String field, final Map<K, V> object)
             throws DataException;
@@ -78,6 +94,8 @@ <K, V> T put(final String field, final Map<K, V> object)
      *
      * @param field   the name of the field.
      * @param object  the object to put.
+     *
+     * @return        this instance.
      */
     T put(final String field, final Boolean object)
             throws DataException;
@@ -87,6 +105,8 @@ T put(final String field, final Boolean object)
      *
      * @param field   the name of the field.
      * @param object  the object to put.
+     *
+     * @return        this instance.
      */
     T put(final String field, final Short object)
             throws DataException;
@@ -96,6 +116,8 @@ T put(final String field, final Short object)
      *
      * @param field   the name of the field.
      * @param object  the object to put.
+     *
+     * @return        this instance.
      */
     T put(final String field, final Integer object)
             throws DataException;
@@ -105,6 +127,8 @@ T put(final String field, final Integer object)
      *
      * @param field   the name of the field.
      * @param object  the object to put.
+     *
+     * @return        this instance.
      */
     T put(final String field, final Long object)
             throws DataException;
@@ -114,6 +138,8 @@ T put(final String field, final Long object)
      *
      * @param field   the name of the field.
      * @param object  the object to put.
+     *
+     * @return        this instance.
      */
     T put(final String field, final Double object)
             throws DataException;
@@ -123,6 +149,8 @@ T put(final String field, final Double object)
      *
      * @param field   the name of the field.
      * @param object  the object to put.
+     *
+     * @return        this instance.
      */
     T put(final String field, final Float object)
             throws DataException;
@@ -132,6 +160,8 @@ T put(final String field, final Float object)
      *
      * @param field   the name of the field.
      * @param object  the object to put.
+     *
+     * @return        this instance.
      */
     T put(final String field, final String object)
             throws DataException;
@@ -141,6 +171,8 @@ T put(final String field, final String object)
      *
      * @param field   the name of the field.
      * @param object  the object to put.
+     *
+     * @return        this instance.
      */
     T put(final String field, final byte[] object)
             throws DataException;

connect-file-pulse-api/src/main/java/io/streamthoughts/kafka/connect/filepulse/data/StructSchema.java

@@ -44,6 +44,8 @@ public StructSchema() {
 
     /**
      * Creates a new {@link StructSchema} instance.
+     *
+     * @param fields    the collection {@link TypedField} instances.
      */
     public StructSchema(final Collection<TypedField> fields) {
         this.type = Type.STRUCT;

connect-file-pulse-api/src/main/java/io/streamthoughts/kafka/connect/filepulse/expression/EvaluationContext.java

@@ -29,16 +29,22 @@ public interface EvaluationContext {
 
     /**
      * Return the default root context object against which an expression is evaluated.
+     *
+     * @return the root {@link Object}.
      */
     Object rootObject();
 
     /**
      * Return a list of accessors that will be asked in turn to read/write a property.
+     *
+     * @return the list of {@link PropertyAccessor} instance.
      */
     List<PropertyAccessor> getPropertyAccessors();
 
     /**
      * Return a list of converter that will be asked in turn to convert read value into expected type.
+     *
+     * @return the list of {@link PropertyConverter} instance.
      */
     List<PropertyConverter> getPropertyConverter();
 

connect-file-pulse-api/src/main/java/io/streamthoughts/kafka/connect/filepulse/expression/Expression.java

@@ -31,8 +31,10 @@ public interface Expression {
     /**
      * Evaluates the variables defined into the given context.
      *
-     * @param context   the expression context.
-     * @return          the object resulting from the expression evaluation.
+     * @param context       the expression context.
+     * @param expectedType  the class of the expected type to return.
+     * @param <T>           the expected type to return.
+     * @return              the object resulting from the expression evaluation.
      */
     <T> T readValue(final EvaluationContext context, final Class<T> expectedType);