Skip to content

Commit

Permalink
Polish javadoc
Browse files Browse the repository at this point in the history
  • Loading branch information
arman-ddl committed Sep 3, 2024
1 parent 5ca845e commit f8ce47e
Showing 1 changed file with 6 additions and 5 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -21,17 +21,18 @@ public interface TableDataService {
TableLocationProvider getTableLocationProvider(@NotNull TableKey tableKey);

/**
* Request the raw {@link TableLocationProvider} from this service that provides the {@link TableLocation} for
* {@code tableKey} and {@code tableLocationKey}. A raw {@link TableLocationProvider} does not compose multiple
* Request the single raw {@link TableLocationProvider} from this service that provides the {@link TableLocation}
* for {@code tableKey} and {@code tableLocationKey}. A raw {@link TableLocationProvider} does not compose multiple
* {@link TableLocationProvider TableLocationProviders} or delegate to other implementations.
*
* @param tableKey The {@link TableKey} to lookup
* @param tableLocationKey The {@link TableLocationKey} to lookup
* @return The raw {@link TableLocationProvider} that provides the {@link TableLocation} for {@code tableKey} and
* {@code tableLocationKey}, or {@code null} if there is none
* @implSpec Non-raw {@link TableDataService TableDataServices} must implement this method to provide a raw
* {@link TableLocationProvider}.
* @throws TableDataException If tableLocationKey is provided by more than one {@link TableLocationProvider}
* @implSpec Non-raw {@link TableDataService TableDataServices} must implement this method to provide a single raw
* {@link TableLocationProvider} or throw a {@link TableDataException} if there is ambiguity.
* @throws TableDataException If the {@link TableLocation} is provided by more than one
* {@link TableLocationProvider}
*/
@Nullable
default TableLocationProvider getRawTableLocationProvider(@NotNull final TableKey tableKey,
Expand Down

0 comments on commit f8ce47e

Please sign in to comment.