documentation

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;

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;

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;

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.

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;

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;

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;

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;

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;

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;

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;

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;

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<>();

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
 }

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;

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;

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;

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;

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<>();

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;

src/main/java/jota/dto/response/GetMilestoneResponse.java

@@ -1,10 +0,0 @@
-package jota.dto.response;
-
-public class GetMilestoneResponse extends AbstractResponse {
-
-    private String milestone;
-
-    public String getMilestone() {
-        return milestone;
-    }
-}

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<>();

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;

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;

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;

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;

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;

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;

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
 }

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;

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;

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;

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);