Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add CheckingPeriod and Timeout subclasses to WaitForOption
- Loading branch information
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -16,39 +16,47 @@ | |
|
|
||
| package com.google.cloud; | ||
|
|
||
| import static com.google.common.base.MoreObjects.firstNonNull; | ||
| import static com.google.common.base.Preconditions.checkArgument; | ||
|
|
||
| import com.google.common.base.MoreObjects; | ||
|
|
||
| import java.io.Serializable; | ||
| import java.util.Objects; | ||
| import java.util.concurrent.TimeUnit; | ||
|
|
||
| /** | ||
| * This class represents options for methods that wait for changes in the status of a resource. | ||
| */ | ||
| public abstract class WaitForOption implements Serializable { | ||
|
|
||
| private static final long serialVersionUID = 8443451708032349243L; | ||
|
|
||
| private final OptionType optionType; | ||
|
|
||
| enum OptionType { | ||
| CHECKING_PERIOD, | ||
| TIMEOUT | ||
| } | ||
|
|
||
| private WaitForOption(OptionType optionType) { | ||
| this.optionType = optionType; | ||
| } | ||
|
|
||
| /** | ||
| * This class represents an option to set how frequently the resource status should be checked. | ||
| * Objects of this class keep the actual period and related time unit for the checking period. | ||
| */ | ||
| public static final class CheckingPeriod extends WaitForOption { | ||
|
|
||
| private static final long serialVersionUID = -2481062893220539210L; | ||
| private static final CheckingPeriod DEFAULT = new CheckingPeriod(500, TimeUnit.MILLISECONDS); | ||
|
|
||
| private final long period; | ||
| private final TimeUnit unit; | ||
|
|
||
| private CheckingPeriod(long period, TimeUnit unit) { | ||
| super(OptionType.CHECKING_PERIOD); | ||
| this.period = period; | ||
| this.unit = unit; | ||
| } | ||
|
|
@@ -85,12 +93,14 @@ public boolean equals(Object obj) { | |
| return false; | ||
| } | ||
| CheckingPeriod other = (CheckingPeriod) obj; | ||
| return baseEquals(other) | ||
| && Objects.equals(period, other.period) | ||
| && Objects.equals(unit, other.unit); | ||
| } | ||
|
|
||
| @Override | ||
| public int hashCode() { | ||
| return Objects.hash(baseHashCode(), period, unit); | ||
| } | ||
|
|
||
| @Override | ||
|
|
@@ -102,73 +112,110 @@ public String toString() { | |
| } | ||
|
|
||
| /** | ||
| * Returns the {@code CheckingPeriod} option specified in {@code options}. If no | ||
| * {@code CheckingPeriod} could be found among {@code options}, the default checking period (500 | ||
| * milliseconds) is used. | ||
| */ | ||
| public static CheckingPeriod getOrDefault(WaitForOption... options) { | ||
| return getOrDefaultInternal(OptionType.CHECKING_PERIOD, DEFAULT, options); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * This class represents an option to set the maximum time to wait for the resource's status to | ||
| * reach the desired state. | ||
| */ | ||
| public static final class Timeout extends WaitForOption { | ||
|
|
||
| private static final long serialVersionUID = -7120401111985321932L; | ||
| private static final Timeout DEFAULT = new Timeout(-1); | ||
|
|
||
| private final long timeoutMillis; | ||
|
|
||
| private Timeout(long timeoutMillis) { | ||
| super(OptionType.TIMEOUT); | ||
| this.timeoutMillis = timeoutMillis; | ||
| } | ||
|
|
||
| /** | ||
| * Returns the timeout in milliseconds. | ||
| */ | ||
| public long timeoutMillis() { | ||
| return timeoutMillis; | ||
| } | ||
|
|
||
| @Override | ||
| public boolean equals(Object obj) { | ||
| if (obj == this) { | ||
| return true; | ||
| } | ||
| if (obj == null || !(obj instanceof Timeout)) { | ||
| return false; | ||
| } | ||
| Timeout other = (Timeout) obj; | ||
| return baseEquals(other) && Objects.equals(timeoutMillis, other.timeoutMillis); | ||
| } | ||
|
|
||
| @Override | ||
| public int hashCode() { | ||
| return Objects.hash(baseHashCode(), timeoutMillis); | ||
| } | ||
|
|
||
| @Override | ||
| public String toString() { | ||
| return MoreObjects.toStringHelper(this) | ||
| .add("timeoutMillis", timeoutMillis) | ||
| .toString(); | ||
| } | ||
|
|
||
| /** | ||
| * Returns the {@code Timeout} option specified in {@code options}. If no {@code Timeout} could | ||
| * be found among {@code options}, no timeout will be used. | ||
| */ | ||
| public static Timeout getOrDefault(WaitForOption... options) { | ||
| return getOrDefaultInternal(OptionType.TIMEOUT, DEFAULT, options); | ||
| } | ||
| } | ||
|
|
||
| OptionType optionType() { | ||
| return optionType; | ||
| } | ||
|
|
||
| final boolean baseEquals(WaitForOption option) { | ||
| return Objects.equals(option.optionType, option.optionType); | ||
| } | ||
|
|
||
| @Override | ||
| public boolean equals(Object obj) { | ||
| if (obj == this) { | ||
| return true; | ||
| } | ||
| if (obj == null || !(obj.getClass().equals(WaitForOption.class))) { | ||
This comment has been minimized.
Sorry, something went wrong. |
||
| return false; | ||
| } | ||
| return baseEquals((WaitForOption) obj); | ||
| } | ||
|
|
||
| final int baseHashCode() { | ||
| return Objects.hash(optionType); | ||
| } | ||
|
|
||
| @Override | ||
| public int hashCode() { | ||
| return baseHashCode(); | ||
| } | ||
|
|
||
| @SuppressWarnings("unchecked") | ||
| private static <T extends WaitForOption> T getOrDefaultInternal(OptionType optionType, | ||
| T defaultValue, WaitForOption... options) { | ||
| T foundOption = null; | ||
| for (WaitForOption option : options) { | ||
| if (option.optionType.equals(optionType)) { | ||
| checkArgument(foundOption == null, "Duplicate option %s", option); | ||
| foundOption = (T) option; | ||
| } | ||
| } | ||
| return firstNonNull(foundOption, defaultValue); | ||
This comment has been minimized.
Sorry, something went wrong. 
aozarov
Contributor
|
||
| } | ||
|
|
||
| /** | ||
|
|
@@ -177,9 +224,9 @@ public String toString() { | |
| * @param checkEvery the checking period | ||
| * @param unit the time unit of the checking period | ||
| */ | ||
| public static CheckingPeriod checkEvery(long checkEvery, TimeUnit unit) { | ||
| checkArgument(checkEvery >= 0, "checkEvery must be >= 0"); | ||
| return new CheckingPeriod(checkEvery, unit); | ||
| } | ||
|
|
||
| /** | ||
|
|
@@ -188,17 +235,8 @@ public static WaitForOption checkEvery(long checkEvery, TimeUnit unit) { | |
| * @param timeout the maximum time to wait, expressed in {@code unit} | ||
| * @param unit the time unit of the timeout | ||
| */ | ||
| public static Timeout timeout(long timeout, TimeUnit unit) { | ||
| checkArgument(timeout >= 0, "timeout must be >= 0"); | ||
| return new Timeout(unit.toMillis(timeout)); | ||
| } | ||
| } | ||
Oops, something went wrong.
I am not sure if you need the equals/hashCode in this class.
Also, this will always be false as this is an abstract class.