From e4db4219e04eea6d45ecb66eb1dbd56af7040ed7 Mon Sep 17 00:00:00 2001
From: pinpong <o.nitzschke@gmail.com>
Date: Sun, 12 Feb 2017 23:18:51 +0100
Subject: [PATCH] documentation

---
 .../jota/dto/request/IotaAttachToTangleRequest.java    |  4 ++++
 .../dto/request/IotaBroadcastTransactionRequest.java   |  3 +++
 src/main/java/jota/dto/request/IotaCommandRequest.java |  3 +++
 .../jota/dto/request/IotaFindTransactionsRequest.java  |  3 +++
 .../java/jota/dto/request/IotaGetBalancesRequest.java  |  3 +++
 .../jota/dto/request/IotaGetInclusionStateRequest.java |  3 +++
 .../request/IotaGetTransactionsToApproveRequest.java   |  3 +++
 .../java/jota/dto/request/IotaGetTrytesRequest.java    |  3 +++
 .../java/jota/dto/request/IotaNeighborsRequest.java    |  3 +++
 .../jota/dto/request/IotaStoreTransactionsRequest.java |  4 ++++
 src/main/java/jota/dto/response/AbstractResponse.java  |  3 +++
 .../java/jota/dto/response/AddNeighborsResponse.java   |  3 +++
 .../jota/dto/response/AnalyzeTransactionResponse.java  |  3 +++
 .../dto/response/BroadcastTransactionsResponse.java    |  3 +++
 .../jota/dto/response/FindTransactionResponse.java     |  3 +++
 .../jota/dto/response/GetAttachToTangleResponse.java   |  3 +++
 .../dto/response/GetBalancesAndFormatResponse.java     |  3 +++
 .../java/jota/dto/response/GetBalancesResponse.java    |  3 +++
 src/main/java/jota/dto/response/GetBundleResponse.java |  3 +++
 .../jota/dto/response/GetInclusionStateResponse.java   |  3 +++
 .../java/jota/dto/response/GetMilestoneResponse.java   | 10 ----------
 .../java/jota/dto/response/GetNeighborsResponse.java   |  3 +++
 .../java/jota/dto/response/GetNewAddressResponse.java  |  3 +++
 .../java/jota/dto/response/GetNodeInfoResponse.java    |  3 +++
 src/main/java/jota/dto/response/GetTipsResponse.java   |  3 +++
 .../dto/response/GetTransactionsToApproveResponse.java |  3 +++
 .../java/jota/dto/response/GetTransferResponse.java    |  4 ++--
 src/main/java/jota/dto/response/GetTrytesResponse.java |  3 +++
 .../response/InterruptAttachingToTangleResponse.java   |  3 +++
 .../jota/dto/response/RemoveNeighborsResponse.java     |  3 +++
 .../java/jota/dto/response/ReplayBundleResponse.java   |  4 ++--
 .../java/jota/dto/response/SendTransferResponse.java   |  4 ++--
 .../jota/dto/response/StoreTransactionsResponse.java   |  3 +++
 33 files changed, 95 insertions(+), 16 deletions(-)
 delete mode 100644 src/main/java/jota/dto/response/GetMilestoneResponse.java

diff --git a/src/main/java/jota/dto/request/IotaAttachToTangleRequest.java b/src/main/java/jota/dto/request/IotaAttachToTangleRequest.java
index 8d50a54..6767a33 100644
--- a/src/main/java/jota/dto/request/IotaAttachToTangleRequest.java
+++ b/src/main/java/jota/dto/request/IotaAttachToTangleRequest.java
@@ -2,6 +2,10 @@ package jota.dto.request;
 
 import jota.IotaAPICommands;
 
+/**
+ * This class represents the core API request 'attachToTangle'.
+ * It is used to attach trytes to the tangle.
+ **/
 public class IotaAttachToTangleRequest extends IotaCommandRequest {
 
     private String trunkTransaction;
diff --git a/src/main/java/jota/dto/request/IotaBroadcastTransactionRequest.java b/src/main/java/jota/dto/request/IotaBroadcastTransactionRequest.java
index 5a0a5d5..e416151 100644
--- a/src/main/java/jota/dto/request/IotaBroadcastTransactionRequest.java
+++ b/src/main/java/jota/dto/request/IotaBroadcastTransactionRequest.java
@@ -2,6 +2,9 @@ package jota.dto.request;
 
 import jota.IotaAPICommands;
 
+/**
+ * Broadcast a list of transactions to all neighbors. The input trytes for this call are provided by attachToTangle
+ **/
 public class IotaBroadcastTransactionRequest extends IotaCommandRequest {
 
     private String[] trytes;
diff --git a/src/main/java/jota/dto/request/IotaCommandRequest.java b/src/main/java/jota/dto/request/IotaCommandRequest.java
index 3f914a0..261797e 100644
--- a/src/main/java/jota/dto/request/IotaCommandRequest.java
+++ b/src/main/java/jota/dto/request/IotaCommandRequest.java
@@ -2,6 +2,9 @@ package jota.dto.request;
 
 import jota.IotaAPICommands;
 
+/**
+ * This class represents the core api request 'getNodeInfo', 'getNeighbors' and 'interruptAttachToTangle'
+ **/
 public class IotaCommandRequest {
 
     final String command;
diff --git a/src/main/java/jota/dto/request/IotaFindTransactionsRequest.java b/src/main/java/jota/dto/request/IotaFindTransactionsRequest.java
index 04da886..c3c92cb 100644
--- a/src/main/java/jota/dto/request/IotaFindTransactionsRequest.java
+++ b/src/main/java/jota/dto/request/IotaFindTransactionsRequest.java
@@ -2,6 +2,9 @@ package jota.dto.request;
 
 import jota.IotaAPICommands;
 
+/**
+ * This class represents the core api request 'findTransactions'
+ **/
 public class IotaFindTransactionsRequest extends IotaCommandRequest {
 
     private String[] bundles; // List of bundle hashes. The hashes need to be extended to 81chars by padding the hash with 9's.
diff --git a/src/main/java/jota/dto/request/IotaGetBalancesRequest.java b/src/main/java/jota/dto/request/IotaGetBalancesRequest.java
index 33d760d..c71105d 100644
--- a/src/main/java/jota/dto/request/IotaGetBalancesRequest.java
+++ b/src/main/java/jota/dto/request/IotaGetBalancesRequest.java
@@ -2,6 +2,9 @@ package jota.dto.request;
 
 import jota.IotaAPICommands;
 
+/**
+ * This class represents the core api request 'getBalances'
+ **/
 public class IotaGetBalancesRequest extends IotaCommandRequest {
 
     private String[] addresses;
diff --git a/src/main/java/jota/dto/request/IotaGetInclusionStateRequest.java b/src/main/java/jota/dto/request/IotaGetInclusionStateRequest.java
index 704806e..30eb870 100644
--- a/src/main/java/jota/dto/request/IotaGetInclusionStateRequest.java
+++ b/src/main/java/jota/dto/request/IotaGetInclusionStateRequest.java
@@ -4,6 +4,9 @@ import jota.IotaAPICommands;
 
 import java.util.Collection;
 
+/**
+ * This class represents the core API request 'getInclusionStates'
+ **/
 public class IotaGetInclusionStateRequest extends IotaCommandRequest {
 
     private String[] transactions;
diff --git a/src/main/java/jota/dto/request/IotaGetTransactionsToApproveRequest.java b/src/main/java/jota/dto/request/IotaGetTransactionsToApproveRequest.java
index fb1b367..7d8d090 100644
--- a/src/main/java/jota/dto/request/IotaGetTransactionsToApproveRequest.java
+++ b/src/main/java/jota/dto/request/IotaGetTransactionsToApproveRequest.java
@@ -2,6 +2,9 @@ package jota.dto.request;
 
 import jota.IotaAPICommands;
 
+/**
+ * This class represents the core API request 'getTransactionsToApprove'
+ **/
 public class IotaGetTransactionsToApproveRequest extends IotaCommandRequest {
 
     private Integer depth;
diff --git a/src/main/java/jota/dto/request/IotaGetTrytesRequest.java b/src/main/java/jota/dto/request/IotaGetTrytesRequest.java
index eaa5888..fa33cba 100644
--- a/src/main/java/jota/dto/request/IotaGetTrytesRequest.java
+++ b/src/main/java/jota/dto/request/IotaGetTrytesRequest.java
@@ -2,6 +2,9 @@ package jota.dto.request;
 
 import jota.IotaAPICommands;
 
+/**
+ * This class represents the core API request 'getTrytes'
+ **/
 public class IotaGetTrytesRequest extends IotaCommandRequest {
 
     private String[] hashes;
diff --git a/src/main/java/jota/dto/request/IotaNeighborsRequest.java b/src/main/java/jota/dto/request/IotaNeighborsRequest.java
index c81c491..9edd43f 100644
--- a/src/main/java/jota/dto/request/IotaNeighborsRequest.java
+++ b/src/main/java/jota/dto/request/IotaNeighborsRequest.java
@@ -2,6 +2,9 @@ package jota.dto.request;
 
 import jota.IotaAPICommands;
 
+/**
+ * This class represents the core API request 'addNeighbors' and 'removeNeighbors'
+ **/
 public class IotaNeighborsRequest extends IotaCommandRequest {
 
     private String[] uris;
diff --git a/src/main/java/jota/dto/request/IotaStoreTransactionsRequest.java b/src/main/java/jota/dto/request/IotaStoreTransactionsRequest.java
index 1b9c55b..67baa29 100644
--- a/src/main/java/jota/dto/request/IotaStoreTransactionsRequest.java
+++ b/src/main/java/jota/dto/request/IotaStoreTransactionsRequest.java
@@ -2,6 +2,10 @@ package jota.dto.request;
 
 import jota.IotaAPICommands;
 
+/**
+ * This class represents the core API request 'getTransactionsToApprove'
+ * It stores transactions into the local storage. The trytes to be used for this call are returned by attachToTangle.
+ **/
 public class IotaStoreTransactionsRequest extends IotaCommandRequest {
 
     private String[] trytes;
diff --git a/src/main/java/jota/dto/response/AbstractResponse.java b/src/main/java/jota/dto/response/AbstractResponse.java
index e93ee07..752ab90 100644
--- a/src/main/java/jota/dto/response/AbstractResponse.java
+++ b/src/main/java/jota/dto/response/AbstractResponse.java
@@ -5,6 +5,9 @@ import org.apache.commons.lang3.builder.HashCodeBuilder;
 import org.apache.commons.lang3.builder.ToStringBuilder;
 import org.apache.commons.lang3.builder.ToStringStyle;
 
+/**
+ * Abstract response.
+ */
 public abstract class AbstractResponse {
 
     private Long duration;
diff --git a/src/main/java/jota/dto/response/AddNeighborsResponse.java b/src/main/java/jota/dto/response/AddNeighborsResponse.java
index 586f5a2..5583132 100644
--- a/src/main/java/jota/dto/response/AddNeighborsResponse.java
+++ b/src/main/java/jota/dto/response/AddNeighborsResponse.java
@@ -1,5 +1,8 @@
 package jota.dto.response;
 
+/**
+ * Response of {@link jota.dto.request.IotaNeighborsRequest}
+ **/
 public class AddNeighborsResponse extends AbstractResponse {
 
     private int addedNeighbors;
diff --git a/src/main/java/jota/dto/response/AnalyzeTransactionResponse.java b/src/main/java/jota/dto/response/AnalyzeTransactionResponse.java
index 08c56cf..d7154d3 100644
--- a/src/main/java/jota/dto/response/AnalyzeTransactionResponse.java
+++ b/src/main/java/jota/dto/response/AnalyzeTransactionResponse.java
@@ -5,6 +5,9 @@ import jota.model.Transaction;
 import java.util.ArrayList;
 import java.util.List;
 
+/**
+ * Response of {@link jota.dto.request.IotaGetBalancesRequest}
+ **/
 public class AnalyzeTransactionResponse extends AbstractResponse {
 
     private List<Transaction> transactions = new ArrayList<>();
diff --git a/src/main/java/jota/dto/response/BroadcastTransactionsResponse.java b/src/main/java/jota/dto/response/BroadcastTransactionsResponse.java
index fe4d7cd..f7c2e0d 100644
--- a/src/main/java/jota/dto/response/BroadcastTransactionsResponse.java
+++ b/src/main/java/jota/dto/response/BroadcastTransactionsResponse.java
@@ -1,5 +1,8 @@
 package jota.dto.response;
 
+/**
+ * Response of {@link jota.dto.request.IotaBroadcastTransactionRequest}
+ **/
 public class BroadcastTransactionsResponse extends AbstractResponse {
     // empty response
 }
diff --git a/src/main/java/jota/dto/response/FindTransactionResponse.java b/src/main/java/jota/dto/response/FindTransactionResponse.java
index 1991e86..a590b46 100644
--- a/src/main/java/jota/dto/response/FindTransactionResponse.java
+++ b/src/main/java/jota/dto/response/FindTransactionResponse.java
@@ -1,5 +1,8 @@
 package jota.dto.response;
 
+/**
+ * Response of {@link jota.dto.request.IotaFindTransactionsRequest}
+ **/
 public class FindTransactionResponse extends AbstractResponse {
 
     String[] hashes;
diff --git a/src/main/java/jota/dto/response/GetAttachToTangleResponse.java b/src/main/java/jota/dto/response/GetAttachToTangleResponse.java
index acbbc42..079a762 100644
--- a/src/main/java/jota/dto/response/GetAttachToTangleResponse.java
+++ b/src/main/java/jota/dto/response/GetAttachToTangleResponse.java
@@ -1,5 +1,8 @@
 package jota.dto.response;
 
+/**
+ * Response of {@link jota.dto.request.IotaAttachToTangleRequest}
+ **/
 public class GetAttachToTangleResponse extends AbstractResponse {
 
     private String[] trytes;
diff --git a/src/main/java/jota/dto/response/GetBalancesAndFormatResponse.java b/src/main/java/jota/dto/response/GetBalancesAndFormatResponse.java
index f06d27a..71ddb5e 100644
--- a/src/main/java/jota/dto/response/GetBalancesAndFormatResponse.java
+++ b/src/main/java/jota/dto/response/GetBalancesAndFormatResponse.java
@@ -4,6 +4,9 @@ import jota.model.Input;
 
 import java.util.List;
 
+/**
+ * Response of api request 'getBalancesAndFormatResponse'
+ **/
 public class GetBalancesAndFormatResponse extends AbstractResponse {
 
     private List<Input> input;
diff --git a/src/main/java/jota/dto/response/GetBalancesResponse.java b/src/main/java/jota/dto/response/GetBalancesResponse.java
index 0637f61..1de88bf 100644
--- a/src/main/java/jota/dto/response/GetBalancesResponse.java
+++ b/src/main/java/jota/dto/response/GetBalancesResponse.java
@@ -1,5 +1,8 @@
 package jota.dto.response;
 
+/**
+ * Response of {@link jota.dto.request.IotaGetBalancesRequest}
+ **/
 public class GetBalancesResponse extends AbstractResponse {
 
     private String[] balances;
diff --git a/src/main/java/jota/dto/response/GetBundleResponse.java b/src/main/java/jota/dto/response/GetBundleResponse.java
index c3dfa1b..b183ea0 100644
--- a/src/main/java/jota/dto/response/GetBundleResponse.java
+++ b/src/main/java/jota/dto/response/GetBundleResponse.java
@@ -5,6 +5,9 @@ import jota.model.Transaction;
 import java.util.ArrayList;
 import java.util.List;
 
+/**
+ * Response of api request 'getBundle
+ **/
 public class GetBundleResponse extends AbstractResponse {
 
     private List<Transaction> transactions = new ArrayList<>();
diff --git a/src/main/java/jota/dto/response/GetInclusionStateResponse.java b/src/main/java/jota/dto/response/GetInclusionStateResponse.java
index 5b60af9..856ff00 100644
--- a/src/main/java/jota/dto/response/GetInclusionStateResponse.java
+++ b/src/main/java/jota/dto/response/GetInclusionStateResponse.java
@@ -1,5 +1,8 @@
 package jota.dto.response;
 
+/**
+ * Response of {@link jota.dto.request.IotaGetInclusionStateRequest}
+ **/
 public class GetInclusionStateResponse extends AbstractResponse {
 
     boolean[] states;
diff --git a/src/main/java/jota/dto/response/GetMilestoneResponse.java b/src/main/java/jota/dto/response/GetMilestoneResponse.java
deleted file mode 100644
index 7e3ecbe..0000000
--- a/src/main/java/jota/dto/response/GetMilestoneResponse.java
+++ /dev/null
@@ -1,10 +0,0 @@
-package jota.dto.response;
-
-public class GetMilestoneResponse extends AbstractResponse {
-
-    private String milestone;
-
-    public String getMilestone() {
-        return milestone;
-    }
-}
diff --git a/src/main/java/jota/dto/response/GetNeighborsResponse.java b/src/main/java/jota/dto/response/GetNeighborsResponse.java
index 3740307..8191305 100644
--- a/src/main/java/jota/dto/response/GetNeighborsResponse.java
+++ b/src/main/java/jota/dto/response/GetNeighborsResponse.java
@@ -5,6 +5,9 @@ import jota.model.Neighbor;
 import java.util.ArrayList;
 import java.util.List;
 
+/**
+ * Response of {@link jota.dto.request.IotaCommandRequest}
+ **/
 public class GetNeighborsResponse extends AbstractResponse {
 
     private List<Neighbor> neighbors = new ArrayList<>();
diff --git a/src/main/java/jota/dto/response/GetNewAddressResponse.java b/src/main/java/jota/dto/response/GetNewAddressResponse.java
index 42d2288..aed7e98 100644
--- a/src/main/java/jota/dto/response/GetNewAddressResponse.java
+++ b/src/main/java/jota/dto/response/GetNewAddressResponse.java
@@ -2,6 +2,9 @@ package jota.dto.response;
 
 import java.util.List;
 
+/**
+ * Response of api request 'getNewAddress'
+ **/
 public class GetNewAddressResponse extends AbstractResponse {
 
     private List<String> addresses;
diff --git a/src/main/java/jota/dto/response/GetNodeInfoResponse.java b/src/main/java/jota/dto/response/GetNodeInfoResponse.java
index 233c0fb..b66fc44 100644
--- a/src/main/java/jota/dto/response/GetNodeInfoResponse.java
+++ b/src/main/java/jota/dto/response/GetNodeInfoResponse.java
@@ -1,5 +1,8 @@
 package jota.dto.response;
 
+/**
+ * Response of {@link jota.dto.request.IotaNeighborsRequest}
+ **/
 public class GetNodeInfoResponse extends AbstractResponse {
 
     private String appName;
diff --git a/src/main/java/jota/dto/response/GetTipsResponse.java b/src/main/java/jota/dto/response/GetTipsResponse.java
index e45fb7e..b6a0d0d 100644
--- a/src/main/java/jota/dto/response/GetTipsResponse.java
+++ b/src/main/java/jota/dto/response/GetTipsResponse.java
@@ -1,5 +1,8 @@
 package jota.dto.response;
 
+/**
+ * Response of {@link jota.dto.request.IotaCommandRequest}
+ **/
 public class GetTipsResponse extends AbstractResponse {
 
     private String[] hashes;
diff --git a/src/main/java/jota/dto/response/GetTransactionsToApproveResponse.java b/src/main/java/jota/dto/response/GetTransactionsToApproveResponse.java
index ba7d478..3354000 100644
--- a/src/main/java/jota/dto/response/GetTransactionsToApproveResponse.java
+++ b/src/main/java/jota/dto/response/GetTransactionsToApproveResponse.java
@@ -1,5 +1,8 @@
 package jota.dto.response;
 
+/**
+ * Response of {@link jota.dto.request.IotaGetTransactionsToApproveRequest}
+ **/
 public class GetTransactionsToApproveResponse extends AbstractResponse {
 
     private String trunkTransaction;
diff --git a/src/main/java/jota/dto/response/GetTransferResponse.java b/src/main/java/jota/dto/response/GetTransferResponse.java
index a4fc8da..ee8cf11 100644
--- a/src/main/java/jota/dto/response/GetTransferResponse.java
+++ b/src/main/java/jota/dto/response/GetTransferResponse.java
@@ -3,8 +3,8 @@ package jota.dto.response;
 import jota.model.Bundle;
 
 /**
- * Created by pinpong on 28.12.16.
- */
+ * Response of api request 'getTransfer'
+ **/
 public class GetTransferResponse extends AbstractResponse {
 
     private Bundle[] transferBundle;
diff --git a/src/main/java/jota/dto/response/GetTrytesResponse.java b/src/main/java/jota/dto/response/GetTrytesResponse.java
index e745caa..48101b5 100644
--- a/src/main/java/jota/dto/response/GetTrytesResponse.java
+++ b/src/main/java/jota/dto/response/GetTrytesResponse.java
@@ -1,5 +1,8 @@
 package jota.dto.response;
 
+/**
+ * Response of {@link jota.dto.request.IotaGetTrytesRequest}
+ **/
 public class GetTrytesResponse extends AbstractResponse {
 
     private String[] trytes;
diff --git a/src/main/java/jota/dto/response/InterruptAttachingToTangleResponse.java b/src/main/java/jota/dto/response/InterruptAttachingToTangleResponse.java
index c3dda35..ab0400d 100644
--- a/src/main/java/jota/dto/response/InterruptAttachingToTangleResponse.java
+++ b/src/main/java/jota/dto/response/InterruptAttachingToTangleResponse.java
@@ -1,5 +1,8 @@
 package jota.dto.response;
 
+/**
+ * Response of {@link jota.dto.request.IotaCommandRequest}
+ **/
 public class InterruptAttachingToTangleResponse extends AbstractResponse {
     // empty response
 }
diff --git a/src/main/java/jota/dto/response/RemoveNeighborsResponse.java b/src/main/java/jota/dto/response/RemoveNeighborsResponse.java
index 3f63730..51556fa 100644
--- a/src/main/java/jota/dto/response/RemoveNeighborsResponse.java
+++ b/src/main/java/jota/dto/response/RemoveNeighborsResponse.java
@@ -1,5 +1,8 @@
 package jota.dto.response;
 
+/**
+ * Response of {@link jota.dto.request.IotaNeighborsRequest}
+ **/
 public class RemoveNeighborsResponse extends AbstractResponse {
 
     private int removedNeighbors;
diff --git a/src/main/java/jota/dto/response/ReplayBundleResponse.java b/src/main/java/jota/dto/response/ReplayBundleResponse.java
index 2c60c6c..563d701 100644
--- a/src/main/java/jota/dto/response/ReplayBundleResponse.java
+++ b/src/main/java/jota/dto/response/ReplayBundleResponse.java
@@ -1,8 +1,8 @@
 package jota.dto.response;
 
 /**
- * Created by pinpong on 01.01.17.
- */
+ * Response of api request 'replayBundle'
+ **/
 public class ReplayBundleResponse extends AbstractResponse {
 
     private Boolean[] successfully;
diff --git a/src/main/java/jota/dto/response/SendTransferResponse.java b/src/main/java/jota/dto/response/SendTransferResponse.java
index d31b295..2422a14 100644
--- a/src/main/java/jota/dto/response/SendTransferResponse.java
+++ b/src/main/java/jota/dto/response/SendTransferResponse.java
@@ -1,8 +1,8 @@
 package jota.dto.response;
 
 /**
- * Created by pinpong on 28.12.16.
- */
+ * Response of api request 'sendTransfer'
+ **/
 public class SendTransferResponse extends AbstractResponse {
 
     private Boolean[] successfully;
diff --git a/src/main/java/jota/dto/response/StoreTransactionsResponse.java b/src/main/java/jota/dto/response/StoreTransactionsResponse.java
index af6c773..767048e 100644
--- a/src/main/java/jota/dto/response/StoreTransactionsResponse.java
+++ b/src/main/java/jota/dto/response/StoreTransactionsResponse.java
@@ -1,5 +1,8 @@
 package jota.dto.response;
 
+/**
+ * Response of {@link jota.dto.request.IotaStoreTransactionsRequest}
+ **/
 public class StoreTransactionsResponse extends AbstractResponse {
     public StoreTransactionsResponse(long duration) {
         setDuration(duration);