net.covers1624.quack.net.httpapi

Class HeaderList

java.lang.Object

net.covers1624.quack.net.httpapi.HeaderList

All Implemented Interfaces:

java.lang.Iterable<HeaderList.Entry>

public final class HeaderList
extends java.lang.Object
implements java.lang.Iterable<HeaderList.Entry>

A simple collection of name-value pair entries.

A combination of name-value must be unique.

Names are compared case-insensitive.

All name characters must be within u0021 .. u007e (inclusive)
All value characters must either be \t or within u0020 .. u007e (inclusive)

Created by covers1624 on 1/8/23.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HeaderList.Entry

Constructor Summary

Constructors

Constructor and Description
HeaderList()

Method Summary

Modifier and Type	Method and Description
void	add(java.lang.String name, java.lang.String value) Adds name-value pair.
void	addAll(HeaderList other) Add all the entries form the specified HeaderList to this collection.
void	addAll(java.util.Map<java.lang.String,java.lang.String> entries) Add all the entries from the specified Map to this collection.
void	addAllMulti(java.util.Map<java.lang.String,java.util.List<java.lang.String>> entries) Add all the entries from the specified Map to this collection.
void	addFirst(java.lang.String name, java.lang.String value) Adds name-value pair.
void	clear() Delete all headers in this list.
boolean	contains(java.lang.String name, java.lang.String value) Checks if this collection contains the given name-value pair.
@Nullable java.lang.String	get(java.lang.String name) Get the first value with the specified name.
java.util.List<java.lang.String>	getValues(java.lang.String name) Get all values with the specified name.
boolean	isEmpty() Checks if the collection is empty.
java.util.Iterator<HeaderList.Entry>	iterator()
void	removeAll(java.lang.String name) Remove all entries with the specified name.
void	set(java.lang.String name, java.lang.String value) Remove all existing values of a specified name, then insert a new value.
int	size() Gets the number of entries in the collection.
java.lang.String[]	toStrings() Convert this header list into a list of assembled header strings.

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 Detail

HeaderList

public HeaderList()

Method Detail

isEmpty

public boolean isEmpty()

Checks if the collection is empty.

Returns:

If the collection is empty.

size

public int size()

Gets the number of entries in the collection.

Returns:

The number of entries.

add

public void add(java.lang.String name,
                java.lang.String value)

Adds name-value pair.

Parameters:

name - The name.

value - The value.

addFirst

public void addFirst(java.lang.String name,
                     java.lang.String value)

Adds name-value pair.

Parameters:

name - The name.

value - The value.

addAll

public void addAll(java.util.Map<java.lang.String,java.lang.String> entries)

Add all the entries from the specified Map to this collection.

Parameters:

entries - The entries to add.

addAllMulti

public void addAllMulti(java.util.Map<java.lang.String,java.util.List<java.lang.String>> entries)

Add all the entries from the specified Map to this collection.

Parameters:

entries - The entries to add.

addAll

public void addAll(HeaderList other)

Add all the entries form the specified HeaderList to this collection.

Parameters:

other - The entries to add.

set

public void set(java.lang.String name,
                java.lang.String value)

Remove all existing values of a specified name, then insert a new value.

Parameters:

name - The name.

value - The value.

contains

public boolean contains(java.lang.String name,
                        java.lang.String value)

Checks if this collection contains the given name-value pair.

Parameters:

name - The name.

value - The value.

Returns:

If the name-value pair exists.

removeAll

public void removeAll(java.lang.String name)

Remove all entries with the specified name.

Parameters:

name - The name to remove.

get

@Nullable
public @Nullable java.lang.String get(java.lang.String name)

Get the first value with the specified name.

Parameters:

name - The name to get the first value for.

Returns:

The first value. null if it does not exist.

getValues

public java.util.List<java.lang.String> getValues(java.lang.String name)

Get all values with the specified name.

Parameters:

name - The name to get values for.

Returns:

All values for the specified name.

clear

public void clear()

Delete all headers in this list.

toStrings

public java.lang.String[] toStrings()

Convert this header list into a list of assembled header strings.

For example HeaderName: HeaderValue

Returns:

The assembled header strings.

iterator

public java.util.Iterator<HeaderList.Entry> iterator()

Specified by:

iterator in interface java.lang.Iterable<HeaderList.Entry>