Skip to content

Commit 98ab237

Browse files
committed
add missing javadoc
1 parent 0acc170 commit 98ab237

25 files changed

+198
-130
lines changed

src/main/java/com/adyen/Client.java

Lines changed: 26 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,12 @@ public Client(String username, String password, Environment environment, String
7070
}
7171

7272
/**
73-
* @deprecated As of library version 1.6.1, timeouts should be set by {@link #setTimeouts(int connectionTimeoutMillis, int readTimeoutMillis)} or directly by {@link com.adyen.Config#setConnectionTimeoutMillis(int connectionTimeoutMillis)}.
73+
* @param username your merchant account Username
74+
* @param password your merchant accont Password
75+
* @param environment This defines the payment enviroment live or test
76+
* @param connectionTimeoutMillis Provide the time to time out
77+
* @deprecated As of library version 1.6.1, timeouts should be set by {@link #setTimeouts(int connectionTimeoutMillis, int readTimeoutMillis)} or directly by {@link
78+
* com.adyen.Config#setConnectionTimeoutMillis(int connectionTimeoutMillis)}.
7479
*/
7580
@Deprecated
7681
public Client(String username, String password, Environment environment, int connectionTimeoutMillis) {
@@ -80,7 +85,13 @@ public Client(String username, String password, Environment environment, int con
8085
}
8186

8287
/**
83-
* @deprecated As of library version 1.6.1, timeouts should be set by {@link #setTimeouts(int connectionTimeoutMillis, int readTimeoutMillis)} or directly by {@link com.adyen.Config#setConnectionTimeoutMillis(int connectionTimeoutMillis)}.
88+
* @param username your merchant account Username
89+
* @param password your merchant accont Password
90+
* @param environment This defines the payment enviroment live or test
91+
* @param connectionTimeoutMillis Provide the time to time out
92+
* @param liveEndpointUrlPrefix provide the merchant specific url
93+
* @deprecated As of library version 1.6.1, timeouts should be set by {@link #setTimeouts(int connectionTimeoutMillis, int readTimeoutMillis)} or directly by {@link
94+
* com.adyen.Config#setConnectionTimeoutMillis(int connectionTimeoutMillis)}.
8495
*/
8596
@Deprecated
8697
public Client(String username, String password, Environment environment, int connectionTimeoutMillis, String liveEndpointUrlPrefix) {
@@ -100,7 +111,11 @@ public Client(String apiKey, Environment environment, String liveEndpointUrlPref
100111
}
101112

102113
/**
103-
* @deprecated As of library version 1.6.1, timeouts should be set by {@link #setTimeouts(int connectionTimeoutMillis, int readTimeoutMillis)} or directly by {@link com.adyen.Config#setConnectionTimeoutMillis(int connectionTimeoutMillis)}.
114+
* @param apiKey Defines the api key that can be retrieved by back office
115+
* @param environment This defines the payment enviroment live or test
116+
* @param connectionTimeoutMillis Provide the time to time out
117+
* @deprecated As of library version 1.6.1, timeouts should be set by {@link #setTimeouts(int connectionTimeoutMillis, int readTimeoutMillis)} or directly by {@link
118+
* com.adyen.Config#setConnectionTimeoutMillis(int connectionTimeoutMillis)}.
104119
*/
105120
@Deprecated
106121
public Client(String apiKey, Environment environment, int connectionTimeoutMillis) {
@@ -110,7 +125,12 @@ public Client(String apiKey, Environment environment, int connectionTimeoutMilli
110125
}
111126

112127
/**
113-
* @deprecated As of library version 1.6.1, timeouts should be set by {@link #setTimeouts(int connectionTimeoutMillis, int readTimeoutMillis)} or directly by {@link com.adyen.Config#setConnectionTimeoutMillis(int connectionTimeoutMillis)}.
128+
* @param apiKey Defines the api key that can be retrieved by back office
129+
* @param environment This defines the payment enviroment live or test
130+
* @param connectionTimeoutMillis Provide the time to time out
131+
* @param liveEndpointUrlPrefix provide the merchant specific url
132+
* @deprecated As of library version 1.6.1, timeouts should be set by {@link #setTimeouts(int connectionTimeoutMillis, int readTimeoutMillis)} or directly by {@link
133+
* com.adyen.Config#setConnectionTimeoutMillis(int connectionTimeoutMillis)}.
114134
*/
115135
@Deprecated
116136
public Client(String apiKey, Environment environment, int connectionTimeoutMillis, String liveEndpointUrlPrefix) {
@@ -120,6 +140,7 @@ public Client(String apiKey, Environment environment, int connectionTimeoutMilli
120140
}
121141

122142
/**
143+
* @param environment This defines the payment enviroment live or test
123144
* @deprecated As of library version 1.5.4, replaced by {@link #setEnvironment(Environment environment, String liveEndpointUrlPrefix)}.
124145
*/
125146
@Deprecated
@@ -128,7 +149,7 @@ public void setEnvironment(Environment environment) {
128149
}
129150

130151
/**
131-
* @param environment
152+
* @param environment This defines the payment enviroment live or test
132153
* @param liveEndpointUrlPrefix Provide the unique live url prefix from the "API URLs and Response" menu in the Adyen Customer Area
133154
*/
134155
public void setEnvironment(Environment environment, String liveEndpointUrlPrefix) {

src/main/java/com/adyen/Util/Util.java

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -73,9 +73,9 @@ public static <T> String implode(String glue, List<T> list) {
7373
/**
7474
* Returns an Amount struct to use on requests
7575
*
76-
* @param amount
77-
* @param currency
78-
* @return
76+
* @param amount Defines the amount
77+
* @param currency Defines the amount currency
78+
* @return amount
7979
*/
8080
public static Amount createAmount(String amount, String currency) {
8181
return createAmount(new BigDecimal(amount), currency);
@@ -84,9 +84,9 @@ public static Amount createAmount(String amount, String currency) {
8484
/**
8585
* Returns an Amount struct to use on requests
8686
*
87-
* @param amount
88-
* @param currency
89-
* @return
87+
* @param amount Defines the amount
88+
* @param currency Defines the amount currency
89+
* @return amount
9090
*/
9191
public static Amount createAmount(BigDecimal amount, String currency) {
9292
Amount amountData = new Amount();
@@ -138,6 +138,8 @@ public static int getDecimalPlaces(String currency) {
138138
/**
139139
* Convert the given object to string with each line indented by 4 spaces
140140
* (except the first line).
141+
* @param o string
142+
* @return string target "\n" replacement with "\n "
141143
*/
142144
public static String toIndentedString(Object o) {
143145
if (o == null) {

src/main/java/com/adyen/model/AbstractPaymentRequest.java

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -169,6 +169,9 @@ public AbstractPaymentRequest() {
169169

170170
/**
171171
* Set browser data
172+
* @param userAgent http header
173+
* @param acceptHeader http header
174+
* @return browser data
172175
*/
173176
public T setBrowserInfoData(String userAgent, String acceptHeader) {
174177
BrowserInfo browserInfo = new BrowserInfo();
@@ -182,7 +185,7 @@ public T setBrowserInfoData(String userAgent, String acceptHeader) {
182185
/**
183186
* get additionalData map Create the map if doesn't exists
184187
*
185-
* @return
188+
* @return additional data
186189
*/
187190
public Map<String, String> getOrCreateAdditionalData() {
188191
if (this.getAdditionalData() == null) {

src/main/java/com/adyen/model/PaymentRequest.java

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,12 @@ public PaymentRequest setCardData(String cardNumber, String cardHolder, String e
112112

113113
/**
114114
* Set Data needed for payment request using secured fields
115+
* @param encryptedCardNumber encrypted Card Number
116+
* @param cardHolder card holder
117+
* @param encryptedExpiryMonth encrypted expiry month
118+
* @param encryptedExpiryYear encrypted expiry year
119+
* @param encryptedSecurityCode encrypted security code
120+
* @return payment request
115121
*/
116122
public PaymentRequest setSecuredFieldsData(String encryptedCardNumber, String cardHolder, String encryptedExpiryMonth, String encryptedExpiryYear, String encryptedSecurityCode) {
117123
this.setCardHolder(cardHolder)
@@ -176,6 +182,8 @@ public void setThreeDS2RequestData(ThreeDS2RequestData threeDS2RequestData) {
176182

177183
/**
178184
* Set invoiceLines in addtionalData
185+
* @param invoiceLines Invoice lines
186+
* @return payment request
179187
*/
180188
public PaymentRequest setInvoiceLines(List<InvoiceLine> invoiceLines) {
181189
Integer count = 1;

src/main/java/com/adyen/model/checkout/PaymentsRequest.java

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -721,8 +721,12 @@ public PaymentsRequest addEncryptedCardData(String encryptedCardNumber, String e
721721

722722
/**
723723
* Add raw card data into the payment request. You need to be PCI compliant!
724-
*
725-
* @return paymentMethod
724+
* @param cardNumber card number
725+
* @param expiryMonth expiry month
726+
* @param expiryYear expiry year
727+
* @param holderName holder name
728+
* @param securityCode security code
729+
* @return paymentMethod payment method
726730
*/
727731
public PaymentsRequest addCardData(String cardNumber, String expiryMonth, String expiryYear, String securityCode, String holderName) {
728732
DefaultPaymentMethodDetails paymentMethodDetails = new DefaultPaymentMethodDetails();

src/main/java/com/adyen/model/marketpay/AccountHolderBalanceResponse.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ public List<AccountDetailBalance> getBalancePerAccount() {
122122
/**
123123
* Creating a new balancePerAccount list
124124
*
125-
* @param balancePerAccount
125+
* @param balancePerAccount balance per account
126126
*/
127127
public void setBalancePerAccount(List<AccountDetailBalance> balancePerAccount) {
128128

src/main/java/com/adyen/model/marketpay/AccountHolderDetails.java

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ public void setPhoneNumber(PhoneNumber phoneNumber) {
126126
/**
127127
* Populate the virtual bankAccountDetails to bypass the bankAccountDetailsContainer list
128128
*
129-
* @return
129+
* @return bank account details
130130
*/
131131
public List<BankAccountDetail> getBankAccountDetails() {
132132
if (bankAccountDetails == null) {
@@ -143,6 +143,7 @@ public List<BankAccountDetail> getBankAccountDetails() {
143143

144144
/**
145145
* Creating a new bankAccountDetails list
146+
* @param bankAccountDetails bank account details
146147
*/
147148
public void setBankAccountDetails(List<BankAccountDetail> bankAccountDetails) {
148149
this.bankAccountDetails = bankAccountDetails;
@@ -158,8 +159,8 @@ public void setBankAccountDetails(List<BankAccountDetail> bankAccountDetails) {
158159
/**
159160
* Add bankAccountDetail to the bankAccountDetailContainers and bankAccountDetails list
160161
*
161-
* @param bankAccountDetail
162-
* @return
162+
* @param bankAccountDetail BankAccountDetail
163+
* @return account holder details
163164
*/
164165
public AccountHolderDetails addBankAccountDetail(BankAccountDetail bankAccountDetail) {
165166
BankAccountDetailContainer bankAccountDetailContainer = new BankAccountDetailContainer(bankAccountDetail);

src/main/java/com/adyen/model/marketpay/AccountHolderTransactionListResponse.java

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -90,8 +90,8 @@ public List<AccountTransactionList> getAccountTransactionLists() {
9090

9191
/**
9292
* Creating a new accountTransactionLists list
93-
*
94-
* @param accountTransactionLists
93+
* @param accountTransactionLists AccountTransactionList
94+
9595
*/
9696
public void setAccountTransactionLists(List<AccountTransactionList> accountTransactionLists) {
9797

@@ -107,6 +107,12 @@ public void setAccountTransactionLists(List<AccountTransactionList> accountTrans
107107

108108
}
109109

110+
/**
111+
* Creating a new AccountHolderTransactionList Response
112+
*
113+
* @param accountTransactionList accountTransactionList
114+
* @return AccountHolderTransactionListResponse
115+
*/
110116
public AccountHolderTransactionListResponse addAccountTransactionList(AccountTransactionList accountTransactionList) {
111117
AccountTransactionListContainer accountTransactionListContainer = new AccountTransactionListContainer(accountTransactionList);
112118

src/main/java/com/adyen/model/marketpay/AccountTransactionList.java

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -105,8 +105,7 @@ public List<Transaction> getTransactions() {
105105

106106
/**
107107
* Creating a new transactions list
108-
*
109-
* @param transactions
108+
* @param transactions transactions
110109
*/
111110
public void setTransactions(List<Transaction> transactions) {
112111

src/main/java/com/adyen/model/marketpay/BusinessDetails.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ public List<ShareholderContact> getShareholders() {
6969
/**
7070
* Creating a new shareholders list
7171
*
72-
* @param shareholders
72+
* @param shareholders shareholders
7373
*/
7474
public void setShareholders(List<ShareholderContact> shareholders) {
7575
this.shareholders = shareholders;
@@ -86,8 +86,8 @@ public void setShareholders(List<ShareholderContact> shareholders) {
8686
/**
8787
* Add shareholderContact to the shareholderContactContainers and shareholders list
8888
*
89-
* @param shareholderContact
90-
* @return
89+
* @param shareholderContact shareholderContact
90+
* @return BusinessDetails
9191
*/
9292
public BusinessDetails addShareholderContact(ShareholderContact shareholderContact) {
9393
ShareholderContactContainer shareholderContactContainer = new ShareholderContactContainer(shareholderContact);

0 commit comments

Comments
 (0)