Merge branch 'dev' of https://github.com/iotaledger/iota.lib.java into dev

src/main/java/jota/IotaAPICore.java

@@ -20,7 +20,8 @@ import java.util.Properties;
 import java.util.concurrent.TimeUnit;
 
 /**
- * Created by Adrian on 15.01.2017.
+ * This class provides access to the Iota core API
+ * @author Adrian
  */
 public class IotaAPICore {
 

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

src/main/java/jota/error/ArgumentException.java

@@ -1,7 +1,7 @@
 package jota.error;
 
 /**
- * Created by Adrian on 09.12.2016.
+ * @author Adrian
  */
 public class ArgumentException extends BaseException {
 

src/main/java/jota/error/BaseException.java

@@ -5,7 +5,7 @@ import java.util.Arrays;
 import java.util.Collection;
 
 /**
- * Created by Adrian on 09.12.2016.
+ * @author Adrian
  */
 public class BaseException extends Exception {
 

src/main/java/jota/error/BroadcastAndStoreException.java

@@ -1,7 +1,7 @@
 package jota.error;
 
 /**
- * Created by Adrian on 22.01.2017.
+ * @author Adrian
  */
 public class BroadcastAndStoreException extends BaseException {
 

src/main/java/jota/error/InvalidAddressException.java

@@ -1,7 +1,7 @@
 package jota.error;
 
 /**
- * Created by pinpong on 05.02.17.
+ * @author Adrian
  */
 public class InvalidAddressException extends BaseException {
     public InvalidAddressException() {

src/main/java/jota/error/InvalidBundleException.java

@@ -1,7 +1,7 @@
 package jota.error;
 
 /**
- * Created by Adrian on 27.12.2016.
+ * @author Adrian
  */
 public class InvalidBundleException extends BaseException {
 

src/main/java/jota/error/InvalidSecurityLevelException.java

@@ -1,7 +1,7 @@
 package jota.error;
 
 /**
- * Created by pinpong on 02.02.17.
+ * @author pinpong
  */
 public class InvalidSecurityLevelException extends BaseException {
 

src/main/java/jota/error/InvalidSignatureException.java

@@ -1,7 +1,7 @@
 package jota.error;
 
 /**
- * Created by Adrian on 27.12.2016.
+ * @author Adrian
  */
 public class InvalidSignatureException extends BaseException {
     public InvalidSignatureException() {

src/main/java/jota/error/InvalidTransferException.java

@@ -1,7 +1,7 @@
 package jota.error;
 
 /**
- * Created by pinpong on 05.02.17.
+ * @author pinpong
  */
 public class InvalidTransferException extends BaseException {
     public InvalidTransferException() {

src/main/java/jota/error/InvalidTrytesException.java

@@ -1,7 +1,7 @@
 package jota.error;
 
 /**
- * Created by Adrian on 04.02.2017.
+ * @author Adrian
  */
 public class InvalidTrytesException extends BaseException {
 

src/main/java/jota/error/NoInclusionStatesExcpection.java

@@ -1,7 +1,7 @@
 package jota.error;
 
 /**
- * Created by Adrian on 22.01.2017.
+ * @author Adrian
  */
 public class NoInclusionStatesExcpection extends BaseException {
 

src/main/java/jota/error/NoNodeInfoException.java

@@ -1,7 +1,7 @@
 package jota.error;
 
 /**
- * Created by Adrian on 22.01.2017.
+ * @author Adrian
  */
 public class NoNodeInfoException extends BaseException {
 

src/main/java/jota/error/NotEnoughBalanceException.java

@@ -1,7 +1,7 @@
 package jota.error;
 
 /**
- * Created by Adrian on 09.12.2016.
+ * @author Adrian
  */
 public class NotEnoughBalanceException extends BaseException {
 

src/main/java/jota/model/Bundle.java

@@ -10,8 +10,9 @@ import java.util.List;
 
 
 /**
- * Created by pinpong on 09.12.16.
- */
+ * This class represents a Bundle, a set of transactions
+ * @author pinpong
+ **/
 public class Bundle implements Comparable<Bundle> {
 
     public static String EMPTY_HASH = "999999999999999999999999999999999999999999999999999999999999999999999999999999999";

src/main/java/jota/model/Input.java

@@ -4,8 +4,9 @@ import org.apache.commons.lang3.builder.ToStringBuilder;
 import org.apache.commons.lang3.builder.ToStringStyle;
 
 /**
- * Created by Adrian on 09.12.2016.
- */
+ * This class represents an Input
+ * @author Adrian
+ **/
 public class Input {
     private String address;
     private long balance;

src/main/java/jota/model/Inputs.java

@@ -5,8 +5,9 @@ import com.google.gson.Gson;
 import java.util.List;
 
 /**
- * Created by Adrian on 09.12.2016.
- */
+ * This class represents an Inputs
+ *  @author Adrian
+ **/
 public class Inputs {
     private List<Input> inputsList;
     private long totalBalance;

src/main/java/jota/model/Neighbor.java

@@ -1,8 +1,9 @@
 package jota.model;
 
 /**
- * Created by pinpong on 02.12.16.
- */
+ * This class represents an Neighbor
+ * @author pinpong
+ **/
 public class Neighbor {
 
     private String address;

src/main/java/jota/model/Signature.java

@@ -4,8 +4,9 @@ import java.util.ArrayList;
 import java.util.List;
 
 /**
- * Created by Adrian on 27.12.2016.
- */
+ * This class represents an Signature
+ * @author Adrian
+ **/
 public class Signature {
 
     String address;

src/main/java/jota/model/Transaction.java

@@ -12,7 +12,8 @@ import org.slf4j.LoggerFactory;
 import java.util.Arrays;
 
 /**
- * Created by pinpong on 02.12.16.
+ * This class represents an iota transaction
+ * @author pinpong
  */
 public class Transaction {
     private static final Logger log = LoggerFactory.getLogger(Transaction.class);

src/main/java/jota/model/Transfer.java

@@ -3,7 +3,8 @@ package jota.model;
 import com.google.gson.Gson;
 
 /**
- * Created by pinpong on 02.12.16.
+ * This class represents a Transfer
+ * @author pinpong
  */
 public class Transfer {
 

src/main/java/jota/pow/ICurl.java

@@ -1,7 +1,7 @@
 package jota.pow;
 
 /**
- * Created by Adrian on 07.01.2017.
+ * @author Adrian
  */
 public interface ICurl {
     ICurl absorb(final int[] trits, int offset, int length);

src/main/java/jota/utils/Checksum.java

@@ -4,7 +4,8 @@ import jota.error.InvalidAddressException;
 import jota.pow.JCurl;
 
 /**
- * Created by pinpong on 02.12.16.
+ * This class defines utility methods to add/remove the checksum to/from an address
+ * @author pinpong
  */
 public class Checksum {
 

src/main/java/jota/utils/Constants.java

@@ -1,7 +1,8 @@
 package jota.utils;
 
 /**
- * Created by pinpong on 02.12.16.
+ * This class defines the global constants
+ * @author pinpong
  */
 public class Constants {
 

src/main/java/jota/utils/InputValidator.java

@@ -8,7 +8,8 @@ import org.apache.commons.lang3.math.NumberUtils;
 import java.util.List;
 
 /**
- * Created by pinpong on 02.12.16.
+ * This class provides methods to validate the parameters of different iota API methods
+ * @author pinpong
  */
 public class InputValidator {
 

src/main/java/jota/utils/IotaUnitConverter.java

@@ -3,7 +3,8 @@ package jota.utils;
 import java.text.DecimalFormat;
 
 /**
- * Created by Sascha on 30.11.16.
+ * This class provides methods to convert Iota to different units
+ * @author sascha
  */
 public class IotaUnitConverter {
 

src/main/java/jota/utils/IotaUnits.java

@@ -2,6 +2,7 @@ package jota.utils;
 
 /**
  * Table of IOTA units based off of the standard system of Units
+ * @author pinpong
  **/
 public enum IotaUnits {
 

src/main/java/jota/utils/Multisig.java

@@ -7,7 +7,7 @@ import jota.pow.JCurl;
 import java.util.Arrays;
 
 /**
- * Created by pinpong on 02.02.17.
+ * @author pinpong
  */
 public class Multisig {
 

src/main/java/jota/utils/NamedThreadFactory.java

@@ -5,7 +5,7 @@ import java.util.concurrent.ThreadFactory;
 import java.util.concurrent.atomic.AtomicInteger;
 
 /**
- * Created by Adrian on 15.01.2017.
+ * @author Adrian
  */
 public class NamedThreadFactory implements ThreadFactory {
     private final String baseName;

src/main/java/jota/utils/Parallel.java

@@ -8,7 +8,7 @@ import java.util.concurrent.ExecutorService;
 import java.util.concurrent.Executors;
 
 /**
- * Created by Adrian on 15.01.2017.
+ * @author Adrian
  */
 public class Parallel {
     private static final int NUM_CORES = Runtime.getRuntime().availableProcessors();

src/main/java/jota/utils/SeedRandomGenerator.java

@@ -3,7 +3,8 @@ package jota.utils;
 import java.security.SecureRandom;
 
 /**
- * Created by pinpong on 13.12.16.
+ * This class allows to create a secure random generated seed
+ * @author pinpong
  */
 public class SeedRandomGenerator {
 

src/main/java/jota/utils/StopWatch.java

@@ -1,7 +1,7 @@
 package jota.utils;
 
 /**
- * Created by Adrian on 15.01.2017.
+ * @author adrian
  */
 public class StopWatch {
     private long startTime = 0;

src/main/java/jota/utils/TrytesConverter.java

@@ -1,7 +1,8 @@
 package jota.utils;
 
 /**
- * Created by pinpong on 01.12.16.
+ * This class allows to convert between ASCII and tryte encoded strings
+ * @author pinpong
  */
 public class TrytesConverter {
 

src/test/java/jota/ChecksumTest.java

@@ -7,7 +7,7 @@ import org.junit.Test;
 import static org.junit.Assert.assertEquals;
 
 /**
- * Created by pinpong on 02.12.16.
+ * @author pinpong
  */
 public class ChecksumTest {
 

src/test/java/jota/InputValidatorTest.java

@@ -11,7 +11,7 @@ import java.util.List;
 import static org.junit.Assert.assertEquals;
 
 /**
- * Created by pinpong on 02.12.16.
+ * @author pinpong
  */
 public class InputValidatorTest {
 

src/test/java/jota/IotaCoreApiTest.java

@@ -9,7 +9,7 @@ import org.junit.Test;
 import static org.junit.Assert.assertThat;
 
 /**
- * Created by Adrian on 15.01.2017.
+ * @author Adrian
  */
 public class IotaCoreApiTest {
 

src/test/java/jota/IotaUnitConverterTest.java

@@ -7,7 +7,7 @@ import org.junit.Test;
 import static org.junit.Assert.assertEquals;
 
 /**
- * Created by pinpong on 30.11.16.
+ * @author pinpong
  */
 public class IotaUnitConverterTest {
 

src/test/java/jota/SeedRandomGeneratorTest.java

@@ -8,7 +8,7 @@ import org.junit.Test;
 import static org.junit.Assert.assertEquals;
 
 /**
- * Created by pinpong on 13.12.16.
+ * @author pinpong
  */
 public class SeedRandomGeneratorTest {
 

src/test/java/jota/TrytesConverterTest.java

@@ -8,7 +8,7 @@ import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertTrue;
 
 /**
- * Created by pinpong on 01.12.16.
+ * @author pinpong
  */
 public class TrytesConverterTest {