Fix public APIs for kotlin.time.Duration #8355
Merged
Conversation
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
Use this as our preferred API for accepting a duration in OkHttpClient and CacheControl. Also hide these functions from the Java API.
JakeWharton
approved these changes
Apr 10, 2024
| maxAge: Int, | ||
| timeUnit: DurationUnit, | ||
| ) = commonMaxAge(maxAge, timeUnit) | ||
| @JvmSynthetic // Don't expose @JvmInline types in the Java API. |
There was a problem hiding this comment.
You shouldn't need any of these annotations as functions accepting value types should already have their names mangled to include a hypen which is an invalid character in Java method names. The API dump should confirm.
| ) = commonMaxAge(maxAge, timeUnit) | ||
| @JvmSynthetic // Don't expose @JvmInline types in the Java API. | ||
| fun maxAge(maxAge: Duration) = apply { | ||
| require(maxAge.inWholeSeconds >= 0) { "maxAge < 0: ${maxAge.inWholeSeconds}" } |
There was a problem hiding this comment.
If you do
Suggested change
| require(maxAge.inWholeSeconds >= 0) { "maxAge < 0: ${maxAge.inWholeSeconds}" } | |
| require(!maxAge.isNegative()) { "maxAge < 0: ${maxAge.inWholeSeconds}" } |
you avoid having to do an internal conversion solely to perform the check
There was a problem hiding this comment.
Fixed to call inWholeSeconds once.
swankjesse
commented
Apr 14, 2024
| * precision; finer precision will be lost. | ||
| */ | ||
| @ExperimentalOkHttpApi |
There was a problem hiding this comment.
No longer experimental!
| maxAge: Int, | ||
| timeUnit: DurationUnit, | ||
| ) = commonMaxAge(maxAge, timeUnit) | ||
| @JvmSynthetic // Don't expose @JvmInline types in the Java API. |
| ) = commonMaxAge(maxAge, timeUnit) | ||
| @JvmSynthetic // Don't expose @JvmInline types in the Java API. | ||
| fun maxAge(maxAge: Duration) = apply { | ||
| require(maxAge.inWholeSeconds >= 0) { "maxAge < 0: ${maxAge.inWholeSeconds}" } |
There was a problem hiding this comment.
Fixed to call inWholeSeconds once.
This comment was marked as off-topic.
This comment was marked as off-topic.
This comment was marked as off-topic.
This comment was marked as off-topic.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Use this as our preferred API for accepting a duration in OkHttpClient and CacheControl.
Also hide these functions from the Java API.