Skip to content

Add a getImplementationName method to VectorizationProvider that returns the name of the selected implementation #15294

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Add a getImplementationName method to VectorizationProvider that returns the name of the selected implementation #15294

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions lucene/core/src/java/org/apache/lucene/internal/vectorization/VectorizationProvider.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,11 @@ public static VectorizationProvider getInstance() {
Holder.INSTANCE, "call to getInstance() from subclass of VectorizationProvider");
}

/** Returns the name of the {@code VectorizationProvider}'s implementation that's being used. */
public static String getImplementationName() {
return Objects.requireNonNull(Holder.INSTANCE).getName();
}

VectorizationProvider() {
// no instance/subclass except from this package
}
Expand Down Expand Up @@ -224,6 +229,10 @@ private static void ensureCaller() {
}
}

public String getName() {
return this.getClass().getSimpleName();
}

/** This static holder class prevents classloading deadlock. */
private static final class Holder {
private Holder() {}
Expand Down
4 changes: 4 additions & 0 deletions lucene/core/src/test/org/apache/lucene/internal/vectorization/TestVectorizationProvider.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,10 @@ public void testCallerOfGetter() {
expectThrows(UnsupportedOperationException.class, TestVectorizationProvider::illegalCaller);
}

public void testGetProviderName() {
assertEquals("DefaultVectorizationProvider", VectorizationProvider.getImplementationName());
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is all makes sense to me, but I'm wondering under what circumstances we would have an alternate provider and whether we can test that. Is that something that only happens in the MRJAR code? If that's right, do we have MRJAR-specific tests where we could test that this also works when we have a non-default provider?

}

private static void illegalCaller() {
VectorizationProvider.getInstance();
}
Expand Down
Loading