Skip to content

Commit 565752e

Browse files
committed
Put in API annotations
1 parent 65f1a33 commit 565752e

22 files changed

+102
-1
lines changed

src/main/java/org/dataloader/BatchLoader.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,7 @@
7171
* @author <a href="https://github.com/bbakerman/">Brad Baker</a>
7272
*/
7373
@FunctionalInterface
74+
@PublicSpi
7475
public interface BatchLoader<K, V> {
7576

7677
/**

src/main/java/org/dataloader/BatchLoaderContextProvider.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
* provide overall calling context to the {@link org.dataloader.BatchLoader} call. A common use
66
* case is for propagating user security credentials or database connection parameters for example.
77
*/
8+
@PublicSpi
89
public interface BatchLoaderContextProvider {
910
/**
1011
* @return a context object that may be needed in batch load calls

src/main/java/org/dataloader/BatchLoaderEnvironment.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212
* This object is passed to a batch loader as calling context. It could contain security credentials
1313
* of the calling users for example or database parameters that allow the data layer call to succeed.
1414
*/
15+
@PublicApi
1516
public class BatchLoaderEnvironment {
1617

1718
private final Object context;

src/main/java/org/dataloader/BatchLoaderEnvironmentProvider.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
* the {@link org.dataloader.BatchLoader} call. A common use
77
* case is for propagating user security credentials or database connection parameters.
88
*/
9+
@PublicSpi
910
public interface BatchLoaderEnvironmentProvider {
1011
/**
1112
* @return a {@link org.dataloader.BatchLoaderEnvironment} that may be needed in batch calls

src/main/java/org/dataloader/BatchLoaderWithContext.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@
1111
* See {@link org.dataloader.BatchLoader} for more details on the design invariants that you must implement in order to
1212
* use this interface.
1313
*/
14+
@PublicSpi
1415
public interface BatchLoaderWithContext<K, V> {
1516
/**
1617
* Called to batch load the provided keys and return a promise to a list of values. This default

src/main/java/org/dataloader/CacheMap.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@
3535
* @author <a href="https://github.com/aschrijver/">Arnold Schrijver</a>
3636
* @author <a href="https://github.com/bbakerman/">Brad Baker</a>
3737
*/
38+
@PublicSpi
3839
public interface CacheMap<U, V> {
3940

4041
/**

src/main/java/org/dataloader/DataLoader.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,7 @@
5454
* @author <a href="https://github.com/aschrijver/">Arnold Schrijver</a>
5555
* @author <a href="https://github.com/bbakerman/">Brad Baker</a>
5656
*/
57+
@PublicApi
5758
public class DataLoader<K, V> {
5859

5960
private final DataLoaderHelper<K, V> helper;

src/main/java/org/dataloader/DataLoaderHelper.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@
2626
* @param <K> the type of keys
2727
* @param <V> the type of values
2828
*/
29+
@Internal
2930
class DataLoaderHelper<K, V> {
3031

3132

src/main/java/org/dataloader/DataLoaderOptions.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@
2929
*
3030
* @author <a href="https://github.com/aschrijver/">Arnold Schrijver</a>
3131
*/
32+
@PublicApi
3233
public class DataLoaderOptions {
3334

3435
private static final BatchLoaderContextProvider NULL_PROVIDER = () -> null;

src/main/java/org/dataloader/DataLoaderRegistry.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
* they can be dispatched as one. It also allows you to retrieve data loaders by
1616
* name from a central place
1717
*/
18+
@PublicApi
1819
public class DataLoaderRegistry {
1920
private final Map<String, DataLoader<?, ?>> dataLoaders = new ConcurrentHashMap<>();
2021

0 commit comments

Comments
 (0)