Jakarta EE 11.0.0 · jakarta.ws.rs.core.CacheControl · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
private Map<String, String>	cacheExtension
private static final RuntimeDelegate.HeaderDelegate<CacheControl>	HEADER_DELEGATE Deprecated This field will be removed in a future version. See https://github.com/jakartaee/rest/issues/607
private int	maxAge
private boolean	mustRevalidate
private boolean	noCache
private List<String>	noCacheFields
private boolean	noStore
private boolean	noTransform
private List<String>	privateFields
private boolean	privateFlag
private boolean	proxyRevalidate
private int	sMaxAge

Access	Constructor and Description
public	CacheControl() Create a new instance of CacheControl.

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: true if the two cache controls are the same, false otherwise. equals(final Object the object to compare to obj) Overrides java.lang.Object.equals. Compares object argument to this cache control to see if they are the same considering all property values.
public Map<String, String>	Returns: a mutable map of cache control extension names and their values. If a key has a null value, it will appear as a bare directive. If a key has a value that contains no whitespace then the directive will appear as a simple name=value pair. If a key has a value that contains whitespace then the directive will appear as a quoted name="value" pair. getCacheExtension() Corresponds to a set of extension cache control directives.
public int	Returns: the value of the max-age cache control directive, -1 if the directive is disabled. getMaxAge() Corresponds to the max-age cache control directive.
public List<String>	Returns: a mutable list of field-names that will form the value of the no-cache cache control directive. An empty list results in a bare no-cache directive. getNoCacheFields() Corresponds to the value of the no-cache cache control directive.
public List<String>	Returns: a mutable list of field-names that will form the value of the private cache control directive. An empty list results in a bare no-cache directive. getPrivateFields() Corresponds to the value of the private cache control directive.
public int	Returns: the value of the s-maxage cache control directive, -1 if the directive is disabled. getSMaxAge() Corresponds to the s-maxage cache control directive.
public int	Returns: the hashCode hashCode() Overrides java.lang.Object.hashCode. Generate hash code from cache control properties.
private static int	Returns: hash code for the collection, if `null` or empty, the returned hash code is `0` (zero). hashCodeOf(final Collection<?> collection, may be `null`. instance) Compute a `Object#hashCode` of a collection.
private static int	Returns: hash code for the map, if `null` or empty, the returned hash code is `0` (zero). hashCodeOf(final Map<?, ?> map, may be `null`. instance) Compute a `Object#hashCode` of a map.
public boolean	Returns: true if the must-revalidate cache control directive will be included in the response, false otherwise. isMustRevalidate() Corresponds to the must-revalidate cache control directive.
public boolean	Returns: true if the no-cache cache control directive will be included in the response, false otherwise. isNoCache() Corresponds to the no-cache cache control directive.
public boolean	Returns: true if the no-store cache control directive will be included in the response, false otherwise. isNoStore() Corresponds to the no-store cache control directive.
public boolean	Returns: true if the no-transform cache control directive will be included in the response, false otherwise. isNoTransform() Corresponds to the no-transform cache control directive.
public boolean	Returns: true if the private cache control directive will be included in the response, false otherwise. isPrivate() Corresponds to the private cache control directive.
public boolean	Returns: true if the proxy-revalidate cache control directive will be included in the response, false otherwise. isProxyRevalidate() Corresponds to the proxy-revalidate cache control directive.
private static boolean	Returns: `true` if the two collections are not equal, `false` if the two collections are equal (or one of them is `null` and the other one is empty). notEqual(final Collection<?> first collection. May be `null`. first, final Collection<?> second collection. May be `null`. second) Check if two collections are not equal.
private static boolean	Returns: `true` if the two maps are not equal, `false` if the two maps are equal (or one of them is `null` and the other one is empty). notEqual(final Map<?, ?> first collection. May be `null`. first, final Map<?, ?> second collection. May be `null`. second) Check if two maps are not equal.
public void	setMaxAge(final int the value of the max-age cache control directive, a value of -1 will disable the directive. maxAge) Corresponds to the max-age cache control directive.
public void	setMustRevalidate(final boolean true if the must-revalidate cache control directive should be included in the response, false otherwise. mustRevalidate) Corresponds to the must-revalidate cache control directive.
public void	setNoCache(final boolean true if the no-cache cache control directive should be included in the response, false otherwise. noCache) Corresponds to the no-cache cache control directive.
public void	setNoStore(final boolean true if the no-store cache control directive should be included in the response, false otherwise. noStore) Corresponds to the no-store cache control directive.
public void	setNoTransform(final boolean true if the no-transform cache control directive should be included in the response, false otherwise. noTransform) Corresponds to the no-transform cache control directive.
public void	setPrivate(final boolean true if the private cache control directive should be included in the response, false otherwise. flag) Corresponds to the private cache control directive.
public void	setProxyRevalidate(final boolean true if the proxy-revalidate cache control directive should be included in the response, false otherwise. proxyRevalidate) Corresponds to the must-revalidate cache control directive.
public void	setSMaxAge(final int the value of the s-maxage cache control directive, a value of -1 will disable the directive. smaxAge) Corresponds to the s-maxage cache control directive.
public String	Returns: a stringified cache control toString() Overrides java.lang.Object.toString. Deprecated The format of the toString() method is subject to change in a future version. Please use RuntimeDelegate.getInstance().createHeaderDelegate(CacheControl.class).toString(value) instead if you rely on the format of this method. Convert the cache control to a string suitable for use as the value of the corresponding HTTP header.
public static CacheControl	Returns: the newly created CacheControl valueOf(final String the cache control string value) Deprecated This method will be removed in a future version. Please use RuntimeDelegate.getInstance().createHeaderDelegate(CacheControl.class).fromString(value) instead. Creates a new instance of CacheControl by parsing the supplied string.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

cacheExtension	back to summary
private Map<String, String> cacheExtension

HEADER_DELEGATE	back to summary
private static final RuntimeDelegate.HeaderDelegate<CacheControl> HEADER_DELEGATE Deprecated This field will be removed in a future version. See https://github.com/jakartaee/rest/issues/607 Annotations @Deprecated

maxAge	back to summary
private int maxAge

mustRevalidate	back to summary
private boolean mustRevalidate

noCache	back to summary
private boolean noCache

noCacheFields	back to summary
private List<String> noCacheFields

noStore	back to summary
private boolean noStore

noTransform	back to summary
private boolean noTransform

privateFields	back to summary
private List<String> privateFields

privateFlag	back to summary
private boolean privateFlag

proxyRevalidate	back to summary
private boolean proxyRevalidate

sMaxAge	back to summary
private int sMaxAge

CacheControl	back to summary
public CacheControl() Create a new instance of CacheControl. The new instance will have the following default settings: private = false noCache = false noStore = false noTransform = true mustRevalidate = false proxyRevalidate = false An empty list of private fields An empty list of no-cache fields An empty map of cache extensions

Method Detail

equals	back to summary
public boolean equals(final Object obj) Overrides java.lang.Object.equals. Compares object argument to this cache control to see if they are the same considering all property values. Parameters obj:Object the object to compare to Returns:boolean true if the two cache controls are the same, false otherwise. Annotations @Override

equals

back to summary

public boolean equals(final Object obj)

Overrides java.lang.Object.equals.

Compares object argument to this cache control to see if they are the same considering all property values.

Parameters

obj:Object: the object to compare to

Returns:boolean

true if the two cache controls are the same, false otherwise.

Annotations

@Override

getCacheExtension	back to summary
public Map<String, String> getCacheExtension() Corresponds to a set of extension cache control directives. Returns:Map<String, String> a mutable map of cache control extension names and their values. If a key has a null value, it will appear as a bare directive. If a key has a value that contains no whitespace then the directive will appear as a simple name=value pair. If a key has a value that contains whitespace then the directive will appear as a quoted name="value" pair. See Also HTTP/1.1 section 14.9.6

getCacheExtension

back to summary

public Map<String, String> getCacheExtension()

Corresponds to a set of extension cache control directives.

Returns:Map<String, String>: a mutable map of cache control extension names and their values. If a key has a null value, it will appear as a bare directive. If a key has a value that contains no whitespace then the directive will appear as a simple name=value pair. If a key has a value that contains whitespace then the directive will appear as a quoted name="value" pair.
See Also: HTTP/1.1 section 14.9.6

getMaxAge	back to summary
public int getMaxAge() Corresponds to the max-age cache control directive. Returns:int the value of the max-age cache control directive, -1 if the directive is disabled. See Also HTTP/1.1 section 14.9.3

getMaxAge

back to summary

public int getMaxAge()

Corresponds to the max-age cache control directive.

Returns:int: the value of the max-age cache control directive, -1 if the directive is disabled.
See Also: HTTP/1.1 section 14.9.3

getNoCacheFields back to summary

getNoCacheFields	back to summary
public List<String> getNoCacheFields() Corresponds to the value of the no-cache cache control directive. Returns:List<String> a mutable list of field-names that will form the value of the no-cache cache control directive. An empty list results in a bare no-cache directive. See Also `isNoCache()`, `setNoCache(boolean)`, HTTP/1.1 section 14.9.1

public List<String> getNoCacheFields()

Corresponds to the value of the no-cache cache control directive.

Returns:List<String>: a mutable list of field-names that will form the value of the no-cache cache control directive. An empty list results in a bare no-cache directive.
See Also: isNoCache(), setNoCache(boolean), HTTP/1.1 section 14.9.1

getPrivateFields back to summary

getPrivateFields	back to summary
public List<String> getPrivateFields() Corresponds to the value of the private cache control directive. Returns:List<String> a mutable list of field-names that will form the value of the private cache control directive. An empty list results in a bare no-cache directive. See Also `isPrivate()`, `setPrivate(boolean)`, HTTP/1.1 section 14.9.1

public List<String> getPrivateFields()

Corresponds to the value of the private cache control directive.

Returns:List<String>: a mutable list of field-names that will form the value of the private cache control directive. An empty list results in a bare no-cache directive.
See Also: isPrivate(), setPrivate(boolean), HTTP/1.1 section 14.9.1

getSMaxAge	back to summary
public int getSMaxAge() Corresponds to the s-maxage cache control directive. Returns:int the value of the s-maxage cache control directive, -1 if the directive is disabled. See Also HTTP/1.1 section 14.9.3

getSMaxAge

back to summary

public int getSMaxAge()

Corresponds to the s-maxage cache control directive.

Returns:int: the value of the s-maxage cache control directive, -1 if the directive is disabled.
See Also: HTTP/1.1 section 14.9.3

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Generate hash code from cache control properties. Returns:int the hashCode Annotations @Override

hashCode

back to summary

public int hashCode()

Overrides java.lang.Object.hashCode.

Generate hash code from cache control properties.

Returns:int

the hashCode

Annotations

@Override

hashCodeOf back to summary

hashCodeOf	back to summary
private static int hashCodeOf(final Collection<?> instance) Compute a `Object#hashCode` of a collection. If the collection is `null` or empty, the returned hash code is `0` (zero). Otherwise, the collection's `hashCode()` method is called to compute the hash code. Parameters instance:Collection<?> collection, may be `null`. Returns:int hash code for the collection, if `null` or empty, the returned hash code is `0` (zero).

private static int hashCodeOf(final Collection<?> instance)

Compute a Object#hashCode of a collection. If the collection is null or empty, the returned hash code is 0 (zero). Otherwise, the collection's hashCode() method is called to compute the hash code.

Parameters

instance:Collection<?>: collection, may be null.

Returns:int

hash code for the collection, if null or empty, the returned hash code is 0 (zero).

hashCodeOf back to summary

hashCodeOf	back to summary
private static int hashCodeOf(final Map<?, ?> instance) Compute a `Object#hashCode` of a map. If the map is `null` or empty, the returned hash code is `0` (zero). Otherwise, the map's `hashCode()` method is called to compute the hash code. Parameters instance:Map<?, ?> map, may be `null`. Returns:int hash code for the map, if `null` or empty, the returned hash code is `0` (zero).

private static int hashCodeOf(final Map<?, ?> instance)

Compute a Object#hashCode of a map. If the map is null or empty, the returned hash code is 0 (zero). Otherwise, the map's hashCode() method is called to compute the hash code.

Parameters

instance:Map<?, ?>: map, may be null.

Returns:int

hash code for the map, if null or empty, the returned hash code is 0 (zero).

isMustRevalidate	back to summary
public boolean isMustRevalidate() Corresponds to the must-revalidate cache control directive. Returns:boolean true if the must-revalidate cache control directive will be included in the response, false otherwise. See Also HTTP/1.1 section 14.9.4

isMustRevalidate

back to summary

public boolean isMustRevalidate()

Corresponds to the must-revalidate cache control directive.

Returns:boolean: true if the must-revalidate cache control directive will be included in the response, false otherwise.
See Also: HTTP/1.1 section 14.9.4

isNoCache back to summary

isNoCache	back to summary
public boolean isNoCache() Corresponds to the no-cache cache control directive. Returns:boolean true if the no-cache cache control directive will be included in the response, false otherwise. See Also `getNoCacheFields()`, HTTP/1.1 section 14.9.1

public boolean isNoCache()

Corresponds to the no-cache cache control directive.

Returns:boolean: true if the no-cache cache control directive will be included in the response, false otherwise.
See Also: getNoCacheFields(), HTTP/1.1 section 14.9.1

isNoStore	back to summary
public boolean isNoStore() Corresponds to the no-store cache control directive. Returns:boolean true if the no-store cache control directive will be included in the response, false otherwise. See Also HTTP/1.1 section 14.9.2

isNoStore

back to summary

public boolean isNoStore()

Corresponds to the no-store cache control directive.

Returns:boolean: true if the no-store cache control directive will be included in the response, false otherwise.
See Also: HTTP/1.1 section 14.9.2

isNoTransform	back to summary
public boolean isNoTransform() Corresponds to the no-transform cache control directive. Returns:boolean true if the no-transform cache control directive will be included in the response, false otherwise. See Also HTTP/1.1 section 14.9.5

isNoTransform

back to summary

public boolean isNoTransform()

Corresponds to the no-transform cache control directive.

Returns:boolean: true if the no-transform cache control directive will be included in the response, false otherwise.
See Also: HTTP/1.1 section 14.9.5

isPrivate back to summary

isPrivate	back to summary
public boolean isPrivate() Corresponds to the private cache control directive. Returns:boolean true if the private cache control directive will be included in the response, false otherwise. See Also `getPrivateFields()`, HTTP/1.1 section 14.9.1

public boolean isPrivate()

Corresponds to the private cache control directive.

Returns:boolean: true if the private cache control directive will be included in the response, false otherwise.
See Also: getPrivateFields(), HTTP/1.1 section 14.9.1

isProxyRevalidate	back to summary
public boolean isProxyRevalidate() Corresponds to the proxy-revalidate cache control directive. Returns:boolean true if the proxy-revalidate cache control directive will be included in the response, false otherwise. See Also HTTP/1.1 section 14.9.4

isProxyRevalidate

back to summary

public boolean isProxyRevalidate()

Corresponds to the proxy-revalidate cache control directive.

Returns:boolean: true if the proxy-revalidate cache control directive will be included in the response, false otherwise.
See Also: HTTP/1.1 section 14.9.4

notEqual back to summary

notEqual	back to summary
private static boolean notEqual(final Collection<?> first, final Collection<?> second) Check if two collections are not equal. If one of the collections is `null` and the other is empty, consider the collections to be equal. Parameters first:Collection<?> first collection. May be `null`. second:Collection<?> second collection. May be `null`. Returns:boolean `true` if the two collections are not equal, `false` if the two collections are equal (or one of them is `null` and the other one is empty).

private static boolean notEqual(final Collection<?> first, final Collection<?> second)

Check if two collections are not equal. If one of the collections is null and the other is empty, consider the collections to be equal.

Parameters

first:Collection<?>: first collection. May be null.
second:Collection<?>: second collection. May be null.

Returns:boolean

true if the two collections are not equal, false if the two collections are equal (or one of them is null and the other one is empty).

notEqual back to summary

notEqual	back to summary
private static boolean notEqual(final Map<?, ?> first, final Map<?, ?> second) Check if two maps are not equal. If one of the maps is `null` and the other is empty, consider the maps to be equal. Parameters first:Map<?, ?> first collection. May be `null`. second:Map<?, ?> second collection. May be `null`. Returns:boolean `true` if the two maps are not equal, `false` if the two maps are equal (or one of them is `null` and the other one is empty).

private static boolean notEqual(final Map<?, ?> first, final Map<?, ?> second)

Check if two maps are not equal. If one of the maps is null and the other is empty, consider the maps to be equal.

Parameters

first:Map<?, ?>: first collection. May be null.
second:Map<?, ?>: second collection. May be null.

Returns:boolean

true if the two maps are not equal, false if the two maps are equal (or one of them is null and the other one is empty).

setMaxAge	back to summary
public void setMaxAge(final int maxAge) Corresponds to the max-age cache control directive. Parameters maxAge:int the value of the max-age cache control directive, a value of -1 will disable the directive. See Also HTTP/1.1 section 14.9.3

setMaxAge

back to summary

public void setMaxAge(final int maxAge)

Corresponds to the max-age cache control directive.

Parameters

maxAge:int: the value of the max-age cache control directive, a value of -1 will disable the directive.

See Also

HTTP/1.1 section 14.9.3

setMustRevalidate	back to summary
public void setMustRevalidate(final boolean mustRevalidate) Corresponds to the must-revalidate cache control directive. Parameters mustRevalidate:boolean true if the must-revalidate cache control directive should be included in the response, false otherwise. See Also HTTP/1.1 section 14.9.4

setMustRevalidate

back to summary

public void setMustRevalidate(final boolean mustRevalidate)

Corresponds to the must-revalidate cache control directive.

Parameters

mustRevalidate:boolean: true if the must-revalidate cache control directive should be included in the response, false otherwise.

See Also

HTTP/1.1 section 14.9.4

setNoCache back to summary

setNoCache	back to summary
public void setNoCache(final boolean noCache) Corresponds to the no-cache cache control directive. Parameters noCache:boolean true if the no-cache cache control directive should be included in the response, false otherwise. See Also `getNoCacheFields()`, HTTP/1.1 section 14.9.1

public void setNoCache(final boolean noCache)

Corresponds to the no-cache cache control directive.

Parameters

noCache:boolean: true if the no-cache cache control directive should be included in the response, false otherwise.

setNoStore	back to summary
public void setNoStore(final boolean noStore) Corresponds to the no-store cache control directive. Parameters noStore:boolean true if the no-store cache control directive should be included in the response, false otherwise. See Also HTTP/1.1 section 14.9.2

setNoStore

back to summary

public void setNoStore(final boolean noStore)

Corresponds to the no-store cache control directive.

Parameters

noStore:boolean: true if the no-store cache control directive should be included in the response, false otherwise.

See Also

HTTP/1.1 section 14.9.2

setNoTransform	back to summary
public void setNoTransform(final boolean noTransform) Corresponds to the no-transform cache control directive. Parameters noTransform:boolean true if the no-transform cache control directive should be included in the response, false otherwise. See Also HTTP/1.1 section 14.9.5

setNoTransform

back to summary

public void setNoTransform(final boolean noTransform)

Corresponds to the no-transform cache control directive.

Parameters

noTransform:boolean: true if the no-transform cache control directive should be included in the response, false otherwise.

See Also

HTTP/1.1 section 14.9.5

setPrivate back to summary

setPrivate	back to summary
public void setPrivate(final boolean flag) Corresponds to the private cache control directive. Parameters flag:boolean true if the private cache control directive should be included in the response, false otherwise. See Also `getPrivateFields()`, HTTP/1.1 section 14.9.1

public void setPrivate(final boolean flag)

Corresponds to the private cache control directive.

Parameters

flag:boolean: true if the private cache control directive should be included in the response, false otherwise.

setProxyRevalidate	back to summary
public void setProxyRevalidate(final boolean proxyRevalidate) Corresponds to the must-revalidate cache control directive. Parameters proxyRevalidate:boolean true if the proxy-revalidate cache control directive should be included in the response, false otherwise. See Also HTTP/1.1 section 14.9.4

setProxyRevalidate

back to summary

public void setProxyRevalidate(final boolean proxyRevalidate)

Corresponds to the must-revalidate cache control directive.

Parameters

proxyRevalidate:boolean: true if the proxy-revalidate cache control directive should be included in the response, false otherwise.

See Also

HTTP/1.1 section 14.9.4

setSMaxAge	back to summary
public void setSMaxAge(final int smaxAge) Corresponds to the s-maxage cache control directive. Parameters smaxAge:int the value of the s-maxage cache control directive, a value of -1 will disable the directive. See Also HTTP/1.1 section 14.9.3

setSMaxAge

back to summary

public void setSMaxAge(final int smaxAge)

Corresponds to the s-maxage cache control directive.

Parameters

smaxAge:int: the value of the s-maxage cache control directive, a value of -1 will disable the directive.

See Also

HTTP/1.1 section 14.9.3

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Deprecated The format of the toString() method is subject to change in a future version. Please use RuntimeDelegate.getInstance().createHeaderDelegate(CacheControl.class).toString(value) instead if you rely on the format of this method. Convert the cache control to a string suitable for use as the value of the corresponding HTTP header. Returns:String a stringified cache control Annotations @Override @Deprecated

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Deprecated

The format of the toString() method is subject to change in a future version. Please use RuntimeDelegate.getInstance().createHeaderDelegate(CacheControl.class).toString(value) instead if you rely on the format of this method.

Convert the cache control to a string suitable for use as the value of the corresponding HTTP header.

Returns:String

a stringified cache control

Annotations

@Override
@Deprecated

valueOf	back to summary
public static CacheControl valueOf(final String value) Deprecated This method will be removed in a future version. Please use RuntimeDelegate.getInstance().createHeaderDelegate(CacheControl.class).fromString(value) instead. Creates a new instance of CacheControl by parsing the supplied string. Parameters value:String the cache control string Returns:CacheControl the newly created CacheControl Annotations @Deprecated Exceptions IllegalArgumentException: if the supplied string cannot be parsed or is null

valueOf

back to summary

public static CacheControl valueOf(final String value)

Deprecated

This method will be removed in a future version. Please use RuntimeDelegate.getInstance().createHeaderDelegate(CacheControl.class).fromString(value) instead.

Creates a new instance of CacheControl by parsing the supplied string.

Parameters

value:String: the cache control string

Returns:CacheControl

the newly created CacheControl

Annotations

@Deprecated

Exceptions

IllegalArgumentException:: if the supplied string cannot be parsed or is null

public Class CacheControl

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail