Package org.jdrupes.httpcodec.types

Class CookieList

java.lang.Object

org.jdrupes.httpcodec.types.CookieList

All Implemented Interfaces:

Iterable<HttpCookie>

public class CookieList
extends Object
implements Iterable<HttpCookie>

Represents a list of cookies.

The additional property “same site attribute” controls the generation of header fields.

Constructor Summary

Constructors

Constructor	Description
CookieList()	Creates a new empty cookie list.
CookieList(Collection<HttpCookie> existing)	Creates a new list with items copied from the existing collection.
CookieList(Converters.SameSiteAttribute sameSiteAttribute)	Creates a new empty cookie list with the specified same-site attribute.

Method Summary

Modifier and Type	Method	Description
CookieList	add(HttpCookie cookie)	Adds a cookie to the list.
CookieList	clear()	Removes all cookies from the list.
boolean	isEmpty()
Iterator<HttpCookie>	iterator()
boolean	remove(String name)	Remove the cookie with the given name.
Converters.SameSiteAttribute	sameSiteAttribute()	Returns the same site attribute passed to the constructor.
int	size()
Stream<HttpCookie>	stream()
Optional<String>	valueForName(String name)	Returns the value for the cookie with the given name.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Details

CookieList

public CookieList(Converters.SameSiteAttribute sameSiteAttribute)

Creates a new empty cookie list with the specified same-site attribute.

CookieList

public CookieList()

Creates a new empty cookie list.

CookieList

public CookieList(Collection<HttpCookie> existing)

Creates a new list with items copied from the existing collection.

Parameters:

existing - the existing collection

Method Details

sameSiteAttribute

public Converters.SameSiteAttribute sameSiteAttribute()

Returns the same site attribute passed to the constructor.

Returns:

the same site attribute

valueForName

public Optional<String> valueForName(String name)

Returns the value for the cookie with the given name.

Parameters:

name - the name

Returns:

the value if a cookie with the given name exists

add

public CookieList add(HttpCookie cookie)

Adds a cookie to the list.

If a cookie with the same name already exists, it is replaced.

Parameters:

cookie - the cookie

Returns:

the cookie list for easy chaining

clear

public CookieList clear()

Removes all cookies from the list.

Returns:

the cookie list for easy chaining

isEmpty

public boolean isEmpty()

iterator

public Iterator<HttpCookie> iterator()

Specified by:

iterator in interface Iterable<HttpCookie>

stream

public Stream<HttpCookie> stream()

remove

public boolean remove(String name)

Remove the cookie with the given name.

Parameters:

name -

Returns:

the cookie list for easy chaining

size

public int size()