You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@olingo.apache.org by mi...@apache.org on 2016/02/25 21:42:16 UTC

olingo-odata4 git commit: [OLINGO-832] Added javadoc and minor code clean up

Repository: olingo-odata4
Updated Branches:
  refs/heads/master 2d4772dc1 -> a44f38d70


[OLINGO-832] Added javadoc and minor code clean up


Project: http://git-wip-us.apache.org/repos/asf/olingo-odata4/repo
Commit: http://git-wip-us.apache.org/repos/asf/olingo-odata4/commit/a44f38d7
Tree: http://git-wip-us.apache.org/repos/asf/olingo-odata4/tree/a44f38d7
Diff: http://git-wip-us.apache.org/repos/asf/olingo-odata4/diff/a44f38d7

Branch: refs/heads/master
Commit: a44f38d70de53e000167c020e365698d2c16f191
Parents: 2d4772d
Author: Michael Bolz <mi...@sap.com>
Authored: Thu Feb 25 21:30:23 2016 +0100
Committer: Michael Bolz <mi...@sap.com>
Committed: Thu Feb 25 21:30:23 2016 +0100

----------------------------------------------------------------------
 .../client/AbstractParamTecSvcITCase.java       |  1 -
 .../fit/tecsvc/http/BasicStreamITCase.java      |  1 -
 .../api/data/AbstractEntityCollection.java      |  1 -
 .../olingo/commons/api/data/EntityIterator.java | 35 ++++++++++++++++++--
 .../olingo/server/api/edmx/EdmxReference.java   |  1 -
 .../core/edm/annotations/EdmRecordImplTest.java |  1 -
 6 files changed, 32 insertions(+), 8 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/olingo-odata4/blob/a44f38d7/fit/src/test/java/org/apache/olingo/fit/tecsvc/client/AbstractParamTecSvcITCase.java
----------------------------------------------------------------------
diff --git a/fit/src/test/java/org/apache/olingo/fit/tecsvc/client/AbstractParamTecSvcITCase.java b/fit/src/test/java/org/apache/olingo/fit/tecsvc/client/AbstractParamTecSvcITCase.java
index dc2b940..ef9e2d3 100644
--- a/fit/src/test/java/org/apache/olingo/fit/tecsvc/client/AbstractParamTecSvcITCase.java
+++ b/fit/src/test/java/org/apache/olingo/fit/tecsvc/client/AbstractParamTecSvcITCase.java
@@ -28,7 +28,6 @@ import java.util.List;
 import java.util.TimeZone;
 
 import org.apache.olingo.commons.api.format.ContentType;
-import org.apache.olingo.server.tecsvc.data.DataProvider;
 import org.junit.After;
 import org.junit.Before;
 import org.junit.runner.RunWith;

http://git-wip-us.apache.org/repos/asf/olingo-odata4/blob/a44f38d7/fit/src/test/java/org/apache/olingo/fit/tecsvc/http/BasicStreamITCase.java
----------------------------------------------------------------------
diff --git a/fit/src/test/java/org/apache/olingo/fit/tecsvc/http/BasicStreamITCase.java b/fit/src/test/java/org/apache/olingo/fit/tecsvc/http/BasicStreamITCase.java
index 0c2ddb5..a3e0c8d 100644
--- a/fit/src/test/java/org/apache/olingo/fit/tecsvc/http/BasicStreamITCase.java
+++ b/fit/src/test/java/org/apache/olingo/fit/tecsvc/http/BasicStreamITCase.java
@@ -70,7 +70,6 @@ public class BasicStreamITCase extends AbstractBaseTestITCase {
     assertEquals(ContentType.APPLICATION_XML, ContentType.create(connection.getHeaderField(HttpHeader.CONTENT_TYPE)));
 
     final String content = IOUtils.toString(connection.getInputStream());
-    System.out.println(content);
 
     assertTrue(content.contains("<m:element>Streamed-Employee1@company.example</m:element>" +
             "<m:element>Streamed-Employee2@company.example</m:element>" +

http://git-wip-us.apache.org/repos/asf/olingo-odata4/blob/a44f38d7/lib/commons-api/src/main/java/org/apache/olingo/commons/api/data/AbstractEntityCollection.java
----------------------------------------------------------------------
diff --git a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/data/AbstractEntityCollection.java b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/data/AbstractEntityCollection.java
index a3222c7..2d7a689 100644
--- a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/data/AbstractEntityCollection.java
+++ b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/data/AbstractEntityCollection.java
@@ -19,7 +19,6 @@
 package org.apache.olingo.commons.api.data;
 
 import java.net.URI;
-import java.util.Iterator;
 
 public abstract class AbstractEntityCollection extends AbstractODataObject implements Iterable<Entity> {
   public abstract Integer getCount();

http://git-wip-us.apache.org/repos/asf/olingo-odata4/blob/a44f38d7/lib/commons-api/src/main/java/org/apache/olingo/commons/api/data/EntityIterator.java
----------------------------------------------------------------------
diff --git a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/data/EntityIterator.java b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/data/EntityIterator.java
index 8afd1fe..b08e184 100644
--- a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/data/EntityIterator.java
+++ b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/data/EntityIterator.java
@@ -19,39 +19,68 @@
 package org.apache.olingo.commons.api.data;
 
 import org.apache.olingo.commons.api.ex.ODataNotSupportedException;
-import org.apache.olingo.commons.api.ex.ODataRuntimeException;
-import sun.reflect.generics.reflectiveObjects.NotImplementedException;
 
 import java.net.URI;
 import java.util.Iterator;
 
 /**
- * Data representation for a collection of single entities.
+ * Data representation as an Iterator for a collection of single entities.
  */
 public abstract class EntityIterator extends AbstractEntityCollection implements Iterator<Entity> {
 
+  /**
+   * {@inheritDoc}
+   */
   public abstract boolean hasNext();
+  /**
+   * {@inheritDoc}
+   * <p/>
+   * Which is an Entity for this type of iterator.
+   */
   public abstract Entity next();
 
+  /**
+   * {@inheritDoc}
+   * <p/>
+   * <b>ATTENTION:</b> <code>remove</code> is not supported by default.
+   */
   @Override
   public void remove() {
     //"Remove is not supported for iteration over Entities."
     throw new ODataNotSupportedException("Entity Iterator does not support remove()");
   }
 
+  /**
+   * {@inheritDoc}
+   */
   @Override
   public Iterator<Entity> iterator() {
     return this;
   }
 
+  /**
+   * {@inheritDoc}
+   * <p/>
+   * <b>ATTENTION:</b> <code>getCount</code> is not supported by default.
+   */
   public Integer getCount() {
     throw new ODataNotSupportedException("Entity Iterator does not support getCount()");
   }
 
+  /**
+   * {@inheritDoc}
+   * <p/>
+   * <b>ATTENTION:</b> <code>getNext</code> is not supported by default.
+   */
   public URI getNext() {
     throw new ODataNotSupportedException("Entity Iterator does not support getNext()");
   }
 
+  /**
+   * {@inheritDoc}
+   * <p/>
+   * <b>ATTENTION:</b> <code>getDeltaLink</code> is not supported by default.
+   */
   public URI getDeltaLink() {
     throw new ODataNotSupportedException("Entity Iterator does not support getDeltaLink()");
   }

http://git-wip-us.apache.org/repos/asf/olingo-odata4/blob/a44f38d7/lib/commons-api/src/main/java/org/apache/olingo/server/api/edmx/EdmxReference.java
----------------------------------------------------------------------
diff --git a/lib/commons-api/src/main/java/org/apache/olingo/server/api/edmx/EdmxReference.java b/lib/commons-api/src/main/java/org/apache/olingo/server/api/edmx/EdmxReference.java
index e1b735b..8298c0e 100644
--- a/lib/commons-api/src/main/java/org/apache/olingo/server/api/edmx/EdmxReference.java
+++ b/lib/commons-api/src/main/java/org/apache/olingo/server/api/edmx/EdmxReference.java
@@ -25,7 +25,6 @@ import java.util.List;
 
 import org.apache.olingo.commons.api.edm.provider.CsdlAnnotatable;
 import org.apache.olingo.commons.api.edm.provider.CsdlAnnotation;
-import org.apache.olingo.commons.api.edm.provider.CsdlReturnType;
 
 /**
  * POJO for Edmx Reference.

http://git-wip-us.apache.org/repos/asf/olingo-odata4/blob/a44f38d7/lib/commons-core/src/test/java/org/apache/olingo/commons/core/edm/annotations/EdmRecordImplTest.java
----------------------------------------------------------------------
diff --git a/lib/commons-core/src/test/java/org/apache/olingo/commons/core/edm/annotations/EdmRecordImplTest.java b/lib/commons-core/src/test/java/org/apache/olingo/commons/core/edm/annotations/EdmRecordImplTest.java
index 8076ffb..8b149f2 100644
--- a/lib/commons-core/src/test/java/org/apache/olingo/commons/core/edm/annotations/EdmRecordImplTest.java
+++ b/lib/commons-core/src/test/java/org/apache/olingo/commons/core/edm/annotations/EdmRecordImplTest.java
@@ -21,7 +21,6 @@ package org.apache.olingo.commons.core.edm.annotations;
 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertNotNull;
 import static org.junit.Assert.assertTrue;
-import static org.junit.Assert.fail;
 import static org.mockito.Mockito.mock;
 import static org.mockito.Mockito.when;