From db8d1211414dfbd4b3230abe869a3edd039f8b66 Mon Sep 17 00:00:00 2001 From: andrewlalis Date: Mon, 1 Jan 2024 11:27:01 -0500 Subject: [PATCH] Added some docs. --- .../java/com/andrewlalis/perfin/data/DataSource.java | 9 +++++++++ .../perfin/data/impl/JdbcAccountRepository.java | 4 ++-- 2 files changed, 11 insertions(+), 2 deletions(-) diff --git a/src/main/java/com/andrewlalis/perfin/data/DataSource.java b/src/main/java/com/andrewlalis/perfin/data/DataSource.java index 18099a8..2956c11 100644 --- a/src/main/java/com/andrewlalis/perfin/data/DataSource.java +++ b/src/main/java/com/andrewlalis/perfin/data/DataSource.java @@ -15,7 +15,16 @@ import java.util.List; import java.util.Map; import java.util.function.Consumer; +/** + * Interface for methods to obtain any data from a {@link com.andrewlalis.perfin.model.Profile} + * instance. Usually, you'll obtain a repository to interact with entities of a + * certain type. + */ public interface DataSource { + /** + * Gets the directory in which file content is stored. + * @return The content directory. + */ Path getContentDir(); AccountRepository getAccountRepository(); diff --git a/src/main/java/com/andrewlalis/perfin/data/impl/JdbcAccountRepository.java b/src/main/java/com/andrewlalis/perfin/data/impl/JdbcAccountRepository.java index 50ab7ef..b8ee943 100644 --- a/src/main/java/com/andrewlalis/perfin/data/impl/JdbcAccountRepository.java +++ b/src/main/java/com/andrewlalis/perfin/data/impl/JdbcAccountRepository.java @@ -1,10 +1,10 @@ package com.andrewlalis.perfin.data.impl; import com.andrewlalis.perfin.data.AccountRepository; -import com.andrewlalis.perfin.data.util.DateUtil; -import com.andrewlalis.perfin.data.util.DbUtil; import com.andrewlalis.perfin.data.pagination.Page; import com.andrewlalis.perfin.data.pagination.PageRequest; +import com.andrewlalis.perfin.data.util.DateUtil; +import com.andrewlalis.perfin.data.util.DbUtil; import com.andrewlalis.perfin.model.Account; import com.andrewlalis.perfin.model.AccountEntry; import com.andrewlalis.perfin.model.AccountType;