Extend and Fix Up javadoc

- add javadoc for orm codec module
- fix javadoc for orm core module
- fix javadoc for api* module

.travis.yml

@@ -2,3 +2,5 @@ language: java
 jdk:
     - openjdk6
     - openjdk7
+    - oraclejdk6
+    - oraclejdk7

README.md

@@ -2,6 +2,7 @@
 
 Maven parent project, which contains the Java [apitrary Backend as a Service](http://apitrary.com/) client and orm modules.
 
+
 ### Getting Started
 ---
 
@@ -25,6 +26,7 @@ The latest apitrary artifacts are published to maven central. Bringing apitrary
   </dependencies>
 ```
 
+
 ### Requirements
 ---
 
@@ -66,7 +68,19 @@ For Maven: [Building a Project with Maven](http://maven.apache.org/run-maven/ind
 * [apitrary-api-client](https://github.com/denisneuling/apitrary.jar/tree/master/apitrary-api-client/)
 * [apitrary-orm](https://github.com/denisneuling/apitrary.jar/tree/master/apitrary-orm/)
 
+
 ### Interested into somewhat like build stability?
 ---
 
 * Have a look at [Apitrary.jar at Travis CI](https://travis-ci.org/denisneuling/apitrary.jar)
+
+
+### What about interface documentation? - Javadoc.
+---
+
+* [apitrary-api Javadoc](http://denisneuling.github.com/apitrary.jar/apitrary-api/)
+* [apitrary-api-client Javadoc](http://denisneuling.github.com/apitrary.jar/apitrary-api-client/)
+* [apitrary-orm-core Javadoc](http://denisneuling.github.com/apitrary.jar/apitrary-orm/apitrary-orm-core/)
+* [apitrary-orm-codec Javadoc](http://denisneuling.github.com/apitrary.jar/apitrary-orm/apitrary-orm-codec/)
+
+_Note: The Javadoc will be exported once a release, so it might differ from the current master branch implementation._

apitrary-api-client/README.md

@@ -2,6 +2,7 @@
 
 Maven parent project, which contains the Java [apitrary Backend as a Service](http://apitrary.com/) client and orm modules.
 
+
 ### Getting Started
 ---
 
@@ -25,6 +26,7 @@ The latest apitrary artifacts are published to maven central. Bringing apitrary
   </dependencies>
 ```
 
+
 ### Requirements
 ---
 
@@ -66,7 +68,19 @@ For Maven: [Building a Project with Maven](http://maven.apache.org/run-maven/ind
 * [apitrary-api-client](https://github.com/denisneuling/apitrary.jar/tree/master/apitrary-api-client/)
 * [apitrary-orm](https://github.com/denisneuling/apitrary.jar/tree/master/apitrary-orm/)
 
+
 ### Interested into somewhat like build stability?
 ---
 
 * Have a look at [Apitrary.jar at Travis CI](https://travis-ci.org/denisneuling/apitrary.jar)
+
+
+### What about interface documentation? - Javadoc.
+---
+
+* [apitrary-api Javadoc](http://denisneuling.github.com/apitrary.jar/apitrary-api/)
+* [apitrary-api-client Javadoc](http://denisneuling.github.com/apitrary.jar/apitrary-api-client/)
+* [apitrary-orm-core Javadoc](http://denisneuling.github.com/apitrary.jar/apitrary-orm/apitrary-orm-core/)
+* [apitrary-orm-codec Javadoc](http://denisneuling.github.com/apitrary.jar/apitrary-orm/apitrary-orm-codec/)
+
+_Note: The Javadoc will be exported once a release, so it might differ from the current master branch implementation._

apitrary-api-client/src/main/java/com/apitrary/api/client/ApitraryClient.java

@@ -50,10 +50,25 @@ public class ApitraryClient extends AbstractApitraryClient {
 	private int connectionTimeout = DEFAULTCONNECTIONTIMEOUT;
 	private int receiveTimeout = DEFAULTRECEIVETIMEOUT;
 
+	/**
+	 * <p>
+	 * Constructor for ApitraryClient.
+	 * </p>
+	 * 
+	 * @param api
+	 *            a {@link com.apitrary.api.client.ApitraryApi} object.
+	 */
 	protected ApitraryClient(ApitraryApi api) {
 		this.api = api;
 	}
 
+	/**
+	 * <p>
+	 * Constructor for ApitraryClient.
+	 * </p>
+	 * 
+	 * @since 0.1.1
+	 */
 	protected ApitraryClient() {
 		throw new RuntimeException("Apitrary Client needs to connect to the targeted API. Hint: Use factory method #connectTo(ApitraryApi api)");
 	}
@@ -156,6 +171,7 @@ protected WebClient instantiateWebClient() {
 	 * </p>
 	 * 
 	 * @return a int.
+	 * @since 0.1.1
 	 */
 	public int getConnectionTimeout() {
 		return connectionTimeout;
@@ -168,6 +184,7 @@ public int getConnectionTimeout() {
 	 * 
 	 * @param connectionTimeout
 	 *            a int.
+	 * @since 0.1.1
 	 */
 	public void setConnectionTimeout(int connectionTimeout) {
 		this.connectionTimeout = connectionTimeout;

apitrary-api-client/src/main/java/com/apitrary/api/client/util/ClassUtil.java

@@ -182,6 +182,14 @@ public static Field[] getAllDeclaredFields(Class<?> clazz) {
 	 *            a {@link java.lang.Class} object.
 	 * @param referenceClazz
 	 *            a {@link java.lang.Class} object.
+	 * @param referenceClazz
+	 *            a {@link java.lang.Class} object.
+	 * @param referenceClazz
+	 *            a {@link java.lang.Class} object.
+	 * @param referenceClazz
+	 *            a {@link java.lang.Class} object.
+	 * @param referenceClazz
+	 *            a {@link java.lang.Class} object.
 	 * @param valueType
 	 *            a {@link java.lang.Class} object.
 	 * @param <T>
@@ -216,6 +224,14 @@ public static <T> T getValueOf(Field field, Object reference, Class<?> reference
 	 *            a {@link java.lang.Class} object.
 	 * @param referenceClazz
 	 *            a {@link java.lang.Class} object.
+	 * @param referenceClazz
+	 *            a {@link java.lang.Class} object.
+	 * @param referenceClazz
+	 *            a {@link java.lang.Class} object.
+	 * @param referenceClazz
+	 *            a {@link java.lang.Class} object.
+	 * @param referenceClazz
+	 *            a {@link java.lang.Class} object.
 	 * @param valueType
 	 *            a {@link java.lang.Class} object.
 	 * @param <T>

apitrary-api/README.md

@@ -2,6 +2,7 @@
 
 Maven parent project, which contains the Java [apitrary Backend as a Service](http://apitrary.com/) client and orm modules.
 
+
 ### Getting Started
 ---
 
@@ -25,6 +26,7 @@ The latest apitrary artifacts are published to maven central. Bringing apitrary
   </dependencies>
 ```
 
+
 ### Requirements
 ---
 
@@ -66,7 +68,19 @@ For Maven: [Building a Project with Maven](http://maven.apache.org/run-maven/ind
 * [apitrary-api-client](https://github.com/denisneuling/apitrary.jar/tree/master/apitrary-api-client/)
 * [apitrary-orm](https://github.com/denisneuling/apitrary.jar/tree/master/apitrary-orm/)
 
+
 ### Interested into somewhat like build stability?
 ---
 
 * Have a look at [Apitrary.jar at Travis CI](https://travis-ci.org/denisneuling/apitrary.jar)
+
+
+### What about interface documentation? - Javadoc.
+---
+
+* [apitrary-api Javadoc](http://denisneuling.github.com/apitrary.jar/apitrary-api/)
+* [apitrary-api-client Javadoc](http://denisneuling.github.com/apitrary.jar/apitrary-api-client/)
+* [apitrary-orm-core Javadoc](http://denisneuling.github.com/apitrary.jar/apitrary-orm/apitrary-orm-core/)
+* [apitrary-orm-codec Javadoc](http://denisneuling.github.com/apitrary.jar/apitrary-orm/apitrary-orm-codec/)
+
+_Note: The Javadoc will be exported once a release, so it might differ from the current master branch implementation._

apitrary-orm/.gitignore

@@ -12,3 +12,7 @@
 
 # Maven Files #
 target/
+
+
+#temporarily
+apitrary-orm-query/

apitrary-orm/apitrary-orm-codec/README.md

@@ -2,6 +2,7 @@
 
 Maven parent project, which contains the Java [apitrary Backend as a Service](http://apitrary.com/) client and orm modules.
 
+
 ### Getting Started
 ---
 
@@ -25,6 +26,7 @@ The latest apitrary artifacts are published to maven central. Bringing apitrary
   </dependencies>
 ```
 
+
 ### Requirements
 ---
 
@@ -66,7 +68,19 @@ For Maven: [Building a Project with Maven](http://maven.apache.org/run-maven/ind
 * [apitrary-api-client](https://github.com/denisneuling/apitrary.jar/tree/master/apitrary-api-client/)
 * [apitrary-orm](https://github.com/denisneuling/apitrary.jar/tree/master/apitrary-orm/)
 
+
 ### Interested into somewhat like build stability?
 ---
 
 * Have a look at [Apitrary.jar at Travis CI](https://travis-ci.org/denisneuling/apitrary.jar)
+
+
+### What about interface documentation? - Javadoc.
+---
+
+* [apitrary-api Javadoc](http://denisneuling.github.com/apitrary.jar/apitrary-api/)
+* [apitrary-api-client Javadoc](http://denisneuling.github.com/apitrary.jar/apitrary-api-client/)
+* [apitrary-orm-core Javadoc](http://denisneuling.github.com/apitrary.jar/apitrary-orm/apitrary-orm-core/)
+* [apitrary-orm-codec Javadoc](http://denisneuling.github.com/apitrary.jar/apitrary-orm/apitrary-orm-codec/)
+
+_Note: The Javadoc will be exported once a release, so it might differ from the current master branch implementation._

apitrary-orm/apitrary-orm-codec/src/main/java/com/apitrary/orm/codec/base64/Base64Codec.java

@@ -26,6 +26,7 @@
  * 
  * @author Denis Neuling ([email protected])
  * 
+ * @since 0.1.1
  */
 public class Base64Codec extends Codec<byte[]> {
 

apitrary-orm/apitrary-orm-codec/src/main/java/com/apitrary/orm/codec/date/DateISO8601Codec.java

@@ -0,0 +1,59 @@
+/*
+ * Copyright 2012-2013 Denis Neuling 
+ * 
+ * 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 com.apitrary.orm.codec.date;
+
+import java.text.ParseException;
+import java.text.SimpleDateFormat;
+import java.util.Calendar;
+import java.util.Date;
+import java.util.GregorianCalendar;
+
+import com.apitrary.orm.core.codec.Codec;
+
+/**
+ * @author Denis Neuling ([email protected])
+ * 
+ */
+public class DateISO8601Codec extends Codec<Date> {
+
+	/** {@inheritDoc} */
+	@Override
+	public Date decode(String value) {
+		Calendar calendar = GregorianCalendar.getInstance();
+		String s = value.replace("Z", "+00:00");
+		try {
+			s = s.substring(0, 22) + s.substring(23);
+		} catch (IndexOutOfBoundsException e) {
+			throw new RuntimeException(e);
+		}
+		Date date;
+		try {
+			date = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ssZ").parse(s);
+			calendar.setTime(date);
+			return calendar.getTime();
+		} catch (ParseException e) {
+			throw new RuntimeException(e);
+		}
+	}
+
+	/** {@inheritDoc} */
+	@Override
+	public String encode(Date object) {
+		String formatted = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ssZ").format(object);
+		return formatted.substring(0, 22) + ":" + formatted.substring(22);
+	}
+
+}

apitrary-orm/apitrary-orm-codec/src/main/java/com/apitrary/orm/codec/image/ImageGIFCodec.java

@@ -29,8 +29,13 @@
 import com.apitrary.orm.core.codec.Codec;
 
 /**
+ * <p>
+ * ImageGIFCodec class.
+ * </p>
+ * 
  * @author Denis Neuling ([email protected])
  * 
+ * @since 0.1.1
  */
 public class ImageGIFCodec extends Codec<Image> {
 

apitrary-orm/apitrary-orm-codec/src/main/java/com/apitrary/orm/codec/image/ImageJPGCodec.java

@@ -29,8 +29,13 @@
 import com.apitrary.orm.core.codec.Codec;
 
 /**
+ * <p>
+ * ImageJPGCodec class.
+ * </p>
+ * 
  * @author Denis Neuling ([email protected])
  * 
+ * @since 0.1.1
  */
 public class ImageJPGCodec extends Codec<Image> {
 

apitrary-orm/apitrary-orm-codec/src/main/java/com/apitrary/orm/codec/image/ImagePNGCodec.java

@@ -29,8 +29,13 @@
 import com.apitrary.orm.core.codec.Codec;
 
 /**
+ * <p>
+ * ImagePNGCodec class.
+ * </p>
+ * 
  * @author Denis Neuling ([email protected])
  * 
+ * @since 0.1.1
  */
 public class ImagePNGCodec extends Codec<Image> {
 

apitrary-orm/apitrary-orm-codec/src/test/java/com/apitrary/orm/codec/base64/Base64CodecTest.java

@@ -22,24 +22,24 @@
 
 /**
  * @author Denis Neuling ([email protected])
- *
+ * 
  */
 public class Base64CodecTest {
 
 	private Base64Codec codec;
-	
+
 	private String string = "abcdefghijklmnopqrstuvwxyz0123456789";
-	
+
 	@Before
-	public void setUp(){
+	public void setUp() {
 		codec = new Base64Codec();
 	}
-	
+
 	@Test
-	public void test_encode(){
+	public void test_encode() {
 		byte[] buffer = codec.decode(string);
 		String result = codec.encode(buffer);
-		
+
 		Assert.assertEquals(string, result);
 	}
 }