code-style refactoring, fix Javadoc warnings

Author: w0rxbend

src/main/java/com/arangodb/ArangoCollection.java

@@ -368,11 +368,6 @@ <T> MultiDocumentEntity<DocumentUpdateEntity<T>> updateDocuments(
 	 *      Documentation</a>
 	 * @param key
 	 *            The key of the document
-	 * @param type
-	 *            The type of the document (POJO class, VPackSlice or String for JSON). Only necessary if
-	 *            options.returnOld is set to true, otherwise can be null.
-	 * @param options
-	 *            Additional options, can be null
 	 * @return information about the document
 	 * @throws ArangoDBException
 	 */
@@ -404,9 +399,6 @@ <T> DocumentDeleteEntity<T> deleteDocument(String key, Class<T> type, DocumentDe
 	 *      Documentation</a>
 	 * @param values
 	 *            The keys of the documents or the documents themselves
-	 * @param type
-	 *            The type of the documents (POJO class, VPackSlice or String for JSON). Only necessary if
-	 *            options.returnOld is set to true, otherwise can be null.
 	 * @return information about the documents
 	 * @throws ArangoDBException
 	 */

src/main/java/com/arangodb/ArangoDB.java

@@ -603,9 +603,10 @@ public synchronized ArangoDB build() {
 			final ArangoSerialization custom = customSerializer != null ? customSerializer : internal;
 			final ArangoSerializationFactory util = new ArangoSerializationFactory(internal, custom);
 
-			final int max = maxConnections != null ? Math.max(1, maxConnections)
-					: protocol == Protocol.VST ? ArangoDefaults.MAX_CONNECTIONS_VST_DEFAULT
-							: ArangoDefaults.MAX_CONNECTIONS_HTTP_DEFAULT;
+			int protocolMaxConnections = protocol == Protocol.VST ?
+					ArangoDefaults.MAX_CONNECTIONS_VST_DEFAULT :
+					ArangoDefaults.MAX_CONNECTIONS_HTTP_DEFAULT;
+			final int max = maxConnections != null ? Math.max(1, maxConnections) : protocolMaxConnections;
 
 			final ConnectionFactory connectionFactory = (protocol == null || Protocol.VST == protocol)
 					? new VstConnectionFactorySync(host, timeout, connectionTtl, useSsl, sslContext)
@@ -688,7 +689,7 @@ public synchronized ArangoDB build() {
 	 *      Documentation</a>
 	 * @param user
 	 *            The name of the user for which you want to query the databases
-	 * @return
+	 * @return list of database names which are available for the specified user
 	 * @throws ArangoDBException
 	 */
 	Collection<String> getAccessibleDatabasesFor(String user) throws ArangoDBException;

src/main/java/com/arangodb/ArangoDBException.java

@@ -29,26 +29,32 @@
 public class ArangoDBException extends RuntimeException {
 
 	private static final long serialVersionUID = 6165638002614173801L;
-	private ErrorEntity entity = null;
-	private Integer responseCode;
+	private final ErrorEntity entity;
+	private final Integer responseCode;
 
 	public ArangoDBException(final ErrorEntity errorEntity) {
 		super(String.format("Response: %s, Error: %s - %s", errorEntity.getCode(), errorEntity.getErrorNum(),
 			errorEntity.getErrorMessage()));
 		this.entity = errorEntity;
+		this.responseCode = null;
 	}
 
 	public ArangoDBException(final String message) {
 		super(message);
+		this.entity = null;
+		this.responseCode = null;
 	}
 
 	public ArangoDBException(final String message, final Integer responseCode) {
 		super(message);
+		this.entity = null;
 		this.responseCode = responseCode;
 	}
 
 	public ArangoDBException(final Throwable cause) {
 		super(cause);
+		this.entity = null;
+		this.responseCode = null;
 	}
 
 	/**
@@ -69,7 +75,8 @@ public String getException() {
 	 * @return HTTP response code
 	 */
 	public Integer getResponseCode() {
-		return responseCode != null ? responseCode : entity != null ? entity.getCode() : null;
+		Integer entityResponseCode = entity != null ? entity.getCode() : null;
+		return responseCode != null ? responseCode : entityResponseCode;
 	}
 
 	/**

src/main/java/com/arangodb/ArangoEdgeCollection.java

@@ -109,7 +109,7 @@ public interface ArangoEdgeCollection extends ArangoSerializationAccessor {
 	 * @see <a href="https://docs.arangodb.com/current/HTTP/Gharial/Edges.html#replace-an-edge">API Documentation</a>
 	 * @param key
 	 *            The key of the edge
-	 * @param type
+	 * @param <T>
 	 *            The type of the edge-document (POJO class, VPackSlice or String for JSON)
 	 * @return information about the edge
 	 * @throws ArangoDBException
@@ -123,7 +123,7 @@ public interface ArangoEdgeCollection extends ArangoSerializationAccessor {
 	 * @see <a href="https://docs.arangodb.com/current/HTTP/Gharial/Edges.html#replace-an-edge">API Documentation</a>
 	 * @param key
 	 *            The key of the edge
-	 * @param type
+	 * @param <T>
 	 *            The type of the edge-document (POJO class, VPackSlice or String for JSON)
 	 * @param options
 	 *            Additional options, can be null
@@ -140,7 +140,7 @@ public interface ArangoEdgeCollection extends ArangoSerializationAccessor {
 	 * @see <a href="https://docs.arangodb.com/current/HTTP/Gharial/Edges.html#modify-an-edge">API Documentation</a>
 	 * @param key
 	 *            The key of the edge
-	 * @param type
+	 * @param <T>
 	 *            The type of the edge-document (POJO class, VPackSlice or String for JSON)
 	 * @return information about the edge
 	 * @throws ArangoDBException
@@ -155,7 +155,7 @@ public interface ArangoEdgeCollection extends ArangoSerializationAccessor {
 	 * @see <a href="https://docs.arangodb.com/current/HTTP/Gharial/Edges.html#modify-an-edge">API Documentation</a>
 	 * @param key
 	 *            The key of the edge
-	 * @param type
+	 * @param <T>
 	 *            The type of the edge-document (POJO class, VPackSlice or String for JSON)
 	 * @param options
 	 *            Additional options, can be null

src/main/java/com/arangodb/ArangoGraph.java

@@ -39,14 +39,14 @@ public interface ArangoGraph extends ArangoSerializationAccessor {
 	 *
 	 * @return database handler
 	 */
-	public ArangoDatabase db();
+	ArangoDatabase db();
 
 	/**
 	 * The name of the collection
 	 *
 	 * @return collection name
 	 */
-	public String name();
+	String name();
 
 	/**
 	 * Checks whether the graph exists

src/main/java/com/arangodb/ArangoVertexCollection.java

@@ -152,7 +152,7 @@ public interface ArangoVertexCollection extends ArangoSerializationAccessor {
 	 * @see <a href="https://docs.arangodb.com/current/HTTP/Gharial/Vertices.html#modify-a-vertex">API Documentation</a>
 	 * @param key
 	 *            The key of the vertex
-	 * @param type
+	 * @param <T>
 	 *            The type of the vertex-document (POJO class, VPackSlice or String for JSON)
 	 * @return information about the vertex
 	 * @throws ArangoDBException
@@ -167,7 +167,7 @@ public interface ArangoVertexCollection extends ArangoSerializationAccessor {
 	 * @see <a href="https://docs.arangodb.com/current/HTTP/Gharial/Vertices.html#modify-a-vertex">API Documentation</a>
 	 * @param key
 	 *            The key of the vertex
-	 * @param type
+	 * @param <T>
 	 *            The type of the vertex-document (POJO class, VPackSlice or String for JSON)
 	 * @param options
 	 *            Additional options, can be null

src/main/java/com/arangodb/ArangoView.java

@@ -36,14 +36,14 @@ public interface ArangoView extends ArangoSerializationAccessor {
 	 * 
 	 * @return database handler
 	 */
-	public ArangoDatabase db();
+	ArangoDatabase db();
 
 	/**
 	 * The name of the view
 	 * 
 	 * @return view name
 	 */
-	public String name();
+	String name();
 
 	/**
 	 * Checks whether the view exists.

src/main/java/com/arangodb/entity/CollectionStatus.java

@@ -1,50 +1,50 @@
-/*
- * DISCLAIMER
- *
- * Copyright 2016 ArangoDB GmbH, Cologne, Germany
- *
- * 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.
- *
- * Copyright holder is ArangoDB GmbH, Cologne, Germany
- */
-
-package com.arangodb.entity;
-
-/**
- * @author Mark Vollmary
- *
- */
-public enum CollectionStatus {
-
-	NEW_BORN_COLLECTION(1), UNLOADED(2), LOADED(3), IN_THE_PROCESS_OF_BEING_UNLOADED(4), DELETED(5);
-
-	private final int status;
-
-	private CollectionStatus(final int status) {
-		this.status = status;
-	}
-
-	public int getStatus() {
-		return status;
-	}
-
-	public static CollectionStatus fromStatus(final int status) {
-		for (final CollectionStatus cStatus : CollectionStatus.values()) {
-			if (cStatus.status == status) {
-				return cStatus;
-			}
-		}
-		return null;
-	}
-
-}
+/*
+ * DISCLAIMER
+ *
+ * Copyright 2016 ArangoDB GmbH, Cologne, Germany
+ *
+ * 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.
+ *
+ * Copyright holder is ArangoDB GmbH, Cologne, Germany
+ */
+
+package com.arangodb.entity;
+
+/**
+ * @author Mark Vollmary
+ *
+ */
+public enum CollectionStatus {
+
+	NEW_BORN_COLLECTION(1), UNLOADED(2), LOADED(3), IN_THE_PROCESS_OF_BEING_UNLOADED(4), DELETED(5);
+
+	private final int status;
+
+	CollectionStatus(final int status) {
+		this.status = status;
+	}
+
+	public int getStatus() {
+		return status;
+	}
+
+	public static CollectionStatus fromStatus(final int status) {
+		for (final CollectionStatus cStatus : CollectionStatus.values()) {
+			if (cStatus.status == status) {
+				return cStatus;
+			}
+		}
+		return null;
+	}
+
+}

src/main/java/com/arangodb/entity/CollectionType.java

@@ -1,49 +1,49 @@
-/*
- * DISCLAIMER
- *
- * Copyright 2016 ArangoDB GmbH, Cologne, Germany
- *
- * 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.
- *
- * Copyright holder is ArangoDB GmbH, Cologne, Germany
- */
-
-package com.arangodb.entity;
-
-/**
- * @author Mark Vollmary
- *
- */
-public enum CollectionType {
-
-	DOCUMENT(2), EDGES(3);
-
-	private final int type;
-
-	private CollectionType(final int type) {
-		this.type = type;
-	}
-
-	public int getType() {
-		return type;
-	}
-
-	public static CollectionType fromType(final int type) {
-		for (final CollectionType cType : CollectionType.values()) {
-			if (cType.type == type) {
-				return cType;
-			}
-		}
-		return null;
-	}
-}
+/*
+ * DISCLAIMER
+ *
+ * Copyright 2016 ArangoDB GmbH, Cologne, Germany
+ *
+ * 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.
+ *
+ * Copyright holder is ArangoDB GmbH, Cologne, Germany
+ */
+
+package com.arangodb.entity;
+
+/**
+ * @author Mark Vollmary
+ *
+ */
+public enum CollectionType {
+
+	DOCUMENT(2), EDGES(3);
+
+	private final int type;
+
+	CollectionType(final int type) {
+		this.type = type;
+	}
+
+	public int getType() {
+		return type;
+	}
+
+	public static CollectionType fromType(final int type) {
+		for (final CollectionType cType : CollectionType.values()) {
+			if (cType.type == type) {
+				return cType;
+			}
+		}
+		return null;
+	}
+}

src/main/java/com/arangodb/entity/ErrorEntity.java

@@ -48,7 +48,6 @@ public String getErrorMessage() {
 
 	/**
 	 * @return the exception message, passed when transaction fails
-	 * @return
 	 */
 	public String getException() {
 		return exception;