Module methanol

Package com.github.mizosoft.methanol

Class CacheControl.Builder

java.lang.Object

com.github.mizosoft.methanol.CacheControl.Builder

Enclosing class:

CacheControl

public static final class CacheControl.Builder
extends Object

A builder of CacheControl instances, with explicit directive setters for request cache directives.

Methods that accept a Duration drop any precision finer than that of a second, which is the only precision allowed by cache directives representing durations. Additionally, any duration with number of seconds that's larger than Integer.MAX_VALUE is truncated to that value.

Method Summary

Modifier and Type	Method	Description
CacheControl.Builder	anyMaxStale()	Sets the max-stale directive to accept any stale response.
CacheControl	build()	Builds a new Cache-Control.
CacheControl.Builder	directive(String directive)	Sets the given directive with no argument.
CacheControl.Builder	directive(String directive, String argument)	Sets the given directive to the given argument.
CacheControl.Builder	maxAge(Duration maxAge)	Sets the max-age directive to the given duration.
CacheControl.Builder	maxStale(Duration maxStale)	Sets the max-stale directive to the given duration.
CacheControl.Builder	minFresh(Duration minFresh)	Sets the min-fresh directive to the given duration.
CacheControl.Builder	noCache()	Sets the no-cache directive.
CacheControl.Builder	noStore()	Sets the no-store directive.
CacheControl.Builder	noTransform()	Sets the no-transform directive.
CacheControl.Builder	onlyIfCached()	Sets the only-if-cached directive.
CacheControl.Builder	staleIfError(Duration staleIfError)	Sets the stale-if-error directive to the given duration.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

directive

public CacheControl.Builder directive(String directive)

Sets the given directive with no argument.

Throws:

IllegalArgumentException - if directive is invalid

directive

public CacheControl.Builder directive(String directive,
 String argument)

Sets the given directive to the given argument. If argument is an empty string, the directive is considered one without argument.

Throws:

IllegalArgumentException - if either of directive or argument is invalid

maxAge

public CacheControl.Builder maxAge(Duration maxAge)

Sets the max-age directive to the given duration.

Throws:

IllegalArgumentException - If maxAge doesn't contain a positive number of seconds

minFresh

public CacheControl.Builder minFresh(Duration minFresh)

Sets the min-fresh directive to the given duration.

Throws:

IllegalArgumentException - If minFresh doesn't contain a positive number of seconds

maxStale

public CacheControl.Builder maxStale(Duration maxStale)

Sets the max-stale directive to the given duration.

Throws:

IllegalArgumentException - If maxStale doesn't contain a positive number of seconds

anyMaxStale

public CacheControl.Builder anyMaxStale()

Sets the max-stale directive to accept any stale response.

staleIfError

public CacheControl.Builder staleIfError(Duration staleIfError)

Sets the stale-if-error directive to the given duration.

Throws:

IllegalArgumentException - If staleIfError doesn't contain a positive number of seconds

noCache

public CacheControl.Builder noCache()

Sets the no-cache directive.

noStore

public CacheControl.Builder noStore()

Sets the no-store directive.

noTransform

public CacheControl.Builder noTransform()

Sets the no-transform directive.

onlyIfCached

public CacheControl.Builder onlyIfCached()

Sets the only-if-cached directive.

build

public CacheControl build()

Builds a new Cache-Control.