Skip to content

Add clear deprecation path from factory builder method. #327

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

Merged
merged 1 commit into from
Aug 11, 2019
Merged

Add clear deprecation path from factory builder method. #327

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
20 changes: 18 additions & 2 deletions core-api/src/main/java/com/optimizely/ab/Optimizely.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -967,6 +967,22 @@ public <T> int addNotificationHandler(Class<T> clazz, NotificationHandler<T> han
}

//======== Builder ========//

/**
* This overloaded factory method is deprecated in favor of pure builder methods.
* Please use {@link com.optimizely.ab.Optimizely#builder()} along with
* {@link Builder#withDatafile(java.lang.String)} and
* {@link Builder#withEventHandler(com.optimizely.ab.event.EventHandler)}
* respectively.
*
* Example:
* <pre>
* Optimizely optimizely = Optimizely.builder()
* .withDatafile(datafile)
* .withEventHandler(eventHandler)
* .build();
* </pre>
*/
@Deprecated
public static Builder builder(@Nonnull String datafile,
@Nonnull EventHandler eventHandler) {
Expand Down Expand Up @@ -1054,12 +1070,12 @@ public Builder withNotificationCenter(NotificationCenter notificationCenter) {
return this;
}

// Helper function for making testing easier
protected Builder withDatafile(String datafile) {
public Builder withDatafile(String datafile) {
this.datafile = datafile;
return this;
}

// Helper functions for making testing easier
protected Builder withBucketing(Bucketer bucketer) {
this.bucketer = bucketer;
return this;
Expand Down