diff --git a/src/main/java/jota/IotaAPICore.java b/src/main/java/jota/IotaAPICore.java index 51524a1..7264b46 100644 --- a/src/main/java/jota/IotaAPICore.java +++ b/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 { 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 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; 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 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 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 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); diff --git a/src/main/java/jota/error/ArgumentException.java b/src/main/java/jota/error/ArgumentException.java index 075d90e..fafb454 100644 --- a/src/main/java/jota/error/ArgumentException.java +++ b/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 { diff --git a/src/main/java/jota/error/BaseException.java b/src/main/java/jota/error/BaseException.java index 972a0ac..bbfd5ea 100644 --- a/src/main/java/jota/error/BaseException.java +++ b/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 { diff --git a/src/main/java/jota/error/BroadcastAndStoreException.java b/src/main/java/jota/error/BroadcastAndStoreException.java index a5b58e6..d5dbd52 100644 --- a/src/main/java/jota/error/BroadcastAndStoreException.java +++ b/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 { diff --git a/src/main/java/jota/error/InvalidAddressException.java b/src/main/java/jota/error/InvalidAddressException.java index 442babf..b410951 100644 --- a/src/main/java/jota/error/InvalidAddressException.java +++ b/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() { diff --git a/src/main/java/jota/error/InvalidBundleException.java b/src/main/java/jota/error/InvalidBundleException.java index 658011b..6d5017e 100644 --- a/src/main/java/jota/error/InvalidBundleException.java +++ b/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 { diff --git a/src/main/java/jota/error/InvalidSecurityLevelException.java b/src/main/java/jota/error/InvalidSecurityLevelException.java index 263ffbd..d000376 100644 --- a/src/main/java/jota/error/InvalidSecurityLevelException.java +++ b/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 { diff --git a/src/main/java/jota/error/InvalidSignatureException.java b/src/main/java/jota/error/InvalidSignatureException.java index d8d5565..9a30602 100644 --- a/src/main/java/jota/error/InvalidSignatureException.java +++ b/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() { diff --git a/src/main/java/jota/error/InvalidTransferException.java b/src/main/java/jota/error/InvalidTransferException.java index 20a6565..6d8e501 100644 --- a/src/main/java/jota/error/InvalidTransferException.java +++ b/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() { diff --git a/src/main/java/jota/error/InvalidTrytesException.java b/src/main/java/jota/error/InvalidTrytesException.java index 8977f2f..c610afb 100644 --- a/src/main/java/jota/error/InvalidTrytesException.java +++ b/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 { diff --git a/src/main/java/jota/error/NoInclusionStatesExcpection.java b/src/main/java/jota/error/NoInclusionStatesExcpection.java index c79ee4b..35fc61a 100644 --- a/src/main/java/jota/error/NoInclusionStatesExcpection.java +++ b/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 { diff --git a/src/main/java/jota/error/NoNodeInfoException.java b/src/main/java/jota/error/NoNodeInfoException.java index 920c6f3..4df4ff8 100644 --- a/src/main/java/jota/error/NoNodeInfoException.java +++ b/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 { diff --git a/src/main/java/jota/error/NotEnoughBalanceException.java b/src/main/java/jota/error/NotEnoughBalanceException.java index dfe44a1..a26d615 100644 --- a/src/main/java/jota/error/NotEnoughBalanceException.java +++ b/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 { diff --git a/src/main/java/jota/model/Bundle.java b/src/main/java/jota/model/Bundle.java index 7c02db5..a878fc7 100644 --- a/src/main/java/jota/model/Bundle.java +++ b/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 { public static String EMPTY_HASH = "999999999999999999999999999999999999999999999999999999999999999999999999999999999"; diff --git a/src/main/java/jota/model/Input.java b/src/main/java/jota/model/Input.java index ead850c..f1e005a 100644 --- a/src/main/java/jota/model/Input.java +++ b/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; diff --git a/src/main/java/jota/model/Inputs.java b/src/main/java/jota/model/Inputs.java index 5d4b993..1485d81 100644 --- a/src/main/java/jota/model/Inputs.java +++ b/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 inputsList; private long totalBalance; diff --git a/src/main/java/jota/model/Neighbor.java b/src/main/java/jota/model/Neighbor.java index 2eee719..fdd17ac 100644 --- a/src/main/java/jota/model/Neighbor.java +++ b/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; diff --git a/src/main/java/jota/model/Signature.java b/src/main/java/jota/model/Signature.java index 3e0a9ba..db5e12c 100644 --- a/src/main/java/jota/model/Signature.java +++ b/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; diff --git a/src/main/java/jota/model/Transaction.java b/src/main/java/jota/model/Transaction.java index 9b49bc8..b744040 100644 --- a/src/main/java/jota/model/Transaction.java +++ b/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); diff --git a/src/main/java/jota/model/Transfer.java b/src/main/java/jota/model/Transfer.java index 65cb8de..645d2c3 100644 --- a/src/main/java/jota/model/Transfer.java +++ b/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 { diff --git a/src/main/java/jota/pow/ICurl.java b/src/main/java/jota/pow/ICurl.java index 877a16d..0933ab1 100644 --- a/src/main/java/jota/pow/ICurl.java +++ b/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); diff --git a/src/main/java/jota/utils/Checksum.java b/src/main/java/jota/utils/Checksum.java index bd2e542..e33bd21 100644 --- a/src/main/java/jota/utils/Checksum.java +++ b/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 { diff --git a/src/main/java/jota/utils/Constants.java b/src/main/java/jota/utils/Constants.java index 5f8f9a2..8a3a393 100644 --- a/src/main/java/jota/utils/Constants.java +++ b/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 { diff --git a/src/main/java/jota/utils/InputValidator.java b/src/main/java/jota/utils/InputValidator.java index 0399602..f1a2dea 100644 --- a/src/main/java/jota/utils/InputValidator.java +++ b/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 { diff --git a/src/main/java/jota/utils/IotaUnitConverter.java b/src/main/java/jota/utils/IotaUnitConverter.java index eade784..7b0635c 100644 --- a/src/main/java/jota/utils/IotaUnitConverter.java +++ b/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 { diff --git a/src/main/java/jota/utils/IotaUnits.java b/src/main/java/jota/utils/IotaUnits.java index e799913..bb7bb09 100644 --- a/src/main/java/jota/utils/IotaUnits.java +++ b/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 { diff --git a/src/main/java/jota/utils/Multisig.java b/src/main/java/jota/utils/Multisig.java index 4456d1d..f2b07b4 100644 --- a/src/main/java/jota/utils/Multisig.java +++ b/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 { diff --git a/src/main/java/jota/utils/NamedThreadFactory.java b/src/main/java/jota/utils/NamedThreadFactory.java index a6e3dab..4f92e1a 100644 --- a/src/main/java/jota/utils/NamedThreadFactory.java +++ b/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; diff --git a/src/main/java/jota/utils/Parallel.java b/src/main/java/jota/utils/Parallel.java index f5cdeb7..3dccff4 100644 --- a/src/main/java/jota/utils/Parallel.java +++ b/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(); diff --git a/src/main/java/jota/utils/SeedRandomGenerator.java b/src/main/java/jota/utils/SeedRandomGenerator.java index 2727d8c..fd5b93a 100644 --- a/src/main/java/jota/utils/SeedRandomGenerator.java +++ b/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 { diff --git a/src/main/java/jota/utils/StopWatch.java b/src/main/java/jota/utils/StopWatch.java index 699de6f..18ec7bc 100644 --- a/src/main/java/jota/utils/StopWatch.java +++ b/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; diff --git a/src/main/java/jota/utils/TrytesConverter.java b/src/main/java/jota/utils/TrytesConverter.java index bea49ac..376167a 100644 --- a/src/main/java/jota/utils/TrytesConverter.java +++ b/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 { diff --git a/src/test/java/jota/ChecksumTest.java b/src/test/java/jota/ChecksumTest.java index f2b950d..12ec896 100644 --- a/src/test/java/jota/ChecksumTest.java +++ b/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 { diff --git a/src/test/java/jota/InputValidatorTest.java b/src/test/java/jota/InputValidatorTest.java index 502ab47..244dacc 100644 --- a/src/test/java/jota/InputValidatorTest.java +++ b/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 { diff --git a/src/test/java/jota/IotaCoreApiTest.java b/src/test/java/jota/IotaCoreApiTest.java index d3aa4e8..36d8f44 100644 --- a/src/test/java/jota/IotaCoreApiTest.java +++ b/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 { diff --git a/src/test/java/jota/IotaUnitConverterTest.java b/src/test/java/jota/IotaUnitConverterTest.java index 624555a..a63e6de 100644 --- a/src/test/java/jota/IotaUnitConverterTest.java +++ b/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 { diff --git a/src/test/java/jota/SeedRandomGeneratorTest.java b/src/test/java/jota/SeedRandomGeneratorTest.java index 01c203f..0876dfe 100644 --- a/src/test/java/jota/SeedRandomGeneratorTest.java +++ b/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 { diff --git a/src/test/java/jota/TrytesConverterTest.java b/src/test/java/jota/TrytesConverterTest.java index f6403e5..9c65c4f 100644 --- a/src/test/java/jota/TrytesConverterTest.java +++ b/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 {