Modifier and Type	Class and Description
public abstract static class	Cookie.AbstractCookieBuilder< the current AbstractCookieBuilder type. T extends Cookie.AbstractCookieBuilder<T>> JAX-RS abstract `Cookie` builder class.
public static class	Cookie.Builder JAX-RS `Cookie` builder class.

Modifier and Type	Field and Description
public static final int	DEFAULT_VERSION Cookies using the default version correspond to RFC 2109.
private final String	domain
private static final RuntimeDelegate.HeaderDelegate<Cookie>	HEADER_DELEGATE Deprecated This field will be removed in a future version. See https://github.com/eclipse-ee4j/jaxrs-api/issues/607
private final String	name
private final String	path
private final String	value
private final int	version

Constructor Summary

Access	Constructor and Description
public	Cookie(final String the name of the cookie. name, final String the value of the cookie. value, final String the URI path for which the cookie is valid. path, final String the host domain for which the cookie is valid. domain, final int the version of the specification to which the cookie complies. version) Deprecated This constructor will be removed in a future version. Please use `Cookie.Builder` instead. Create a new instance.
public	Cookie(final String the name of the cookie. name, final String the value of the cookie. value, final String the URI path for which the cookie is valid. path, final String the host domain for which the cookie is valid. domain) Deprecated This constructor will be removed in a future version. Please use `Cookie.Builder` instead. Create a new instance.
public	Cookie(final String the name of the cookie. name, final String the value of the cookie. value) Deprecated This constructor will be removed in a future version. Please use `Cookie.Builder` instead. Create a new instance.
protected	Cookie(Cookie.AbstractCookieBuilder<?> the builder. builder) Create a new instance from the supplied `AbstractCookieBuilder` instance.

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: `true`, if the object is a `Cookie` with the same value for all properties, `false` otherwise. equals(final Object the object to compare to. obj) Overrides java.lang.Object.equals. Compare for equality.
public String	Returns: the cookie domain. getDomain() Get the domain of the cookie.
public String	Returns: the cookie name. getName() Get the name of the cookie.
public String	Returns: the cookie path. getPath() Get the path of the cookie.
public String	Returns: the cookie value. getValue() Get the value of the cookie.
public int	Returns: the cookie version. getVersion() Get the version of the cookie.
public int	Returns: the cookie hash code. hashCode() Overrides java.lang.Object.hashCode. Generate a hash code by hashing all of the cookies properties.
public String	Returns: a stringified cookie. 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(Cookie.class).toString(value) instead if you rely on the format of this method. Convert the cookie to a string suitable for use as the value of the corresponding HTTP header.
public static Cookie	Returns: the newly created `Cookie`. valueOf(final String the cookie string. value) Deprecated This method will be removed in a future version. Please use RuntimeDelegate.getInstance().createHeaderDelegate(Cookie.class).fromString(value) instead. Creates a new instance of `Cookie` by parsing the supplied string.

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

Field Detail

DEFAULT_VERSION	back to summary
public static final int DEFAULT_VERSION Cookies using the default version correspond to RFC 2109.

domain	back to summary
private final String domain

HEADER_DELEGATE	back to summary
private static final RuntimeDelegate.HeaderDelegate<Cookie> HEADER_DELEGATE Deprecated This field will be removed in a future version. See https://github.com/eclipse-ee4j/jaxrs-api/issues/607 Annotations @Deprecated

name	back to summary
private final String name

path	back to summary
private final String path

value	back to summary
private final String value

version	back to summary
private final int version

Constructor Detail

Cookie back to summary

public Cookie(final String name, final String value, final String path, final String domain, final int version) throws IllegalArgumentException

Deprecated

This constructor will be removed in a future version. Please use Cookie.Builder instead.

Create a new instance.

Parameters

name:String: the name of the cookie.
value:String: the value of the cookie.
path:String: the URI path for which the cookie is valid.
domain:String: the host domain for which the cookie is valid.
version:int: the version of the specification to which the cookie complies.

Annotations

@Deprecated

Exceptions

IllegalArgumentException:: if name is null.

Cookie back to summary

public Cookie(final String name, final String value, final String path, final String domain) throws IllegalArgumentException

Deprecated

This constructor will be removed in a future version. Please use Cookie.Builder instead.

Create a new instance.

Parameters

name:String: the name of the cookie.
value:String: the value of the cookie.
path:String: the URI path for which the cookie is valid.
domain:String: the host domain for which the cookie is valid.

Annotations

@Deprecated

Exceptions

IllegalArgumentException:: if name is null.

Cookie back to summary

public Cookie(final String name, final String value) throws IllegalArgumentException

Deprecated

This constructor will be removed in a future version. Please use Cookie.Builder instead.

Create a new instance.

Parameters

name:String: the name of the cookie.
value:String: the value of the cookie.

Annotations

@Deprecated

Exceptions

IllegalArgumentException:: if name is null.

Cookie back to summary

protected Cookie(Cookie.AbstractCookieBuilder<?> builder) throws IllegalArgumentException

Create a new instance from the supplied AbstractCookieBuilder instance.

Parameters

builder:Cookie.AbstractCookieBuilder<?>: the builder.

Exceptions

IllegalArgumentException:: if builder.name is null.

Since

3.1

Method Detail

equals back to summary

equals	back to summary
public boolean equals(final Object obj) Overrides java.lang.Object.equals. Compare for equality. Parameters obj:Object the object to compare to. Returns:boolean `true`, if the object is a `Cookie` with the same value for all properties, `false` otherwise. Annotations @SuppressWarnings:StringEquality, RedundantIfStatement @Override

public boolean equals(final Object obj)

Overrides java.lang.Object.equals.

Compare for equality.

Parameters

obj:Object: the object to compare to.

Returns:boolean

true, if the object is a Cookie with the same value for all properties, false otherwise.

Annotations

@SuppressWarnings:StringEquality, RedundantIfStatement
@Override

getDomain	back to summary
public String getDomain() Get the domain of the cookie. Returns:String the cookie domain.

getDomain

back to summary

public String getDomain()

Get the domain of the cookie.

Returns:String: the cookie domain.

getName	back to summary
public String getName() Get the name of the cookie. Returns:String the cookie name.

getName

back to summary

public String getName()

Get the name of the cookie.

Returns:String: the cookie name.

getPath	back to summary
public String getPath() Get the path of the cookie. Returns:String the cookie path.

getPath

back to summary

public String getPath()

Get the path of the cookie.

Returns:String: the cookie path.

getValue	back to summary
public String getValue() Get the value of the cookie. Returns:String the cookie value.

getValue

back to summary

public String getValue()

Get the value of the cookie.

Returns:String: the cookie value.

getVersion	back to summary
public int getVersion() Get the version of the cookie. Returns:int the cookie version.

getVersion

back to summary

public int getVersion()

Get the version of the cookie.

Returns:int: the cookie version.

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Generate a hash code by hashing all of the cookies properties. Returns:int the cookie hash code. Annotations @Override

hashCode

back to summary

public int hashCode()

Overrides java.lang.Object.hashCode.

Generate a hash code by hashing all of the cookies properties.

Returns:int

the cookie hash code.

Annotations

@Override

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(Cookie.class).toString(value) instead if you rely on the format of this method. Convert the cookie to a string suitable for use as the value of the corresponding HTTP header. Returns:String a stringified cookie. 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(Cookie.class).toString(value) instead if you rely on the format of this method.

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

Returns:String

a stringified cookie.

Annotations

@Override
@Deprecated

valueOf back to summary

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

public static Cookie valueOf(final String value)

Deprecated

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

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

Parameters

value:String: the cookie string.

Returns:Cookie

the newly created Cookie.

Annotations

@Deprecated

Exceptions

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

jakarta.ws.rs.core back to summary

public abstract Class Cookie.AbstractCookieBuilder<T extends Cookie.AbstractCookieBuilder<T>>

Class Inheritance

extends Object

java.lang.Object
jakarta.ws.rs.core.Cookie.AbstractCookieBuilder

Known Direct Subclasses

jakarta.ws.rs.core.NewCookie.AbstractNewCookieBuilder, jakarta.ws.rs.core.Cookie.Builder

Type Parameters

<T>: the current AbstractCookieBuilder type.

JAX-RS abstract Cookie builder class.

Since: 3.1

Modifier and Type	Field and Description
private String	domain
private final String	name
private String	path
private String	value
private int	version

Access	Constructor and Description
public	AbstractCookieBuilder(String the name of the cookie. name) Create a new instance.

Method Summary

Modifier and Type	Method and Description
public abstract Cookie	Returns: a new `Cookie` instance. build() Build a new `Cookie` instance using all the configuration previously specified in this builder.
public T	Returns: the updated builder instance. domain(String the host domain for which the cookie is valid. domain) Set the domain of the cookie.
public T	Returns: the updated builder instance. path(String the URI path for which the cookie is valid. path) Set the path of the cookie.
private T	self()
public T	Returns: the updated builder instance. value(String the value of the cookie. value) Set the value of the cookie.
public T	Returns: the updated builder instance. version(int the version of the specification to which the cookie complies. version) Set the version of the cookie.

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

Field Detail

domain	back to summary
private String domain

name	back to summary
private final String name

path	back to summary
private String path

value	back to summary
private String value

version	back to summary
private int version

Method Detail

build back to summary

public abstract Cookie build()

Build a new Cookie instance using all the configuration previously specified in this builder.

Returns:Cookie

a new Cookie instance.

Exceptions

IllegalArgumentException:: if name is null.

domain

back to summary

public T domain(String domain)

Set the domain of the cookie.

Parameters

domain:String: the host domain for which the cookie is valid.

Returns:T

the updated builder instance.

path

back to summary

public T path(String path)

Set the path of the cookie.

Parameters

path:String: the URI path for which the cookie is valid.

Returns:T

the updated builder instance.

self	back to summary
private T self() Annotations @SuppressWarnings:unchecked

value

back to summary

public T value(String value)

Set the value of the cookie.

Parameters

value:String: the value of the cookie.

Returns:T

the updated builder instance.

version back to summary

public T version(int version)

Set the version of the cookie. Defaults to Cookie#DEFAULT_VERSION

Parameters

version:int: the version of the specification to which the cookie complies.

Returns:T

the updated builder instance.

jakarta.ws.rs.core back to summary

public Class Cookie.Builder

Class Inheritance

extends Cookie.AbstractCookieBuilder<Cookie.Builder>

java.lang.Object
jakarta.ws.rs.core.Cookie.AbstractCookieBuilder
jakarta.ws.rs.core.Cookie.Builder

JAX-RS Cookie builder class.

Cookie builder provides methods that let you conveniently configure and subsequently build a new Cookie instance.

For example:

Cookie cookie = new Cookie.Builder("name")
        .path("/")
        .domain("domain.com")
        .build();

Since: 3.1

Access	Constructor and Description
public	Builder(String the name of the cookie. name) Create a new instance.

Method Summary

Modifier and Type	Method and Description
public Cookie	build() Implements abstract jakarta.ws.rs.core.Cookie.AbstractCookieBuilder.build. Build a new `Cookie` instance using all the configuration previously specified in this builder.

Inherited from jakarta.ws.rs.core.Cookie.AbstractCookieBuilder:: domain path value version

Builder	back to summary
public Builder(String name) Create a new instance. Parameters name:String the name of the cookie.

Method Detail

build back to summary

build	back to summary
public Cookie build() Implements abstract jakarta.ws.rs.core.Cookie.AbstractCookieBuilder.build. Doc from jakarta.ws.rs.core.Cookie.AbstractCookieBuilder.build. Build a new `Cookie` instance using all the configuration previously specified in this builder. Returns:Cookie a new `Cookie` instance. Annotations @Override

public Cookie build()

Implements abstract jakarta.ws.rs.core.Cookie.AbstractCookieBuilder.build.

Doc from jakarta.ws.rs.core.Cookie.AbstractCookieBuilder.build.

Build a new Cookie instance using all the configuration previously specified in this builder.

Returns:Cookie

a new Cookie instance.

Annotations

@Override

public Class Cookie

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public abstract Class Cookie.AbstractCookieBuilder<T extends Cookie.AbstractCookieBuilder<T>>

public Class Cookie.Builder