Add some docs for Cache class #4375
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
JakeWharton
reviewed
Nov 6, 2018
| * Create a cache which will reside in {@code directory}. | ||
| * | ||
| * @param directory a writable directory | ||
| * @param maxSize the maximum number of bytes this cache should use to store |
There was a problem hiding this comment.
If you add {@code maxSize} in the sentence above you can drop these two @param tags. Maybe Create a cache of at most {@code maxSize} bytes in {@code directory}.?
There was a problem hiding this comment.
Sounds good! Updated
PromanSEW
reviewed
Nov 7, 2018
| @@ -379,6 +382,7 @@ public long size() throws IOException { | |||
| return cache.size(); | |||
| } | |||
|
|
|||
| /** Max size of the cache (in bytes). */ | |||
SeniorZhai
added a commit
to SeniorZhai/okhttp
that referenced
this pull request
Nov 15, 2018
* commit '1f7e796e6e658df34a98276b2092a81de118937d': Cleanup HttpLoggingInterceptor (square#4346) Add a LoggingEventListener and use it in okcurl (square#4353) Preemptive auth for proxy CONNECT Relax handling of Cache-Control: immutable Add some docs for Cache class (square#4375) Fix connection leaks on failed web socket upgrades. Don't specify a crypto provider in HeldCertificate. Confirm that call timeouts don't apply to SSE or web sockets. Add APIs to configure the client's default call timeout. (square#4369) Recover from executor shutdowns gracefully. (square#4365) Make the nested BasicAuthInterceptor static (square#4368) Add basic auth interceptor recipe (square#4336) Whole operation timeouts Make scheme names case-sensitive again. Remove colon when scheme missing in builder toString (square#4361) CipherSuite init speedup (square#4340) Limit the use of regexes in the RFC 7235 challenge parser. Allow incomplete url builder toString usage (square#4357) APIs to set date headers Upgrade Conscrypt to 1.4.0 (was 1.3.0)
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.
I was looking into the docs and could not see from the constructor what the size was in terms of. Turns out it is bytes. Hopefully this will help others save a step on figuring this out 😉