From af9fecb72c9b7fcb8da73cb9a15abb55508b80f1 Mon Sep 17 00:00:00 2001 From: Raj Metgiri Date: Thu, 18 May 2017 18:52:23 +0200 Subject: [PATCH] FINRACT-456 Javadoc generation possible now --- .../WebContent/META-INF/MANIFEST.MF | 3 + fineract-provider/build.gradle | 1 + .../service/AccountingProcessorHelper.java | 57 +++++++++---------- .../internal/ApplyLoanCommandStrategy.java | 4 +- .../internal/ApplySavingsCommandStrategy.java | 4 +- .../internal/ApproveLoanCommandStrategy.java | 4 +- .../CollectChargesCommandStrategy.java | 4 +- .../internal/CreateChargeCommandStrategy.java | 4 +- .../internal/DisburseLoanCommandStrategy.java | 4 +- .../serialization/BatchRequestJsonHelper.java | 2 +- .../batch/service/BatchApiService.java | 4 +- .../batch/service/ResolutionHelper.java | 4 +- .../commands/annotation/CommandType.java | 4 +- .../provider/CommandHandlerProvider.java | 9 +-- .../core/api/ApiRequestParameterHelper.java | 2 +- .../AbstractApplicationConfiguration.java | 2 +- .../boot/WarWebApplicationInitializer.java | 2 +- ...CommandProcessingResultJsonSerializer.java | 2 +- ...tyPrintingOffJsonSerializerGoogleGson.java | 2 +- ...ttyPrintingOnJsonSerializerGoogleGson.java | 2 +- .../core/serialization/FromJsonHelper.java | 2 +- .../ContentRepositoryUtils.java | 2 +- .../domain/ReportMailingJob.java | 16 +++--- ...ortMailingJobWritePlatformServiceImpl.java | 6 +- .../validation/ReportMailingJobValidator.java | 6 +- .../InvalidTenantIdentiferException.java | 2 +- .../sms/data/SmsMessageApiResponseData.java | 4 +- .../data/SmsMessageDeliveryReportData.java | 4 +- .../organisation/teller/data/CashierData.java | 37 ++++++------ .../organisation/teller/data/TellerData.java | 2 +- .../teller/data/TellerJournalData.java | 2 +- .../teller/data/TellerTransactionData.java | 2 +- .../organisation/teller/domain/Cashier.java | 22 +++---- .../teller/domain/CashierTransaction.java | 4 +- .../domain/CalendarFrequencyType.java | 4 +- .../client/domain/ClientTransaction.java | 4 +- .../common/domain/DaysInMonthType.java | 3 +- .../common/domain/DaysInYearType.java | 3 +- .../portfolio/loanaccount/domain/Loan.java | 7 ++- .../loanaccount/domain/LoanCharge.java | 8 ++- .../loanaccount/domain/LoanSummary.java | 2 +- .../loanaccount/domain/LoanTransaction.java | 5 ++ ...gBalanceInterestLoanScheduleGenerator.java | 2 +- .../LoanRescheduleRequestDataValidator.java | 6 +- .../domain/LoanRescheduleRequest.java | 4 +- ...oanRescheduleRequestNotFoundException.java | 2 +- ...heduleRequestWritePlatformServiceImpl.java | 4 +- ...WritePlatformServiceJpaRepositoryImpl.java | 2 +- ...nterestRecalculationCompoundingMethod.java | 3 +- .../InterestRecalculationPeriodMethod.java | 3 +- .../domain/LoanRescheduleStrategyMethod.java | 4 +- .../savings/DepositAccountOnClosureType.java | 2 +- ...ingsInterestCalculationDaysInYearType.java | 3 +- .../SavingsInterestCalculationType.java | 3 +- .../DepositAccountDomainServiceJpa.java | 2 +- ...WritePlatformServiceJpaRepositoryImpl.java | 2 +- ...WritePlatformServiceJpaRepositoryImpl.java | 12 ++-- 57 files changed, 172 insertions(+), 149 deletions(-) create mode 100644 fineract-provider/WebContent/META-INF/MANIFEST.MF diff --git a/fineract-provider/WebContent/META-INF/MANIFEST.MF b/fineract-provider/WebContent/META-INF/MANIFEST.MF new file mode 100644 index 000000000..254272e1c --- /dev/null +++ b/fineract-provider/WebContent/META-INF/MANIFEST.MF @@ -0,0 +1,3 @@ +Manifest-Version: 1.0 +Class-Path: + diff --git a/fineract-provider/build.gradle b/fineract-provider/build.gradle index 331a41723..771fcde58 100644 --- a/fineract-provider/build.gradle +++ b/fineract-provider/build.gradle @@ -92,6 +92,7 @@ rat { excludes = [ '**/licenses/**', '**/*.md', + '**/MANIFEST.MF', '**/*.txt', '**/*.log', '**/fineractdev-eclipse-preferences.epf', diff --git a/fineract-provider/src/main/java/org/apache/fineract/accounting/journalentry/service/AccountingProcessorHelper.java b/fineract-provider/src/main/java/org/apache/fineract/accounting/journalentry/service/AccountingProcessorHelper.java index aeef6ced5..2e3c0f81c 100755 --- a/fineract-provider/src/main/java/org/apache/fineract/accounting/journalentry/service/AccountingProcessorHelper.java +++ b/fineract-provider/src/main/java/org/apache/fineract/accounting/journalentry/service/AccountingProcessorHelper.java @@ -379,18 +379,17 @@ public class AccountingProcessorHelper { * The target accounts for debits and credits are switched in case of a * reversal * - * @param office - * @param accountTypeToBeDebited - * Enum of the placeholder GLAccount to be debited - * @param accountTypeToBeCredited - * Enum of the placeholder of the GLAccount to be credited - * @param loanProductId - * @param paymentTypeId - * @param loanId - * @param transactionId - * @param transactionDate - * @param amount - * @param isReversal + * @param office office + * @param currencyCode currencyCode + * @param accountTypeToBeDebited Enum of the placeholder GLAccount to be debited + * @param accountTypeToBeCredited Enum of the placeholder of the GLAccount to be credited + * @param loanProductId loanProductId + * @param loanId loanId + * @param transactionId transactionId + * @param transactionDate transactionDate + * @param totalAmount totalAmount + * @param isReversal isReversal + * @param chargePaymentDTOs chargePaymentDTOs */ public void createAccrualBasedJournalEntriesAndReversalsForLoanCharges(final Office office, final String currencyCode, final Integer accountTypeToBeDebited, final Integer accountTypeToBeCredited, final Long loanProductId, final Long loanId, @@ -568,17 +567,17 @@ public class AccountingProcessorHelper { * reversal * * @param office - * @param accountTypeToBeDebited - * Enum of the placeholder GLAccount to be debited - * @param accountTypeToBeCredited - * Enum of the placeholder of the GLAccount to be credited + * @param currencyCode + * @param accountTypeToBeDebited Enum of the placeholder GLAccount to be debited + * @param accountTypeToBeCredited Enum of the placeholder of the GLAccount to be credited * @param savingsProductId * @param paymentTypeId - * @param loanId + * @param savingsId * @param transactionId * @param transactionDate * @param amount * @param isReversal + * @param taxDetails */ public void createCashBasedJournalEntriesAndReversalsForSavingsTax(final Office office, final String currencyCode, final CASH_ACCOUNTS_FOR_SAVINGS accountTypeToBeDebited, final CASH_ACCOUNTS_FOR_SAVINGS accountTypeToBeCredited, @@ -726,18 +725,18 @@ public class AccountingProcessorHelper { * The target accounts for debits and credits are switched in case of a * reversal * - * @param office - * @param accountTypeToBeDebited - * Enum of the placeholder GLAccount to be debited - * @param accountTypeToBeCredited - * Enum of the placeholder of the GLAccount to be credited - * @param savingsProductId - * @param paymentTypeId - * @param loanId - * @param transactionId - * @param transactionDate - * @param amount - * @param isReversal + * @param office office + * @param currencyCode currencyCode + * @param accountTypeToBeDebited Enum of the placeholder GLAccount to be debited + * @param accountTypeToBeCredited Enum of the placeholder of the GLAccount to be credited + * @param savingsProductId savingsProductId + * @param paymentTypeId paymentTypeId + * @param loanId loanId + * @param transactionId transactionId + * @param transactionDate transactionDate + * @param totalAmount totalAmount + * @param isReversal isReversal + * @param chargePaymentDTOs chargePaymentDTOs */ public void createCashBasedJournalEntriesAndReversalsForSavingsCharges(final Office office, final String currencyCode, final CASH_ACCOUNTS_FOR_SAVINGS accountTypeToBeDebited, final CASH_ACCOUNTS_FOR_SAVINGS accountTypeToBeCredited, diff --git a/fineract-provider/src/main/java/org/apache/fineract/batch/command/internal/ApplyLoanCommandStrategy.java b/fineract-provider/src/main/java/org/apache/fineract/batch/command/internal/ApplyLoanCommandStrategy.java index 8183012ab..4901d2982 100644 --- a/fineract-provider/src/main/java/org/apache/fineract/batch/command/internal/ApplyLoanCommandStrategy.java +++ b/fineract-provider/src/main/java/org/apache/fineract/batch/command/internal/ApplyLoanCommandStrategy.java @@ -33,9 +33,9 @@ import org.springframework.stereotype.Component; * Implements {@link org.apache.fineract.batch.command.CommandStrategy} and * applies a new loan on an existing client. It passes the contents of the body * from the BatchRequest to - * {@link org.apache.fineract.portfolio.client.api.LoansApiResource} and gets back + * {@link org.apache.fineract.portfolio.loanaccount.api.LoansApiResource} and gets back * the response. This class will also catch any errors raised by - * {@link org.apache.fineract.portfolio.client.api.LoansApiResource} and map those + * {@link org.apache.fineract.portfolio.loanaccount.api.LoansApiResource} and map those * errors to appropriate status codes in BatchResponse. * * @author Rishabh Shukla diff --git a/fineract-provider/src/main/java/org/apache/fineract/batch/command/internal/ApplySavingsCommandStrategy.java b/fineract-provider/src/main/java/org/apache/fineract/batch/command/internal/ApplySavingsCommandStrategy.java index 8c97a569b..36456b3bf 100644 --- a/fineract-provider/src/main/java/org/apache/fineract/batch/command/internal/ApplySavingsCommandStrategy.java +++ b/fineract-provider/src/main/java/org/apache/fineract/batch/command/internal/ApplySavingsCommandStrategy.java @@ -33,9 +33,9 @@ import org.springframework.stereotype.Component; * Implements {@link org.apache.fineract.batch.command.CommandStrategy} and * applies a new savings on an existing client. It passes the contents of the * body from the BatchRequest to - * {@link org.apache.fineract.portfolio.client.api.SavingsAccountsApiResource} and + * {@link org.apache.fineract.portfolio.savings.api.SavingsAccountsApiResource} and * gets back the response. This class will also catch any errors raised by - * {@link org.apache.fineract.portfolio.client.api.SavingsAccountsApiResource} and + * {@link org.apache.fineract.portfolio.savings.api.SavingsAccountsApiResource} and * map those errors to appropriate status codes in BatchResponse. * * @author Rishabh Shukla diff --git a/fineract-provider/src/main/java/org/apache/fineract/batch/command/internal/ApproveLoanCommandStrategy.java b/fineract-provider/src/main/java/org/apache/fineract/batch/command/internal/ApproveLoanCommandStrategy.java index dbe3629ac..bd7ef146e 100644 --- a/fineract-provider/src/main/java/org/apache/fineract/batch/command/internal/ApproveLoanCommandStrategy.java +++ b/fineract-provider/src/main/java/org/apache/fineract/batch/command/internal/ApproveLoanCommandStrategy.java @@ -33,9 +33,9 @@ import org.springframework.stereotype.Component; * Implements {@link org.apache.fineract.batch.command.CommandStrategy} to handle * approval of a pending loan. It passes the contents of the body from the * BatchRequest to - * {@link org.apache.fineract.portfolio.client.api.LoansApiResource} and gets + * {@link org.apache.fineract.portfolio.loanaccount.api.LoansApiResource} and gets * back the response. This class will also catch any errors raised by - * {@link org.apache.fineract.portfolio.client.api.LoansApiResource} and map + * {@link org.apache.fineract.portfolio.loanaccount.api.LoansApiResource} and map * those errors to appropriate status codes in BatchResponse. * * @author Rishabh Shukla diff --git a/fineract-provider/src/main/java/org/apache/fineract/batch/command/internal/CollectChargesCommandStrategy.java b/fineract-provider/src/main/java/org/apache/fineract/batch/command/internal/CollectChargesCommandStrategy.java index 5ec887e59..37294ab28 100644 --- a/fineract-provider/src/main/java/org/apache/fineract/batch/command/internal/CollectChargesCommandStrategy.java +++ b/fineract-provider/src/main/java/org/apache/fineract/batch/command/internal/CollectChargesCommandStrategy.java @@ -33,9 +33,9 @@ import org.springframework.stereotype.Component; * Implements {@link org.apache.fineract.batch.command.CommandStrategy} and * Collect Charges for a Loan. It passes the contents of the body from the * BatchRequest to - * {@link org.apache.fineract.portfolio.client.api.LoanChargesApiResource} and + * {@link org.apache.fineract.portfolio.loanaccount.api.LoanChargesApiResource} and * gets back the response. This class will also catch any errors raised by - * {@link org.apache.fineract.portfolio.client.api.LoanChargesApiResource} and map + * {@link org.apache.fineract.portfolio.loanaccount.api.LoanChargesApiResource} and map * those errors to appropriate status codes in BatchResponse. * * @author Rishabh Shukla diff --git a/fineract-provider/src/main/java/org/apache/fineract/batch/command/internal/CreateChargeCommandStrategy.java b/fineract-provider/src/main/java/org/apache/fineract/batch/command/internal/CreateChargeCommandStrategy.java index 90678a8f6..eaa264dac 100644 --- a/fineract-provider/src/main/java/org/apache/fineract/batch/command/internal/CreateChargeCommandStrategy.java +++ b/fineract-provider/src/main/java/org/apache/fineract/batch/command/internal/CreateChargeCommandStrategy.java @@ -32,9 +32,9 @@ import org.springframework.stereotype.Component; /** * Implements {@link org.apache.fineract.batch.command.CommandStrategy} and Create * Charge for a Loan. It passes the contents of the body from the BatchRequest - * to {@link org.apache.fineract.portfolio.client.api.LoanChargesApiResource} and + * to {@link org.apache.fineract.portfolio.loanaccount.api.LoanChargesApiResource} and * gets back the response. This class will also catch any errors raised by - * {@link org.apache.fineract.portfolio.client.api.LoanChargesApiResource} and map + * {@link org.apache.fineract.portfolio.loanaccount.api.LoanChargesApiResource} and map * those errors to appropriate status codes in BatchResponse. * * @author Rishabh Shukla diff --git a/fineract-provider/src/main/java/org/apache/fineract/batch/command/internal/DisburseLoanCommandStrategy.java b/fineract-provider/src/main/java/org/apache/fineract/batch/command/internal/DisburseLoanCommandStrategy.java index 89ad9efa7..bcff2e998 100644 --- a/fineract-provider/src/main/java/org/apache/fineract/batch/command/internal/DisburseLoanCommandStrategy.java +++ b/fineract-provider/src/main/java/org/apache/fineract/batch/command/internal/DisburseLoanCommandStrategy.java @@ -33,9 +33,9 @@ import org.springframework.stereotype.Component; * Implements {@link org.apache.fineract.batch.command.CommandStrategy} to handle * disburse of a loan. It passes the contents of the body from the * BatchRequest to - * {@link org.apache.fineract.portfolio.client.api.LoansApiResource} and gets + * {@link org.apache.fineract.portfolio.loanaccount.api.LoansApiResource} and gets * back the response. This class will also catch any errors raised by - * {@link org.apache.fineract.portfolio.client.api.LoansApiResource} and map + * {@link org.apache.fineract.portfolio.loanaccount.api.LoansApiResource} and map * those errors to appropriate status codes in BatchResponse. * * @author Rishabh Shukla diff --git a/fineract-provider/src/main/java/org/apache/fineract/batch/serialization/BatchRequestJsonHelper.java b/fineract-provider/src/main/java/org/apache/fineract/batch/serialization/BatchRequestJsonHelper.java index 723b085ea..c0fd136ad 100644 --- a/fineract-provider/src/main/java/org/apache/fineract/batch/serialization/BatchRequestJsonHelper.java +++ b/fineract-provider/src/main/java/org/apache/fineract/batch/serialization/BatchRequestJsonHelper.java @@ -46,7 +46,7 @@ public class BatchRequestJsonHelper extends FromJsonHelper { * JSON string. * * @param json - * @return List + * @return List<BatchRequest> */ public List extractList(final String json) { final Type listType = new TypeToken>() {}.getType(); diff --git a/fineract-provider/src/main/java/org/apache/fineract/batch/service/BatchApiService.java b/fineract-provider/src/main/java/org/apache/fineract/batch/service/BatchApiService.java index 405312758..29aeb0b09 100644 --- a/fineract-provider/src/main/java/org/apache/fineract/batch/service/BatchApiService.java +++ b/fineract-provider/src/main/java/org/apache/fineract/batch/service/BatchApiService.java @@ -45,7 +45,7 @@ public interface BatchApiService { * * @param requestList * @param uriInfo - * @return List + * @return List<BatchResponse> */ List handleBatchRequestsWithoutEnclosingTransaction(List requestList, UriInfo uriInfo); @@ -59,7 +59,7 @@ public interface BatchApiService { * * @param requestList * @param uriInfo - * @return List + * @return List<BatchResponse> */ List handleBatchRequestsWithEnclosingTransaction(List requestList, UriInfo uriInfo); } diff --git a/fineract-provider/src/main/java/org/apache/fineract/batch/service/ResolutionHelper.java b/fineract-provider/src/main/java/org/apache/fineract/batch/service/ResolutionHelper.java index c0c3ed984..25932b4b5 100644 --- a/fineract-provider/src/main/java/org/apache/fineract/batch/service/ResolutionHelper.java +++ b/fineract-provider/src/main/java/org/apache/fineract/batch/service/ResolutionHelper.java @@ -91,7 +91,7 @@ public class ResolutionHelper { * dependency hierarchy of that particular list. * * @param batchRequests - * @return List> + * @return List<ArrayList<BatchRequestNode>> */ public List getDependingRequests(final List batchRequests) { final List rootRequests = new ArrayList<>(); @@ -128,7 +128,7 @@ public class ResolutionHelper { * Request. * * @param request - * @param lastResponse + * @param parentResponse * @return BatchRequest */ public BatchRequest resoluteRequest(final BatchRequest request, final BatchResponse parentResponse) { diff --git a/fineract-provider/src/main/java/org/apache/fineract/commands/annotation/CommandType.java b/fineract-provider/src/main/java/org/apache/fineract/commands/annotation/CommandType.java index 2df98efab..e46ae1d20 100644 --- a/fineract-provider/src/main/java/org/apache/fineract/commands/annotation/CommandType.java +++ b/fineract-provider/src/main/java/org/apache/fineract/commands/annotation/CommandType.java @@ -21,8 +21,8 @@ package org.apache.fineract.commands.annotation; import java.lang.annotation.*; /** - * Specifies the command type for the annotated class.
- *
+ * Specifies the command type for the annotated class.
+ *
* The entity name (e.g. CLIENT, SAVINGSACCOUNT, LOANPRODUCT) and the action (e.g. CREATE, DELETE) must be given. * * @author Markus Geiss diff --git a/fineract-provider/src/main/java/org/apache/fineract/commands/provider/CommandHandlerProvider.java b/fineract-provider/src/main/java/org/apache/fineract/commands/provider/CommandHandlerProvider.java index 1312069cb..e75f4c83c 100644 --- a/fineract-provider/src/main/java/org/apache/fineract/commands/provider/CommandHandlerProvider.java +++ b/fineract-provider/src/main/java/org/apache/fineract/commands/provider/CommandHandlerProvider.java @@ -35,8 +35,9 @@ import org.springframework.stereotype.Component; import java.util.HashMap; /** - * {@link CommandHandlerProvider} provides {@link NewCommandSourceHandler}s for a given entity and action.
- *
+ * {@link CommandHandlerProvider} provides {@link NewCommandSourceHandler}s for a given entity and action. + *
+ *
* A {@link NewCommandSourceHandler} can be registered and the annotation {@link CommandType} is used to determine * the entity and the action the handler is capable to process. * @@ -60,8 +61,8 @@ public class CommandHandlerProvider implements ApplicationContextAware { } /** - * Returns a handler for the given entity and action.
- *
+ * Returns a handler for the given entity and action.
+ *
* Throws an {@link UnsupportedCommandException} if no handler * for the given entity, action combination can be found. * @param entity the entity to lookup the handler, must be given. diff --git a/fineract-provider/src/main/java/org/apache/fineract/infrastructure/core/api/ApiRequestParameterHelper.java b/fineract-provider/src/main/java/org/apache/fineract/infrastructure/core/api/ApiRequestParameterHelper.java index 396189016..b5150ecff 100644 --- a/fineract-provider/src/main/java/org/apache/fineract/infrastructure/core/api/ApiRequestParameterHelper.java +++ b/fineract-provider/src/main/java/org/apache/fineract/infrastructure/core/api/ApiRequestParameterHelper.java @@ -34,7 +34,7 @@ import org.springframework.stereotype.Component; *
  • Pretty printing through pretty=true, defaults to false
    • *
  • Partial response through fields=id, name etc, when empty, the full data * is returned by default.
    • - * */ @Component public class ApiRequestParameterHelper { diff --git a/fineract-provider/src/main/java/org/apache/fineract/infrastructure/core/boot/AbstractApplicationConfiguration.java b/fineract-provider/src/main/java/org/apache/fineract/infrastructure/core/boot/AbstractApplicationConfiguration.java index 2d2e312f6..7823a0dd7 100644 --- a/fineract-provider/src/main/java/org/apache/fineract/infrastructure/core/boot/AbstractApplicationConfiguration.java +++ b/fineract-provider/src/main/java/org/apache/fineract/infrastructure/core/boot/AbstractApplicationConfiguration.java @@ -32,7 +32,7 @@ import org.springframework.context.annotation.PropertySource; * Base Spring Configuration with what's common to all Configuration subclasses. * * Notably the EnableAutoConfiguration excludes relevant for (and often adjusted - * when upgrading versions of) Spring Boot, the "old" (pre. Spring Boot & + * when upgrading versions of) Spring Boot, the "old" (pre. Spring Boot & * MariaDB4j) fineract appContext.xml which all configurations need, and the * web.xml successor WebXmlConfiguration. * diff --git a/fineract-provider/src/main/java/org/apache/fineract/infrastructure/core/boot/WarWebApplicationInitializer.java b/fineract-provider/src/main/java/org/apache/fineract/infrastructure/core/boot/WarWebApplicationInitializer.java index 907f8273c..7d1df1d61 100644 --- a/fineract-provider/src/main/java/org/apache/fineract/infrastructure/core/boot/WarWebApplicationInitializer.java +++ b/fineract-provider/src/main/java/org/apache/fineract/infrastructure/core/boot/WarWebApplicationInitializer.java @@ -28,7 +28,7 @@ import org.springframework.context.annotation.ImportResource; * Configuration just adds the JNDI-based DataSource lookup to its * AbstractApplicationConfiguration. * - * This (intentionally) only configures the original (pre-Spring Boot & + * This (intentionally) only configures the original (pre-Spring Boot & * MariaDB4j) fineract Spring Beans, and does NOT include the embedded Tomcat * (incl. TomcatSSLConfiguration) nor the MariaDB4jSetupService or * MariaDB4jDataSourceConfiguration, and not even the DataSourceConfiguration diff --git a/fineract-provider/src/main/java/org/apache/fineract/infrastructure/core/serialization/CommandProcessingResultJsonSerializer.java b/fineract-provider/src/main/java/org/apache/fineract/infrastructure/core/serialization/CommandProcessingResultJsonSerializer.java index 29bc8111d..1c8e1dbe4 100644 --- a/fineract-provider/src/main/java/org/apache/fineract/infrastructure/core/serialization/CommandProcessingResultJsonSerializer.java +++ b/fineract-provider/src/main/java/org/apache/fineract/infrastructure/core/serialization/CommandProcessingResultJsonSerializer.java @@ -31,7 +31,7 @@ import com.google.gson.GsonBuilder; /** *

    - * A google gson implementation of {@link ExcludeNothingJsonSerializer} + * A google gson implementation of * contract. *

    * diff --git a/fineract-provider/src/main/java/org/apache/fineract/infrastructure/core/serialization/ExcludeNothingWithPrettyPrintingOffJsonSerializerGoogleGson.java b/fineract-provider/src/main/java/org/apache/fineract/infrastructure/core/serialization/ExcludeNothingWithPrettyPrintingOffJsonSerializerGoogleGson.java index 5c819c768..a6e8e2ae4 100644 --- a/fineract-provider/src/main/java/org/apache/fineract/infrastructure/core/serialization/ExcludeNothingWithPrettyPrintingOffJsonSerializerGoogleGson.java +++ b/fineract-provider/src/main/java/org/apache/fineract/infrastructure/core/serialization/ExcludeNothingWithPrettyPrintingOffJsonSerializerGoogleGson.java @@ -31,7 +31,7 @@ import com.google.gson.GsonBuilder; /** *

    - * A google gson implementation of {@link ExcludeNothingJsonSerializer} + * A google gson implementation of * contract. *

    * diff --git a/fineract-provider/src/main/java/org/apache/fineract/infrastructure/core/serialization/ExcludeNothingWithPrettyPrintingOnJsonSerializerGoogleGson.java b/fineract-provider/src/main/java/org/apache/fineract/infrastructure/core/serialization/ExcludeNothingWithPrettyPrintingOnJsonSerializerGoogleGson.java index b649905e0..b24c20661 100644 --- a/fineract-provider/src/main/java/org/apache/fineract/infrastructure/core/serialization/ExcludeNothingWithPrettyPrintingOnJsonSerializerGoogleGson.java +++ b/fineract-provider/src/main/java/org/apache/fineract/infrastructure/core/serialization/ExcludeNothingWithPrettyPrintingOnJsonSerializerGoogleGson.java @@ -31,7 +31,7 @@ import com.google.gson.GsonBuilder; /** *

    - * A google gson implementation of {@link ExcludeNothingJsonSerializer} + * A google gson implementation of * contract. *

    * diff --git a/fineract-provider/src/main/java/org/apache/fineract/infrastructure/core/serialization/FromJsonHelper.java b/fineract-provider/src/main/java/org/apache/fineract/infrastructure/core/serialization/FromJsonHelper.java index 9d14ea91b..94eb77cee 100644 --- a/fineract-provider/src/main/java/org/apache/fineract/infrastructure/core/serialization/FromJsonHelper.java +++ b/fineract-provider/src/main/java/org/apache/fineract/infrastructure/core/serialization/FromJsonHelper.java @@ -115,7 +115,7 @@ public class FromJsonHelper { /** * @param parentPropertyName * The full json path to this property,the value is appended to - * the parameter name while generating an error message
    + * the parameter name while generating an error message
    * Ex: property "name" in Object "person" would be named as * "person.name" * @param object diff --git a/fineract-provider/src/main/java/org/apache/fineract/infrastructure/documentmanagement/contentrepository/ContentRepositoryUtils.java b/fineract-provider/src/main/java/org/apache/fineract/infrastructure/documentmanagement/contentrepository/ContentRepositoryUtils.java index a455f5550..ceebf1d68 100644 --- a/fineract-provider/src/main/java/org/apache/fineract/infrastructure/documentmanagement/contentrepository/ContentRepositoryUtils.java +++ b/fineract-provider/src/main/java/org/apache/fineract/infrastructure/documentmanagement/contentrepository/ContentRepositoryUtils.java @@ -121,7 +121,7 @@ public class ContentRepositoryUtils { /** * Extracts Image from a Data URL * - * @param mimeType + * @param dataURL mimeType */ public static Base64EncodedImage extractImageFromDataURL(final String dataURL) { String fileExtension = ""; diff --git a/fineract-provider/src/main/java/org/apache/fineract/infrastructure/reportmailingjob/domain/ReportMailingJob.java b/fineract-provider/src/main/java/org/apache/fineract/infrastructure/reportmailingjob/domain/ReportMailingJob.java index c7f3bb7d4..0a29c560b 100644 --- a/fineract-provider/src/main/java/org/apache/fineract/infrastructure/reportmailingjob/domain/ReportMailingJob.java +++ b/fineract-provider/src/main/java/org/apache/fineract/infrastructure/reportmailingjob/domain/ReportMailingJob.java @@ -322,7 +322,7 @@ public class ReportMailingJob extends AbstractAuditableCustom { * update the stretchy report entity associated with the credit check * * @param stretchyReport -- Report entity - * @return None + * **/ public void update(final Report stretchyReport) { if (stretchyReport != null) { @@ -333,7 +333,7 @@ public class ReportMailingJob extends AbstractAuditableCustom { /** * delete the report mailing job, set the isDeleted property to 1 and alter the name * - * @return None + * **/ public void delete() { this.isDeleted = true; @@ -491,7 +491,7 @@ public class ReportMailingJob extends AbstractAuditableCustom { /** * increase the numberOfRuns by 1 * - * @return None + * **/ public void increaseNumberOfRunsByOne() { this.numberOfRuns++; @@ -501,7 +501,7 @@ public class ReportMailingJob extends AbstractAuditableCustom { * update the previousRunStatus * * @param previousRunStatus -- the status of the previous job execution - * @return None + * **/ public void updatePreviousRunStatus(final String previousRunStatus) { if (!StringUtils.isEmpty(previousRunStatus)) { @@ -513,7 +513,7 @@ public class ReportMailingJob extends AbstractAuditableCustom { * update the previousRunDateTime * * @param previousRunDateTime -- previous run date - * @return None + * **/ public void updatePreviousRunDateTime(final DateTime previousRunDateTime) { if (previousRunDateTime != null) { @@ -525,7 +525,7 @@ public class ReportMailingJob extends AbstractAuditableCustom { * update the nextRunDateTime * * @param nextRunDateTime -- the next run DateTime - * @return None + * **/ public void updateNextRunDateTime(final DateTime nextRunDateTime) { if (nextRunDateTime != null) { @@ -540,7 +540,7 @@ public class ReportMailingJob extends AbstractAuditableCustom { /** * deactivate the report mailing job by setting the isActive property to 0 * - * @return None + * **/ public void deactivate() { this.isActive = false; @@ -550,7 +550,7 @@ public class ReportMailingJob extends AbstractAuditableCustom { * update the previousRunErrorLog property * * @param previousRunErrorLog -- the previous job run error log - * @return None + * **/ public void updatePreviousRunErrorLog(final String previousRunErrorLog) { this.previousRunErrorLog = previousRunErrorLog; diff --git a/fineract-provider/src/main/java/org/apache/fineract/infrastructure/reportmailingjob/service/ReportMailingJobWritePlatformServiceImpl.java b/fineract-provider/src/main/java/org/apache/fineract/infrastructure/reportmailingjob/service/ReportMailingJobWritePlatformServiceImpl.java index 02972a927..6e9f5e381 100644 --- a/fineract-provider/src/main/java/org/apache/fineract/infrastructure/reportmailingjob/service/ReportMailingJobWritePlatformServiceImpl.java +++ b/fineract-provider/src/main/java/org/apache/fineract/infrastructure/reportmailingjob/service/ReportMailingJobWritePlatformServiceImpl.java @@ -301,7 +301,7 @@ public class ReportMailingJobWritePlatformServiceImpl implements ReportMailingJo * @param reportMailingJob -- the report mailing job entity * @param errorLog -- StringBuilder object containing the error log if any * @param jobStartDateTime -- the start DateTime of the job - * @return None + * **/ private void updateReportMailingJobAfterJobExecution(final ReportMailingJob reportMailingJob, final StringBuilder errorLog, final DateTime jobStartDateTime) { @@ -374,7 +374,7 @@ public class ReportMailingJobWritePlatformServiceImpl implements ReportMailingJo * @param errorLog -- StringBuilder object containing the error log if any * @param jobStartDateTime -- the start DateTime of the job * @param jobRunStatus -- the status of the job (success/error) - * @return None + * **/ private void createReportMailingJobRunHistroryAfterJobExecution(final ReportMailingJob reportMailingJob, final StringBuilder errorLog, final DateTime jobStartDateTime, final String jobRunStatus) { @@ -391,7 +391,7 @@ public class ReportMailingJobWritePlatformServiceImpl implements ReportMailingJo * * @param jsonCommand -- JsonCommand object * @param dve -- data integrity exception object - * @return None + * **/ private void handleDataIntegrityIssues(final JsonCommand jsonCommand, final DataIntegrityViolationException dve) { final Throwable realCause = dve.getMostSpecificCause(); diff --git a/fineract-provider/src/main/java/org/apache/fineract/infrastructure/reportmailingjob/validation/ReportMailingJobValidator.java b/fineract-provider/src/main/java/org/apache/fineract/infrastructure/reportmailingjob/validation/ReportMailingJobValidator.java index c3bbaf851..d87140426 100644 --- a/fineract-provider/src/main/java/org/apache/fineract/infrastructure/reportmailingjob/validation/ReportMailingJobValidator.java +++ b/fineract-provider/src/main/java/org/apache/fineract/infrastructure/reportmailingjob/validation/ReportMailingJobValidator.java @@ -63,7 +63,7 @@ public class ReportMailingJobValidator { * validate the request to create a new report mailing job * * @param jsonCommand -- the JSON command object (instance of the JsonCommand class) - * @return None + * **/ public void validateCreateRequest(final JsonCommand jsonCommand) { final String jsonString = jsonCommand.json(); @@ -142,7 +142,7 @@ public class ReportMailingJobValidator { * validate the request to update a report mailing job * * @param jsonCommand -- the JSON command object (instance of the JsonCommand class) - * @return None + * **/ public void validateUpdateRequest(final JsonCommand jsonCommand) { final String jsonString = jsonCommand.json(); @@ -309,7 +309,7 @@ public class ReportMailingJobValidator { * throw a PlatformApiDataValidationException exception if there are validation errors * * @param dataValidationErrors -- list of ApiParameterError objects - * @return None + * **/ private void throwExceptionIfValidationWarningsExist(final List dataValidationErrors) { if (!dataValidationErrors.isEmpty()) { diff --git a/fineract-provider/src/main/java/org/apache/fineract/infrastructure/security/exception/InvalidTenantIdentiferException.java b/fineract-provider/src/main/java/org/apache/fineract/infrastructure/security/exception/InvalidTenantIdentiferException.java index 68b161338..d2d7a8781 100644 --- a/fineract-provider/src/main/java/org/apache/fineract/infrastructure/security/exception/InvalidTenantIdentiferException.java +++ b/fineract-provider/src/main/java/org/apache/fineract/infrastructure/security/exception/InvalidTenantIdentiferException.java @@ -22,7 +22,7 @@ package org.apache.fineract.infrastructure.security.exception; * {@link RuntimeException} thrown when an invalid tenant identifier is used in * request to platform. * - * @see CustomRequestHeaderAuthenticationFilter + * */ public class InvalidTenantIdentiferException extends RuntimeException { diff --git a/fineract-provider/src/main/java/org/apache/fineract/infrastructure/sms/data/SmsMessageApiResponseData.java b/fineract-provider/src/main/java/org/apache/fineract/infrastructure/sms/data/SmsMessageApiResponseData.java index d247bc79d..947bb3366 100644 --- a/fineract-provider/src/main/java/org/apache/fineract/infrastructure/sms/data/SmsMessageApiResponseData.java +++ b/fineract-provider/src/main/java/org/apache/fineract/infrastructure/sms/data/SmsMessageApiResponseData.java @@ -30,7 +30,7 @@ public class SmsMessageApiResponseData { /** * SmsMessageApiResponseData constructor * - * @return void + * **/ private SmsMessageApiResponseData(Integer httpStatusCode, List data) { this.httpStatusCode = httpStatusCode; @@ -40,7 +40,7 @@ public class SmsMessageApiResponseData { /** * Default SmsMessageApiResponseData constructor * - * @return void + * **/ protected SmsMessageApiResponseData() {} diff --git a/fineract-provider/src/main/java/org/apache/fineract/infrastructure/sms/data/SmsMessageDeliveryReportData.java b/fineract-provider/src/main/java/org/apache/fineract/infrastructure/sms/data/SmsMessageDeliveryReportData.java index 91471b226..d8167fec8 100644 --- a/fineract-provider/src/main/java/org/apache/fineract/infrastructure/sms/data/SmsMessageDeliveryReportData.java +++ b/fineract-provider/src/main/java/org/apache/fineract/infrastructure/sms/data/SmsMessageDeliveryReportData.java @@ -33,7 +33,7 @@ public class SmsMessageDeliveryReportData { /** * SmsMessageDeliveryReportData constructor * - * @return void + * **/ private SmsMessageDeliveryReportData(Long id, String externalId, String addedOnDate, String deliveredOnDate, Integer deliveryStatus, Boolean hasError, String errorMessage) { @@ -49,7 +49,7 @@ public class SmsMessageDeliveryReportData { /** * Default SmsMessageDeliveryReportData constructor * - * @return void + * **/ protected SmsMessageDeliveryReportData() {} diff --git a/fineract-provider/src/main/java/org/apache/fineract/organisation/teller/data/CashierData.java b/fineract-provider/src/main/java/org/apache/fineract/organisation/teller/data/CashierData.java index f6e61bb15..27367f77b 100644 --- a/fineract-provider/src/main/java/org/apache/fineract/organisation/teller/data/CashierData.java +++ b/fineract-provider/src/main/java/org/apache/fineract/organisation/teller/data/CashierData.java @@ -34,7 +34,7 @@ import org.joda.time.LocalDate; * information, teller, and more. * * @author Markus Geiss -<<<<<<< HEAD + * @since 2.0.0 * @see org.apache.fineract.organisation.teller.domain.Cashier * @since 2.0.0 @@ -86,24 +86,27 @@ public final class CashierData implements Serializable { /** * Creates a new cashier. - *

    + * *

    The valid from/to dates may be used to define a time period in which * the cashier is assignable to a teller.

    - *

    + * *

    The start/end times may be used to define a time period in which * the cashier works part time.

    * - * @param id the primary key of this cashier - * @param officeId the primary key of the related office - * @param staffId the primary key of the related staff - * @param tellerId the primary key of the related teller + * @param id the primary key of this cashier + * @param officeId the primary key of the related office + * @param officeName the primary key of the related staff + * @param staffId the primary key of the related teller + * @param staffName + * @param tellerId the primary key of the related teller + * @param tellerName * @param description the description of this cashier - * @param validFrom the valid from date of this cashier - * @param validTo the valid to date of this cashier - * @param partTime the part time flag of this cashier - * @param startTime the start time of this cashier - * @param endTime the end time of this cashier - * @return the cashier + * @param startDate the valid from date of this cashier + * @param endDate the valid to date of this cashier + * @param isFullDay the part time flag of this cashier + * @param startTime the start time of this cashier + * @param endTime the end time of this cashier + * @return */ public static CashierData instance(final Long id, final Long officeId, String officeName, final Long staffId, final String staffName, final Long tellerId, final String tellerName, @@ -169,7 +172,7 @@ public final class CashierData implements Serializable { /** * Returns the valid from date of this cashier. - *

    + * *

    The valid from/to dates may be used to define a time period in which * the cashier is assignable to a teller.

    * @@ -181,7 +184,7 @@ public final class CashierData implements Serializable { /** * Returns the valid to date of this cashier. - *

    + * *

    The valid from/to dates may be used to define a time period in which * the cashier is assignable to a teller.

    * @@ -202,7 +205,7 @@ public final class CashierData implements Serializable { /** * Returns the start time of this cashier. - *

    + * *

    The start/end times may be used to define a time period in which * the cashier works part time.

    * @@ -214,7 +217,7 @@ public final class CashierData implements Serializable { /** * Returns the end time of this cashier. - *

    + * *

    The start/end times may be used to define a time period in which * the cashier works part time.

    * diff --git a/fineract-provider/src/main/java/org/apache/fineract/organisation/teller/data/TellerData.java b/fineract-provider/src/main/java/org/apache/fineract/organisation/teller/data/TellerData.java index e86f14f38..439fb72e2 100644 --- a/fineract-provider/src/main/java/org/apache/fineract/organisation/teller/data/TellerData.java +++ b/fineract-provider/src/main/java/org/apache/fineract/organisation/teller/data/TellerData.java @@ -32,7 +32,7 @@ import java.util.Date; * {@code TellerData} represents an immutable data object for teller data. * * @version 1.0 -<<<<<<< HEAD + * @since 2.0.0 * @see java.io.Serializable * @since 2.0.0 diff --git a/fineract-provider/src/main/java/org/apache/fineract/organisation/teller/data/TellerJournalData.java b/fineract-provider/src/main/java/org/apache/fineract/organisation/teller/data/TellerJournalData.java index 6ae4d32a1..284e7af57 100644 --- a/fineract-provider/src/main/java/org/apache/fineract/organisation/teller/data/TellerJournalData.java +++ b/fineract-provider/src/main/java/org/apache/fineract/organisation/teller/data/TellerJournalData.java @@ -25,7 +25,7 @@ import java.util.Date; * {@code TellerJournalData} represents an immutable journal data object. * * @version 1.0.0 -<<<<<<< HEAD + * @since 2.0.0 * @see java.io.Serializable * @since 2.0.0 diff --git a/fineract-provider/src/main/java/org/apache/fineract/organisation/teller/data/TellerTransactionData.java b/fineract-provider/src/main/java/org/apache/fineract/organisation/teller/data/TellerTransactionData.java index e260a6a12..fcb955bfe 100644 --- a/fineract-provider/src/main/java/org/apache/fineract/organisation/teller/data/TellerTransactionData.java +++ b/fineract-provider/src/main/java/org/apache/fineract/organisation/teller/data/TellerTransactionData.java @@ -27,7 +27,7 @@ import java.util.Date; * {@code TellerTransactionData} represents an immutable data object for a transction. * * @version 1.0.0 -<<<<<<< HEAD + * @since 2.0.0 * @see java.io.Serializable * @since 2.0.0 diff --git a/fineract-provider/src/main/java/org/apache/fineract/organisation/teller/domain/Cashier.java b/fineract-provider/src/main/java/org/apache/fineract/organisation/teller/domain/Cashier.java index 1d5922faa..64ba634c2 100644 --- a/fineract-provider/src/main/java/org/apache/fineract/organisation/teller/domain/Cashier.java +++ b/fineract-provider/src/main/java/org/apache/fineract/organisation/teller/domain/Cashier.java @@ -324,7 +324,7 @@ public class Cashier extends AbstractPersistableCustom { /** * Returns the valid from date of this cashier. - *

    + * *

    * The valid from/to dates may be used to define a time period in which the * cashier is assignable to a teller. @@ -346,13 +346,13 @@ public class Cashier extends AbstractPersistableCustom { /** * Sets the valid from date of this cashier. - *

    + * *

    * The valid from/to dates may be used to define a time period in which the * cashier is assignable to a teller. *

    * - * @param validFrom + * @param startDate validFrom * the valid from date of this cashier */ public void setStartDate(Date startDate) { @@ -361,7 +361,7 @@ public class Cashier extends AbstractPersistableCustom { /** * Returns the valid to date of this cashier. - *

    + * *

    * The valid from/to dates may be used to define a time period in which the * cashier is assignable to a teller. @@ -383,13 +383,13 @@ public class Cashier extends AbstractPersistableCustom { /** * Sets the valid to date of this cashier. - *

    + * *

    * The valid from/to dates may be used to define a time period in which the * cashier is assignable to a teller. *

    * - * @param validTo + * @param endDate validTo * the valid to date of this cashier */ public void setEndDate(Date endDate) { @@ -409,7 +409,7 @@ public class Cashier extends AbstractPersistableCustom { /** * Sets the part time flag of this cashier. * - * @param partTime + * @param isFullDay partTime * the part time flag of this cashier */ public void setFullDay(Boolean isFullDay) { @@ -418,7 +418,7 @@ public class Cashier extends AbstractPersistableCustom { /** * Returns the start time of this cashier. - *

    + * *

    * The start/end times may be used to define a time period in which the * cashier works part time. @@ -432,7 +432,7 @@ public class Cashier extends AbstractPersistableCustom { /** * Set the start time of this cashier. - *

    + * *

    * The start/end times may be used to define a time period in which the * cashier works part time. @@ -447,7 +447,7 @@ public class Cashier extends AbstractPersistableCustom { /** * Returns the end time of this cashier. - *

    + * *

    * The start/end times may be used to define a time period in which the * cashier works part time. @@ -461,7 +461,7 @@ public class Cashier extends AbstractPersistableCustom { /** * Sets the end time of this cashier. - *

    + * *

    * The start/end times may be used to define a time period in which the * cashier works part time. diff --git a/fineract-provider/src/main/java/org/apache/fineract/organisation/teller/domain/CashierTransaction.java b/fineract-provider/src/main/java/org/apache/fineract/organisation/teller/domain/CashierTransaction.java index 65af4dde5..dbffe3837 100644 --- a/fineract-provider/src/main/java/org/apache/fineract/organisation/teller/domain/CashierTransaction.java +++ b/fineract-provider/src/main/java/org/apache/fineract/organisation/teller/domain/CashierTransaction.java @@ -213,7 +213,7 @@ public class CashierTransaction extends AbstractPersistableCustom { /** * Sets the transaction type of this cashier transaction. * - * @param description the transaction type of this cashier transaction + * @param txnType description the transaction type of this cashier transaction */ public void setTxnType(Integer txnType) { this.txnType = txnType; @@ -239,7 +239,7 @@ public class CashierTransaction extends AbstractPersistableCustom { /** * Sets the transaction date of this cashier transaction. * - * @param transaction date of this cashier transaction + * @param txnDate transaction date of this cashier transaction */ public void setTxnDate(Date txnDate) { this.txnDate = txnDate; diff --git a/fineract-provider/src/main/java/org/apache/fineract/portfolio/calendar/domain/CalendarFrequencyType.java b/fineract-provider/src/main/java/org/apache/fineract/portfolio/calendar/domain/CalendarFrequencyType.java index e7aa8b757..ab39044a6 100644 --- a/fineract-provider/src/main/java/org/apache/fineract/portfolio/calendar/domain/CalendarFrequencyType.java +++ b/fineract-provider/src/main/java/org/apache/fineract/portfolio/calendar/domain/CalendarFrequencyType.java @@ -107,8 +107,8 @@ public enum CalendarFrequencyType { * To convert from period frequency type tp calendar frequency type. This * method requires code refactoring. * - * @param periodFrequencyType - * @return + * @param periodFrequencyType periodFrequencyType + * @return CalendarFrequencyType */ public static CalendarFrequencyType from(final PeriodFrequencyType periodFrequencyType) { switch (periodFrequencyType) { diff --git a/fineract-provider/src/main/java/org/apache/fineract/portfolio/client/domain/ClientTransaction.java b/fineract-provider/src/main/java/org/apache/fineract/portfolio/client/domain/ClientTransaction.java index b7656f880..62ece1107 100644 --- a/fineract-provider/src/main/java/org/apache/fineract/portfolio/client/domain/ClientTransaction.java +++ b/fineract-provider/src/main/java/org/apache/fineract/portfolio/client/domain/ClientTransaction.java @@ -144,8 +144,8 @@ public class ClientTransaction extends AbstractPersistableCustom { * Converts the content of this Client Transaction to a map which can be * passed to the accounting module * - * @param currencyData - * @return + * + * */ public Map toMapData() { final Map thisTransactionData = new LinkedHashMap<>(); diff --git a/fineract-provider/src/main/java/org/apache/fineract/portfolio/common/domain/DaysInMonthType.java b/fineract-provider/src/main/java/org/apache/fineract/portfolio/common/domain/DaysInMonthType.java index 2910eae2b..a07ab43b7 100755 --- a/fineract-provider/src/main/java/org/apache/fineract/portfolio/common/domain/DaysInMonthType.java +++ b/fineract-provider/src/main/java/org/apache/fineract/portfolio/common/domain/DaysInMonthType.java @@ -21,9 +21,10 @@ import java.util.ArrayList; import java.util.List; /** - *

      + * * People typically use either of the following settings when calculating there * interest using the daily method: + *
        *
      • Actual or
        • *
      • 30
        • *
      diff --git a/fineract-provider/src/main/java/org/apache/fineract/portfolio/common/domain/DaysInYearType.java b/fineract-provider/src/main/java/org/apache/fineract/portfolio/common/domain/DaysInYearType.java index 81c8b8631..f35c4a078 100755 --- a/fineract-provider/src/main/java/org/apache/fineract/portfolio/common/domain/DaysInYearType.java +++ b/fineract-provider/src/main/java/org/apache/fineract/portfolio/common/domain/DaysInYearType.java @@ -22,9 +22,10 @@ import java.util.ArrayList; import java.util.List; /** - *
        + * * People typically use either of the following settings when calculating there * interest using the daily method: + *
          *
        • Actual or
          • *
        • 360 or
          • *
        • 364 or
          • diff --git a/fineract-provider/src/main/java/org/apache/fineract/portfolio/loanaccount/domain/Loan.java b/fineract-provider/src/main/java/org/apache/fineract/portfolio/loanaccount/domain/Loan.java index 0c3d05dc1..b5d89d4c0 100755 --- a/fineract-provider/src/main/java/org/apache/fineract/portfolio/loanaccount/domain/Loan.java +++ b/fineract-provider/src/main/java/org/apache/fineract/portfolio/loanaccount/domain/Loan.java @@ -5582,14 +5582,17 @@ public class Loan extends AbstractPersistableCustom { } /** + * @param applicationCurrency * @param restCalendarInstance * TODO * @param compoundingCalendarInstance * TODO + * @param loanCalendar * @param floatingRateDTO * TODO - * @param isChangeEmiIfRepaymentDateSameAsDisbursementDateEnabled - * @param loanCalendarInstance + * @param isSkipRepaymentonmonthFirst + * @param numberofdays + * @param holidayDetailDTO * Used for accessing the loan's calendar object * @return application terms of the Loan object **/ diff --git a/fineract-provider/src/main/java/org/apache/fineract/portfolio/loanaccount/domain/LoanCharge.java b/fineract-provider/src/main/java/org/apache/fineract/portfolio/loanaccount/domain/LoanCharge.java index 8dc72071b..8c82ebf09 100755 --- a/fineract-provider/src/main/java/org/apache/fineract/portfolio/loanaccount/domain/LoanCharge.java +++ b/fineract-provider/src/main/java/org/apache/fineract/portfolio/loanaccount/domain/LoanCharge.java @@ -741,10 +741,14 @@ public class LoanCharge extends AbstractPersistableCustom { } /** + * @param incrementBy + * + * @param installmentNumber + * * @param feeAmount * TODO - * @param processAmount - * Amount used to pay off this charge + * + * * @return Actual amount paid on this charge */ public Money updatePaidAmountBy(final Money incrementBy, final Integer installmentNumber, final Money feeAmount) { diff --git a/fineract-provider/src/main/java/org/apache/fineract/portfolio/loanaccount/domain/LoanSummary.java b/fineract-provider/src/main/java/org/apache/fineract/portfolio/loanaccount/domain/LoanSummary.java index 769a7fe6c..8bff6dc30 100644 --- a/fineract-provider/src/main/java/org/apache/fineract/portfolio/loanaccount/domain/LoanSummary.java +++ b/fineract-provider/src/main/java/org/apache/fineract/portfolio/loanaccount/domain/LoanSummary.java @@ -32,7 +32,7 @@ import org.apache.fineract.organisation.monetary.domain.Money; * Encapsulates all the summary details of a {@link Loan}. * * {@link LoanSummary} fields are updated through a scheduled job. see - - * {@link UpdateLoanSummariesScheduledJob}. + * */ @Embeddable public final class LoanSummary { diff --git a/fineract-provider/src/main/java/org/apache/fineract/portfolio/loanaccount/domain/LoanTransaction.java b/fineract-provider/src/main/java/org/apache/fineract/portfolio/loanaccount/domain/LoanTransaction.java index 0da639319..938177fb6 100755 --- a/fineract-provider/src/main/java/org/apache/fineract/portfolio/loanaccount/domain/LoanTransaction.java +++ b/fineract-provider/src/main/java/org/apache/fineract/portfolio/loanaccount/domain/LoanTransaction.java @@ -386,6 +386,11 @@ public class LoanTransaction extends AbstractPersistableCustom { * * This accumulates the values passed to the already existent values for * each of the portions. + * + * @param principal principal + * @param interest interest + * @param feeCharges feeCharges + * @param penaltyCharges penaltyCharges */ public void updateComponents(final Money principal, final Money interest, final Money feeCharges, final Money penaltyCharges) { final MonetaryCurrency currency = principal.getCurrency(); diff --git a/fineract-provider/src/main/java/org/apache/fineract/portfolio/loanaccount/loanschedule/domain/DecliningBalanceInterestLoanScheduleGenerator.java b/fineract-provider/src/main/java/org/apache/fineract/portfolio/loanaccount/loanschedule/domain/DecliningBalanceInterestLoanScheduleGenerator.java index 1bbf261d2..2c564839e 100644 --- a/fineract-provider/src/main/java/org/apache/fineract/portfolio/loanaccount/loanschedule/domain/DecliningBalanceInterestLoanScheduleGenerator.java +++ b/fineract-provider/src/main/java/org/apache/fineract/portfolio/loanaccount/loanschedule/domain/DecliningBalanceInterestLoanScheduleGenerator.java @@ -39,7 +39,7 @@ import org.joda.time.LocalDate; *
        • Equal principal payments
          • *
        • Equal installment payments
          • * - *

          + *

          * *

          * When amortized using equal principal payments, the principal diff --git a/fineract-provider/src/main/java/org/apache/fineract/portfolio/loanaccount/rescheduleloan/data/LoanRescheduleRequestDataValidator.java b/fineract-provider/src/main/java/org/apache/fineract/portfolio/loanaccount/rescheduleloan/data/LoanRescheduleRequestDataValidator.java index 1203979b9..dcfc9d692 100644 --- a/fineract-provider/src/main/java/org/apache/fineract/portfolio/loanaccount/rescheduleloan/data/LoanRescheduleRequestDataValidator.java +++ b/fineract-provider/src/main/java/org/apache/fineract/portfolio/loanaccount/rescheduleloan/data/LoanRescheduleRequestDataValidator.java @@ -58,7 +58,7 @@ public class LoanRescheduleRequestDataValidator { * * @param jsonCommand * the JSON command object (instance of the JsonCommand class) - * @return void + * **/ public void validateForCreateAction(final JsonCommand jsonCommand, final Loan loan) { @@ -191,7 +191,7 @@ public class LoanRescheduleRequestDataValidator { * * @param jsonCommand * the JSON command object (instance of the JsonCommand class) - * @return void + * **/ public void validateForApproveAction(final JsonCommand jsonCommand, LoanRescheduleRequest loanRescheduleRequest) { final String jsonString = jsonCommand.json(); @@ -261,7 +261,7 @@ public class LoanRescheduleRequestDataValidator { * * @param jsonCommand * the JSON command object (instance of the JsonCommand class) - * @return void + * **/ public void validateForRejectAction(final JsonCommand jsonCommand, LoanRescheduleRequest loanRescheduleRequest) { final String jsonString = jsonCommand.json(); diff --git a/fineract-provider/src/main/java/org/apache/fineract/portfolio/loanaccount/rescheduleloan/domain/LoanRescheduleRequest.java b/fineract-provider/src/main/java/org/apache/fineract/portfolio/loanaccount/rescheduleloan/domain/LoanRescheduleRequest.java index 188d20af4..bf06f7712 100644 --- a/fineract-provider/src/main/java/org/apache/fineract/portfolio/loanaccount/rescheduleloan/domain/LoanRescheduleRequest.java +++ b/fineract-provider/src/main/java/org/apache/fineract/portfolio/loanaccount/rescheduleloan/domain/LoanRescheduleRequest.java @@ -267,7 +267,7 @@ public class LoanRescheduleRequest extends AbstractPersistableCustom { * * @param approvedByUser the user who approved the request * @param approvedOnDate the date of the approval - * @return void + * **/ public void approve(final AppUser approvedByUser, final LocalDate approvedOnDate) { @@ -284,7 +284,7 @@ public class LoanRescheduleRequest extends AbstractPersistableCustom { * * @param approvedByUser the user who approved the request * @param approvedOnDate the date of the approval - * @return void + * **/ public void reject(final AppUser approvedByUser, final LocalDate approvedOnDate) { diff --git a/fineract-provider/src/main/java/org/apache/fineract/portfolio/loanaccount/rescheduleloan/exception/LoanRescheduleRequestNotFoundException.java b/fineract-provider/src/main/java/org/apache/fineract/portfolio/loanaccount/rescheduleloan/exception/LoanRescheduleRequestNotFoundException.java index 9a8afcec5..9775290a3 100644 --- a/fineract-provider/src/main/java/org/apache/fineract/portfolio/loanaccount/rescheduleloan/exception/LoanRescheduleRequestNotFoundException.java +++ b/fineract-provider/src/main/java/org/apache/fineract/portfolio/loanaccount/rescheduleloan/exception/LoanRescheduleRequestNotFoundException.java @@ -29,7 +29,7 @@ public class LoanRescheduleRequestNotFoundException extends AbstractPlatformReso * LoanRescheduleRequestNotFoundException constructor * * @param requestId the loan reschedule request identifier - * @return void + * **/ public LoanRescheduleRequestNotFoundException(final Long requestId) { super("error.msg.loan.reschedule.request.id.invalid", diff --git a/fineract-provider/src/main/java/org/apache/fineract/portfolio/loanaccount/rescheduleloan/service/LoanRescheduleRequestWritePlatformServiceImpl.java b/fineract-provider/src/main/java/org/apache/fineract/portfolio/loanaccount/rescheduleloan/service/LoanRescheduleRequestWritePlatformServiceImpl.java index 7eccf9a51..977e7ba41 100644 --- a/fineract-provider/src/main/java/org/apache/fineract/portfolio/loanaccount/rescheduleloan/service/LoanRescheduleRequestWritePlatformServiceImpl.java +++ b/fineract-provider/src/main/java/org/apache/fineract/portfolio/loanaccount/rescheduleloan/service/LoanRescheduleRequestWritePlatformServiceImpl.java @@ -118,7 +118,7 @@ public class LoanRescheduleRequestWritePlatformServiceImpl implements LoanResche /** * LoanRescheduleRequestWritePlatformServiceImpl constructor * - * @return void + * **/ @Autowired public LoanRescheduleRequestWritePlatformServiceImpl(final CodeValueRepositoryWrapper codeValueRepositoryWrapper, @@ -585,7 +585,7 @@ public class LoanRescheduleRequestWritePlatformServiceImpl implements LoanResche * * @param dve * data integrity violation exception - * @return void + * **/ private void handleDataIntegrityViolation(final DataIntegrityViolationException dve) { diff --git a/fineract-provider/src/main/java/org/apache/fineract/portfolio/loanaccount/service/LoanWritePlatformServiceJpaRepositoryImpl.java b/fineract-provider/src/main/java/org/apache/fineract/portfolio/loanaccount/service/LoanWritePlatformServiceJpaRepositoryImpl.java index c0a6ae2ac..e5e54c642 100755 --- a/fineract-provider/src/main/java/org/apache/fineract/portfolio/loanaccount/service/LoanWritePlatformServiceJpaRepositoryImpl.java +++ b/fineract-provider/src/main/java/org/apache/fineract/portfolio/loanaccount/service/LoanWritePlatformServiceJpaRepositoryImpl.java @@ -447,7 +447,7 @@ public class LoanWritePlatformServiceJpaRepositoryImpl implements LoanWritePlatf * * @param loan * the disbursed loan - * @return void + * **/ private void createStandingInstruction(Loan loan) { diff --git a/fineract-provider/src/main/java/org/apache/fineract/portfolio/loanproduct/domain/InterestRecalculationCompoundingMethod.java b/fineract-provider/src/main/java/org/apache/fineract/portfolio/loanproduct/domain/InterestRecalculationCompoundingMethod.java index 2cea623e7..8b4d560fe 100644 --- a/fineract-provider/src/main/java/org/apache/fineract/portfolio/loanproduct/domain/InterestRecalculationCompoundingMethod.java +++ b/fineract-provider/src/main/java/org/apache/fineract/portfolio/loanproduct/domain/InterestRecalculationCompoundingMethod.java @@ -22,9 +22,10 @@ import java.util.HashMap; import java.util.Map; /*** - *

            + * * People typically use either of the following settings when defining interest * recalculation method: + *
              *
            • NONE
              • *
            • INTEREST
              • *
            • FEE
              • diff --git a/fineract-provider/src/main/java/org/apache/fineract/portfolio/loanproduct/domain/InterestRecalculationPeriodMethod.java b/fineract-provider/src/main/java/org/apache/fineract/portfolio/loanproduct/domain/InterestRecalculationPeriodMethod.java index 48090ef17..06c239548 100644 --- a/fineract-provider/src/main/java/org/apache/fineract/portfolio/loanproduct/domain/InterestRecalculationPeriodMethod.java +++ b/fineract-provider/src/main/java/org/apache/fineract/portfolio/loanproduct/domain/InterestRecalculationPeriodMethod.java @@ -22,9 +22,10 @@ import java.util.HashMap; import java.util.Map; /*** - *
                + * * People typically use either of the following settings when defining interest * recalculation method: + *
                  *
                • SAME_AS_REPAYMENT_PERIOD
                  • *
                • DAILY
                  • *
                • WEEKLY
                  • diff --git a/fineract-provider/src/main/java/org/apache/fineract/portfolio/loanproduct/domain/LoanRescheduleStrategyMethod.java b/fineract-provider/src/main/java/org/apache/fineract/portfolio/loanproduct/domain/LoanRescheduleStrategyMethod.java index 0c81e9971..a74a26b1c 100644 --- a/fineract-provider/src/main/java/org/apache/fineract/portfolio/loanproduct/domain/LoanRescheduleStrategyMethod.java +++ b/fineract-provider/src/main/java/org/apache/fineract/portfolio/loanproduct/domain/LoanRescheduleStrategyMethod.java @@ -22,9 +22,9 @@ import java.util.HashMap; import java.util.Map; /*** - *
                    - * People typically use either of the following settings when defining interest + * * People typically use either of the following settings when defining interest * recalculation method: + *
                      *
                    • RESCHEDULE_NEXT_REPAYMENTS
                      • *
                    • REDUCE_NUMBER_OF_INSTALLMENTS
                      • *
                    • REDUCE_EMI_AMOUNT
                      • diff --git a/fineract-provider/src/main/java/org/apache/fineract/portfolio/savings/DepositAccountOnClosureType.java b/fineract-provider/src/main/java/org/apache/fineract/portfolio/savings/DepositAccountOnClosureType.java index c3f19a37d..78a506bb2 100644 --- a/fineract-provider/src/main/java/org/apache/fineract/portfolio/savings/DepositAccountOnClosureType.java +++ b/fineract-provider/src/main/java/org/apache/fineract/portfolio/savings/DepositAccountOnClosureType.java @@ -26,7 +26,7 @@ import org.apache.fineract.portfolio.savings.domain.RecurringDepositAccount; /** * An enumeration of different options available on account closure - * {@link FixedDepositAccount} & {@link RecurringDepositAccount}. + * {@link FixedDepositAccount} & {@link RecurringDepositAccount}. */ public enum DepositAccountOnClosureType { diff --git a/fineract-provider/src/main/java/org/apache/fineract/portfolio/savings/SavingsInterestCalculationDaysInYearType.java b/fineract-provider/src/main/java/org/apache/fineract/portfolio/savings/SavingsInterestCalculationDaysInYearType.java index 0630f9896..e9ec9b150 100644 --- a/fineract-provider/src/main/java/org/apache/fineract/portfolio/savings/SavingsInterestCalculationDaysInYearType.java +++ b/fineract-provider/src/main/java/org/apache/fineract/portfolio/savings/SavingsInterestCalculationDaysInYearType.java @@ -22,9 +22,10 @@ import java.util.ArrayList; import java.util.List; /** - *
                        + * * People typically use either of the following settings when calculating there * interest using the daily method: + *
                          *
                        • 360 and
                          • *
                        • 365
                          • *
                        diff --git a/fineract-provider/src/main/java/org/apache/fineract/portfolio/savings/SavingsInterestCalculationType.java b/fineract-provider/src/main/java/org/apache/fineract/portfolio/savings/SavingsInterestCalculationType.java index d9800f8d8..922e519a6 100644 --- a/fineract-provider/src/main/java/org/apache/fineract/portfolio/savings/SavingsInterestCalculationType.java +++ b/fineract-provider/src/main/java/org/apache/fineract/portfolio/savings/SavingsInterestCalculationType.java @@ -22,8 +22,9 @@ import java.util.ArrayList; import java.util.List; /** - *
                          + * * There are two methods to calculate the interest on a savings account: + *
                            *
                          • The daily balance method; and
                            • *
                          • The average daily balance method.
                            • *
                          diff --git a/fineract-provider/src/main/java/org/apache/fineract/portfolio/savings/domain/DepositAccountDomainServiceJpa.java b/fineract-provider/src/main/java/org/apache/fineract/portfolio/savings/domain/DepositAccountDomainServiceJpa.java index ac277fb08..4082b143f 100644 --- a/fineract-provider/src/main/java/org/apache/fineract/portfolio/savings/domain/DepositAccountDomainServiceJpa.java +++ b/fineract-provider/src/main/java/org/apache/fineract/portfolio/savings/domain/DepositAccountDomainServiceJpa.java @@ -191,7 +191,7 @@ public class DepositAccountDomainServiceJpa implements DepositAccountDomainServi */ updateExistingTransactionsDetails(account, existingTransactionIds, existingReversedTransactionIds); /* - * <<<<<<< HEAD final SavingsAccountTransactionDTO transactionDTO = new + * final SavingsAccountTransactionDTO transactionDTO = new * SavingsAccountTransactionDTO(fmt, transactionDate, transactionAmount, * paymentDetail, new Date()); final SavingsAccountTransaction deposit = * account.deposit(transactionDTO); boolean isInterestTransfer = false; diff --git a/fineract-provider/src/main/java/org/apache/fineract/portfolio/savings/service/SavingsAccountWritePlatformServiceJpaRepositoryImpl.java b/fineract-provider/src/main/java/org/apache/fineract/portfolio/savings/service/SavingsAccountWritePlatformServiceJpaRepositoryImpl.java index 2064f57ee..70f8ce74e 100755 --- a/fineract-provider/src/main/java/org/apache/fineract/portfolio/savings/service/SavingsAccountWritePlatformServiceJpaRepositoryImpl.java +++ b/fineract-provider/src/main/java/org/apache/fineract/portfolio/savings/service/SavingsAccountWritePlatformServiceJpaRepositoryImpl.java @@ -1315,7 +1315,7 @@ public class SavingsAccountWritePlatformServiceJpaRepositoryImpl implements Savi * Disable all standing instructions linked to the savings account if the status is "closed" * * @param savingsAccount -- the savings account object - * @return None + * **/ @Transactional private void disableStandingInstructionsLinkedToClosedSavings(final SavingsAccount savingsAccount) { diff --git a/fineract-provider/src/main/java/org/apache/fineract/portfolio/transfer/service/TransferWritePlatformServiceJpaRepositoryImpl.java b/fineract-provider/src/main/java/org/apache/fineract/portfolio/transfer/service/TransferWritePlatformServiceJpaRepositoryImpl.java index 7dfc6d675..d037c1612 100755 --- a/fineract-provider/src/main/java/org/apache/fineract/portfolio/transfer/service/TransferWritePlatformServiceJpaRepositoryImpl.java +++ b/fineract-provider/src/main/java/org/apache/fineract/portfolio/transfer/service/TransferWritePlatformServiceJpaRepositoryImpl.java @@ -140,11 +140,12 @@ public class TransferWritePlatformServiceJpaRepositoryImpl implements TransferWr } /**** - * Variables that would make sense
                          + * Variables that would make sense
                          *
                            *
                          • inheritDestinationGroupLoanOfficer: Default true
                            • *
                          • newStaffId: Optional field with Id of new Loan Officer to be linked * to this client and all his JLG loans for this group
                            • + *
                          * ***/ @Transactional public void transferClientBetweenGroups(final Group sourceGroup, final Client client, final Group destinationGroup, @@ -248,10 +249,9 @@ public class TransferWritePlatformServiceJpaRepositoryImpl implements TransferWr /** * This API is meant for transferring clients between branches mainly by - * Organizations following an Individual lending Model
                          + * Organizations following an Individual lending Model
                          * * @param clientId - * @param destinationOfficeId * @param jsonCommand * @return **/ @@ -277,13 +277,12 @@ public class TransferWritePlatformServiceJpaRepositoryImpl implements TransferWr /** * This API is meant for transferring clients between branches mainly by - * Organizations following an Individual lending Model
                          + * Organizations following an Individual lending Model
                          * If the Client is linked to any Groups, we can optionally choose to have * all the linkages broken and all JLG Loans are converted into Individual * Loans * * @param clientId - * @param destinationOfficeId * @param jsonCommand * @return **/ @@ -306,13 +305,12 @@ public class TransferWritePlatformServiceJpaRepositoryImpl implements TransferWr /** * This API is meant for transferring clients between branches mainly by - * Organizations following an Individual lending Model
                          + * Organizations following an Individual lending Model
                          * If the Client is linked to any Groups, we can optionally choose to have * all the linkages broken and all JLG Loans are converted into Individual * Loans * * @param clientId - * @param destinationOfficeId * @param jsonCommand * @return **/