Module bus.http

Package org.miaixz.bus.http

Class Cookie.Builder

java.lang.Object

org.miaixz.bus.http.Cookie.Builder

Enclosing class:

Cookie

public static class Cookie.Builder
extends Object

A builder for creating Cookie instances.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
Cookie	build()	Builds a new Cookie instance.
Cookie.Builder	domain(String domain)	Sets the domain of the cookie, which will match the domain and its subdomains.
Cookie.Builder	expiresAt(long expiresAt)	Sets the expiration time of the cookie.
Cookie.Builder	hostOnlyDomain(String domain)	Sets the domain of the cookie to be host-only.
Cookie.Builder	httpOnly()	Sets the cookie to be HTTP-only.
Cookie.Builder	name(String name)	Sets the name of the cookie.
Cookie.Builder	path(String path)	Sets the path of the cookie.
Cookie.Builder	secure()	Sets the cookie to be secure (HTTPS only).
Cookie.Builder	value(String value)	Sets the value of the cookie.

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

name

public Cookie.Builder name(String name)

Sets the name of the cookie.

Parameters:

name - The cookie name.

Returns:

this builder instance.

Throws:

NullPointerException - if name is null.

IllegalArgumentException - if name contains whitespace.

value

public Cookie.Builder value(String value)

Sets the value of the cookie.

Parameters:

value - The cookie value.

Returns:

this builder instance.

Throws:

NullPointerException - if value is null.

IllegalArgumentException - if value contains whitespace.

expiresAt

public Cookie.Builder expiresAt(long expiresAt)

Sets the expiration time of the cookie.

Parameters:

expiresAt - The expiration time in milliseconds.

Returns:

this builder instance.

domain

public Cookie.Builder domain(String domain)

Sets the domain of the cookie, which will match the domain and its subdomains.

Parameters:

domain - The domain.

Returns:

this builder instance.

Throws:

NullPointerException - if domain is null.

IllegalArgumentException - if the domain is invalid.

hostOnlyDomain

public Cookie.Builder hostOnlyDomain(String domain)

Sets the domain of the cookie to be host-only.

Parameters:

domain - The domain.

Returns:

this builder instance.

Throws:

NullPointerException - if domain is null.

IllegalArgumentException - if the domain is invalid.

path

public Cookie.Builder path(String path)

Sets the path of the cookie.

Parameters:

path - The path.

Returns:

this builder instance.

Throws:

IllegalArgumentException - if the path does not start with "/".

secure

public Cookie.Builder secure()

Sets the cookie to be secure (HTTPS only).

Returns:

this builder instance.

httpOnly

public Cookie.Builder httpOnly()

Sets the cookie to be HTTP-only.

Returns:

this builder instance.

build

public Cookie build()

Builds a new Cookie instance.

Returns:

a new Cookie instance.

Throws:

NullPointerException - if name, value, or domain is not set.