documentation

This commit is contained in:
pinpong 2017-02-14 21:05:27 +01:00
parent 8cb20c2792
commit 8c2a36bacf
6 changed files with 64 additions and 20 deletions

View File

@ -51,6 +51,7 @@ public class IotaAttachToTangleRequest extends IotaCommandRequest {
/**
* Gets the brancht ransaction.
*
* @return branchTransaction The branch transaction.
*/
public String getBranchTransaction() {
@ -59,6 +60,7 @@ public class IotaAttachToTangleRequest extends IotaCommandRequest {
/**
* Sets the branch transaction.
*
* @param branchTransaction the branch transaction.
*/
public void setBranchTransaction(String branchTransaction) {
@ -67,6 +69,7 @@ public class IotaAttachToTangleRequest extends IotaCommandRequest {
/**
* Gets the min weight magnitude.
*
* @return minWeightMagnitude The min weight magnitude.
*/
public Integer getMinWeightMagnitude() {
@ -75,6 +78,7 @@ public class IotaAttachToTangleRequest extends IotaCommandRequest {
/**
* Sets the min weight magnitude.
*
* @param minWeightMagnitude The min weight magnitude.
*/
public void setMinWeightMagnitude(Integer minWeightMagnitude) {
@ -83,6 +87,7 @@ public class IotaAttachToTangleRequest extends IotaCommandRequest {
/**
* Gets the trytes.
*
* @return trytes The trytes.
*/
public String[] getTrytes() {
@ -91,6 +96,7 @@ public class IotaAttachToTangleRequest extends IotaCommandRequest {
/**
* Sets the trytes.
*
* @param trytes The trytes.
*/
public void setTrytes(String[] trytes) {

View File

@ -26,6 +26,38 @@ public class IotaFindTransactionsRequest extends IotaCommandRequest {
return new IotaFindTransactionsRequest();
}
/**
* Initializes a new instance of the IotaFindTransactionsRequest class.
*/
public IotaFindTransactionsRequest byBundles(String... bundles) {
this.bundles = bundles;
return this;
}
/**
* Initializes a new instance of the IotaFindTransactionsRequest class.
*/
public IotaFindTransactionsRequest byAddresses(String... addresses) {
this.addresses = addresses;
return this;
}
/**
* Initializes a new instance of the IotaFindTransactionsRequest class.
*/
public IotaFindTransactionsRequest byTags(String... tags) {
this.tags = tags;
return this;
}
/**
* Initializes a new instance of the IotaFindTransactionsRequest class.
*/
public IotaFindTransactionsRequest byApprovees(String... approvees) {
this.approvees = approvees;
return this;
}
/**
* Gets the bundles.
*
@ -46,6 +78,7 @@ public class IotaFindTransactionsRequest extends IotaCommandRequest {
/**
* Gets the addresses.
*
* @return addresses The addresses.
*/
public String[] getAddresses() {
@ -54,6 +87,7 @@ public class IotaFindTransactionsRequest extends IotaCommandRequest {
/**
* Sets the addresses.
*
* @param addresses The addresses.
*/
public void setAddresses(String[] addresses) {
@ -62,6 +96,7 @@ public class IotaFindTransactionsRequest extends IotaCommandRequest {
/**
* Gets the tags.
*
* @return tags The tags.
*/
public String[] getTags() {
@ -70,6 +105,7 @@ public class IotaFindTransactionsRequest extends IotaCommandRequest {
/**
* Sets the tags.
*
* @param tags The tags.
*/
public void setTags(String[] tags) {
@ -78,6 +114,7 @@ public class IotaFindTransactionsRequest extends IotaCommandRequest {
/**
* Gets the approvees.
*
* @return approvees The approvees.
*/
public String[] getApprovees() {
@ -86,29 +123,10 @@ public class IotaFindTransactionsRequest extends IotaCommandRequest {
/**
* Sets the approvees.
*
* @param approvees The approvees.
*/
public void setApprovees(String[] approvees) {
this.approvees = approvees;
}
public IotaFindTransactionsRequest byBundles(String... bundles) {
this.bundles = bundles;
return this;
}
public IotaFindTransactionsRequest byAddresses(String... addresses) {
this.addresses = addresses;
return this;
}
public IotaFindTransactionsRequest byTags(String... tags) {
this.tags = tags;
return this;
}
public IotaFindTransactionsRequest byApprovees(String... approvees) {
this.approvees = approvees;
return this;
}
}

View File

@ -46,6 +46,7 @@ public class IotaGetBalancesRequest extends IotaCommandRequest {
/**
* Gets the threshold.
*
* @return threshold The threshold.
*/
public Integer getThreshold() {
@ -54,6 +55,7 @@ public class IotaGetBalancesRequest extends IotaCommandRequest {
/**
* Sets the threshold.
*
* @param threshold The threshold.
*/
public void setThreshold(Integer threshold) {

View File

@ -57,6 +57,7 @@ public class IotaGetInclusionStateRequest extends IotaCommandRequest {
/**
* Gets the tips.
*
* @return tips The tips.
*/
public String[] getTips() {
@ -65,6 +66,7 @@ public class IotaGetInclusionStateRequest extends IotaCommandRequest {
/**
* Sets the tips.
*
* @param tips The tips.
*/
public void setTips(String[] tips) {

View File

@ -43,6 +43,7 @@ public class GetBalancesAndFormatResponse extends AbstractResponse {
/**
* Gets the total balance.
*
* @return totalBalance The total balance.
*/
public long getTotalBalance() {
@ -51,6 +52,7 @@ public class GetBalancesAndFormatResponse extends AbstractResponse {
/**
* Sets the total balance.
*
* @param totalBalance The total balance.
*/
public void setTotalBalance(long totalBalance) {

View File

@ -42,6 +42,7 @@ public class GetNodeInfoResponse extends AbstractResponse {
/**
* The version of running java version.
*
* @return
*/
public String getJreVersion() {
@ -50,6 +51,7 @@ public class GetNodeInfoResponse extends AbstractResponse {
/**
* Available cores on your machine for JRE.
*
* @return
*/
public Integer getJreAvailableProcessors() {
@ -58,6 +60,7 @@ public class GetNodeInfoResponse extends AbstractResponse {
/**
* The amount of free memory in the Java Virtual Machine.
*
* @return
*/
public long getJreFreeMemory() {
@ -66,6 +69,7 @@ public class GetNodeInfoResponse extends AbstractResponse {
/**
* The maximum amount of memory that the Java virtual machine will attempt to use.
*
* @return
*/
public long getJreMaxMemory() {
@ -74,6 +78,7 @@ public class GetNodeInfoResponse extends AbstractResponse {
/**
* The total amount of memory in the Java virtual machine.
*
* @return
*/
public long getJreTotalMemory() {
@ -82,6 +87,7 @@ public class GetNodeInfoResponse extends AbstractResponse {
/**
* Latest milestone that was signed off by the coordinator.
*
* @return
*/
public String getLatestMilestone() {
@ -90,6 +96,7 @@ public class GetNodeInfoResponse extends AbstractResponse {
/**
* Index of the latest milestone.
*
* @return
*/
public int getLatestMilestoneIndex() {
@ -100,6 +107,7 @@ public class GetNodeInfoResponse extends AbstractResponse {
* The latest milestone which is solid and is used for sending transactions.
* For a milestone to become solid your local node must basically approve the subtangle of coordinator-approved transactions,
* and have a consistent view of all referenced transactions.
*
* @return
*/
public String getLatestSolidSubtangleMilestone() {
@ -108,6 +116,7 @@ public class GetNodeInfoResponse extends AbstractResponse {
/**
* Index of the latest solid subtangle.
*
* @return
*/
public int getLatestSolidSubtangleMilestoneIndex() {
@ -116,6 +125,7 @@ public class GetNodeInfoResponse extends AbstractResponse {
/**
* Number of neighbors you are directly connected with.
*
* @return
*/
public int getNeighbors() {
@ -124,6 +134,7 @@ public class GetNodeInfoResponse extends AbstractResponse {
/**
* Packets which are currently queued up
*
* @return
*/
public int getPacketsQueueSize() {
@ -132,6 +143,7 @@ public class GetNodeInfoResponse extends AbstractResponse {
/**
* Current UNIX timestamp.
*
* @return
*/
public Long getTime() {
@ -140,6 +152,7 @@ public class GetNodeInfoResponse extends AbstractResponse {
/**
* Number of tips in the network.
*
* @return
*/
public int getTips() {
@ -148,6 +161,7 @@ public class GetNodeInfoResponse extends AbstractResponse {
/**
* Transactions to request during syncing process.
*
* @return
*/
public int getTransactionsToRequest() {