Package com.apple.foundationdb.record.provider.foundationdb

Interface SubspaceProvider

All Known Implementing Classes:

SubspaceProviderByKeySpacePath, SubspaceProviderBySubspace

@API(INTERNAL)
public interface SubspaceProvider

Subspace provider can provide a subspace (might be blocking) and logging information to the subspace (non-blocking).

Method Summary

Modifier and Type	Method	Description
Subspace	getSubspace(FDBRecordContext context)	This might be blocking if the subspace is never fetched before.
CompletableFuture<Subspace>	getSubspaceAsync(FDBRecordContext context)	Asynchronously resolves the subspace against the database associated with FDBRecordContext.
LogMessageKeys	logKey()
String	toString()
String	toString(FDBRecordContext context)	This method is typically called in support of error logging; hence, implementations should not assume a working FDBRecordContext but might, for example, use it to retrieve a subspace previously resolved against the corresponding database.

Method Detail

getSubspace

@Nonnull
Subspace getSubspace(@Nonnull
                     FDBRecordContext context)

This might be blocking if the subspace is never fetched before.

Parameters:

context - record context used to resolve the subspace

Returns:

Subspace

getSubspaceAsync

@Nonnull
CompletableFuture<Subspace> getSubspaceAsync(@Nonnull
                                             FDBRecordContext context)

Asynchronously resolves the subspace against the database associated with FDBRecordContext.

Parameters:

context - record context used to resolve the subspace

Returns:

CompletableFuture<Subspace>

logKey

@Nonnull
LogMessageKeys logKey()

toString

String toString(@Nonnull
                FDBRecordContext context)

This method is typically called in support of error logging; hence, implementations should not assume a working FDBRecordContext but might, for example, use it to retrieve a subspace previously resolved against the corresponding database.

Parameters:

context - record context used to resolve the subspace

Returns:

CompletableFuture<Subspace>

toString

String toString()

Overrides:

toString in class Object