## Uses of Class
org.restlet.util.Series

Packages that use Series
Package | Description
--- | ---
org.restlet | Core classes of the API.
org.restlet.data | Information exchanged by components.
org.restlet.engine | Implementation of Restlet API.
org.restlet.engine.http | Supports HTTP connectors.
org.restlet.engine.http.connector | New advanced internal HTTP connector.
org.restlet.engine.http.header | Supports HTTP header parsing and formatting.
org.restlet.engine.http.security | Supports HTTP security.
org.restlet.engine.security | Supports security.
org.restlet.engine.util | General utilities.
org.restlet.ext.netty.internal |
org.restlet.ext.simple.internal |
org.restlet.resource | Client and server resource classes.
org.restlet.security | Classes related to security.
org.restlet.util | Various utility classes.

### Uses of Series in org.restlet

Methods in org.restlet that return Series
Modifier and Type | Method and Description
--- | ---
`Series<Cookie>` | Request.`getCookies()` Returns the modifiable series of cookies provided by the client.
`Series<CookieSetting>` | Response.`getCookieSettings()` Returns the modifiable series of cookie settings provided by the server.
`Series<Parameter>` | Context.`getParameters()` Returns the modifiable series of parameters.

Methods in org.restlet with parameters of type Series
Modifier and Type | Method and Description
--- | ---
`void` | Request.`setCookies(Series<Cookie> cookies)` Sets the modifiable series of cookies provided by the client.
`void` | Response.`setCookieSettings(Series<CookieSetting> cookieSettings)` Sets the modifiable series of cookie settings provided by the server.
`void` | Context.`setParameters(Series<Parameter> parameters)` Sets the modifiable series of parameters.

### Uses of Series in org.restlet.data

Subclasses of Series in org.restlet.data
Modifier and Type | Class and Description
--- | ---
`class` | `Form` Form which is a specialized modifiable list of parameters.

Methods in org.restlet.data that return Series
Modifier and Type | Method and Description
--- | ---
`Series<Parameter>` | Form.`createSeries(java.util.List<Parameter> delegate)`
`Series<Parameter>` | Disposition.`getParameters()` Returns the list of disposition parameters.
`Series<Parameter>` | ChallengeMessage.`getParameters()` Returns the modifiable series of scheme parameters.
`Series<Parameter>` | Preference.`getParameters()` Returns the modifiable list of parameters.
`Series<Parameter>` | MediaType.`getParameters()` Returns the unmodifiable list of parameters.

Methods in org.restlet.data with parameters of type Series
Modifier and Type | Method and Description
--- | ---
`void` | Disposition.`setParameters(Series<Parameter> parameters)` Sets the list of disposition parameters.
`void` | ChallengeMessage.`setParameters(Series<Parameter> parameters)` Sets the parameters.
`void` | Preference.`setParameters(Series<Parameter> parameters)` Sets the modifiable list of parameters.

Constructors in org.restlet.data with parameters of type Series
Constructor and Description
`ChallengeMessage(ChallengeScheme scheme, Series<Parameter> parameters)` Constructor.
`ChallengeMessage(ChallengeScheme scheme, java.lang.String realm, Series<Parameter> parameters)` Constructor.
`ChallengeResponse(ChallengeScheme scheme, java.lang.String identifier, Series<Parameter> parameters)` Constructor.
`Disposition(java.lang.String type, Series<Parameter> parameters)` Constructor.
`MediaType(java.lang.String name, Series<Parameter> parameters)` Constructor.
`MediaType(java.lang.String name, Series<Parameter> parameters, java.lang.String description)` Constructor.
`Preference(T metadata, float quality, Series<Parameter> parameters)` Constructor.

### Uses of Series in org.restlet.engine

Methods in org.restlet.engine that return Series
Modifier and Type | Method and Description
--- | ---
`Series<Parameter>` | RestletHelper.`getHelpedParameters()` Returns the helped Restlet parameters.

### Uses of Series in org.restlet.engine.http

Methods in org.restlet.engine.http that return Series
Modifier and Type | Method and Description
--- | ---
`Series<Cookie>` | HttpRequest.`getCookies()` Returns the cookies provided by the client.
`Series<Parameter>` | HttpResponse.`getHeaders()` Returns the HTTP headers.
`Series<Parameter>` | HttpRequest.`getHeaders()` Returns the HTTP headers.
`Series<Parameter>` | Call.`getRequestHeaders()` Returns the modifiable list of request headers.
`Series<Parameter>` | Call.`getResponseHeaders()` Returns the modifiable list of server headers.

### Uses of Series in org.restlet.engine.http.connector

Methods in org.restlet.engine.http.connector that return Series
Modifier and Type | Method and Description
--- | ---
`Series<Cookie>` | ConnectedRequest.`getCookies()` Returns the cookies provided by the client.
`Series<Parameter>` | ConnectedRequest.`getHeaders()` Returns the HTTP headers.

Methods in org.restlet.engine.http.connector with parameters of type Series
Modifier and Type | Method and Description
--- | ---
`protected void` | Connection.`addEntityHeaders(Representation entity, Series<Parameter> headers)` Adds the entity headers for the given response.
`protected void` | Connection.`addGeneralHeaders(Message message, Series<Parameter> headers)` Adds the general headers from the `Message` to the `Series`.
`protected void` | ClientConnection.`addRequestHeaders(Request request, Series<Parameter> headers)` Adds the request headers.
`protected void` | ServerConnection.`addResponseHeaders(Response response, Series<Parameter> headers)` Adds the response headers.
`protected void` | ClientConnection.`copyResponseTransportHeaders(Series<Parameter> headers, Response response)` Copies headers into a response.
`Representation` | Connection.`createInboundEntity(Series<Parameter> headers)` Returns the inbound message entity if available.
`protected ConnectedRequest` | ServerConnection.`createRequest(Context context, ServerConnection connection, java.lang.String methodName, java.lang.String resourceUri, java.lang.String version, Series<Parameter> headers, Representation entity, boolean confidential, java.security.Principal userPrincipal)` Creates a new request.
`protected void` | Connection.`writeMessage(Response message, Series<Parameter> headers)` Writes the message and its headers.
`protected void` | Connection.`writeMessageHead(Response message, java.io.OutputStream headStream, Series<Parameter> headers)` Writes the message head to the given output stream.
`protected void` | Connection.`writeMessageHead(Response message, Series<Parameter> headers)` Writes the message head.

Constructors in org.restlet.engine.http.connector with parameters of type Series
Constructor and Description
`ConnectedRequest(Context context, ServerConnection connection, Method method, java.lang.String resourceUri, java.lang.String version, Series<Parameter> headers, Representation entity, boolean confidential, java.security.Principal userPrincipal)` Constructor.

### Uses of Series in org.restlet.engine.http.header

Methods in org.restlet.engine.http.header that return Series
Modifier and Type | Method and Description
--- | ---
`protected Series<Parameter>` | PreferenceReader.`extractMediaParams(Series<Parameter> parameters)` Extract the media parameters.

Methods in org.restlet.engine.http.header with parameters of type Series
Modifier and Type | Method and Description
--- | ---
`static void` | HeaderUtils.`addEntityHeaders(Representation entity, Series<Parameter> headers)` Adds the entity headers based on the `Representation` to the `Series`.
`static void` | HeaderUtils.`addExtensionHeaders(Series<Parameter> existingHeaders, Series<Parameter> additionalHeaders)` Adds extension headers if they are non-standard headers.
`static void` | HeaderUtils.`addExtensionHeaders(Series<Parameter> existingHeaders, Series<Parameter> additionalHeaders)` Adds extension headers if they are non-standard headers.
`static void` | HeaderUtils.`addGeneralHeaders(Message message, Series<Parameter> headers)` Adds the general headers from the `Message` to the `Series`.
`static void` | HeaderUtils.`addHeader(java.lang.String headerName, java.lang.String headerValue, Series<Parameter> headers)` Adds a header to the given list.
`static void` | HeaderUtils.`addNotModifiedEntityHeaders(Representation entity, Series<Parameter> headers)` Adds the entity headers based on the `Representation` to the `Series` when a 304 (Not Modified) status is returned.
`static void` | HeaderUtils.`addRequestHeaders(Request request, Series<Parameter> headers)` Adds the headers based on the `Request` to the given `Series` .
`static void` | HeaderUtils.`addResponseHeaders(Response response, Series<Parameter> headers)` Adds the headers based on the `Response` to the given `Series`.
`static void` | HeaderUtils.`copyResponseTransportHeaders(Series<Parameter> headers, Response response)` Copies headers into a response.
`protected Preference<T>` | PreferenceReader.`createPreference(java.lang.CharSequence metadata, Series<Parameter> parameters)` Creates a new preference.
`protected Series<Parameter>` | PreferenceReader.`extractMediaParams(Series<Parameter> parameters)` Extract the media parameters.
`protected float` | PreferenceReader.`extractQuality(Series<Parameter> parameters)` Extract the quality value.
`static long` | HeaderUtils.`getContentLength(Series<Parameter> headers)` Returns the content length of the request entity if know, `Representation.UNKNOWN_SIZE` otherwise.
`static boolean` | HeaderUtils.`isChunkedEncoding(Series<Parameter> headers)` Indicates if the entity is chunked.
`static boolean` | HeaderUtils.`isConnectionClose(Series<Parameter> headers)` Indicates if the connection must be closed.

### Uses of Series in org.restlet.engine.http.security

Methods in org.restlet.engine.http.security with parameters of type Series
Modifier and Type | Method and Description
--- | ---
`void` | HttpBasicHelper.`formatRawRequest(ChallengeWriter cw, ChallengeRequest challenge, Response response, Series<Parameter> httpHeaders)`
`void` | HttpBasicHelper.`formatRawResponse(ChallengeWriter cw, ChallengeResponse challenge, Request request, Series<Parameter> httpHeaders)`
`void` | HttpBasicHelper.`parseRequest(ChallengeRequest challenge, Response response, Series<Parameter> httpHeaders)`
`void` | HttpBasicHelper.`parseResponse(ChallengeResponse challenge, Request request, Series<Parameter> httpHeaders)`

### Uses of Series in org.restlet.engine.security

Methods in org.restlet.engine.security with parameters of type Series
Modifier and Type | Method and Description
--- | ---
`void` | AuthenticatorHelper.`formatRawRequest(ChallengeWriter cw, ChallengeRequest challenge, Response response, Series<Parameter> httpHeaders)` Formats a challenge request as raw credentials.
`void` | SmtpPlainHelper.`formatRawResponse(ChallengeWriter cw, ChallengeResponse challenge, Request request, Series<Parameter> httpHeaders)`
`void` | AuthenticatorHelper.`formatRawResponse(ChallengeWriter cw, ChallengeResponse challenge, Request request, Series<Parameter> httpHeaders)` Formats a challenge response as raw credentials.
`static java.lang.String` | AuthenticatorUtils.`formatRequest(ChallengeRequest challenge, Response response, Series<Parameter> httpHeaders)` Formats a challenge request as a HTTP header value.
`java.lang.String` | AuthenticatorHelper.`formatRequest(ChallengeRequest challenge, Response response, Series<Parameter> httpHeaders)` Formats a challenge request as a HTTP header value.
`static java.lang.String` | AuthenticatorUtils.`formatResponse(ChallengeResponse challenge, Request request, Series<Parameter> httpHeaders)` Formats a challenge response as a HTTP header value.
`java.lang.String` | AuthenticatorHelper.`formatResponse(ChallengeResponse challenge, Request request, Series<Parameter> httpHeaders)` Formats a challenge response as a HTTP header value.
`abstract void` | SslContextFactory.`init(Series<Parameter> parameters)` Initialize the factory with the given connector parameters.
`void` | DefaultSslContextFactory.`init(Series<Parameter> helperParameters)` Sets the following options according to parameters that may have been set up directly in the HttpsServerHelper parameters.
`void` | AuthenticatorHelper.`parseRequest(ChallengeRequest challenge, Response response, Series<Parameter> httpHeaders)` Parses an authenticate header into a challenge request.
`static java.util.List<ChallengeRequest>` | AuthenticatorUtils.`parseRequest(Response response, java.lang.String header, Series<Parameter> httpHeaders)` Parses an authenticate header into a list of challenge request.
`void` | AuthenticatorHelper.`parseResponse(ChallengeResponse challenge, Request request, Series<Parameter> httpHeaders)` Parses an authorization header into a challenge response.
`static ChallengeResponse` | AuthenticatorUtils.`parseResponse(Request request, java.lang.String header, Series<Parameter> httpHeaders)` Parses an authorization header into a challenge response.

### Uses of Series in org.restlet.engine.util

Subclasses of Series in org.restlet.engine.util
Modifier and Type | Class and Description
--- | ---
`class` | `CookieSeries` Cookie series used internally by the `Request` class.
`class` | `CookieSettingSeries` Cookie setting series.

Methods in org.restlet.engine.util that return Series
Modifier and Type | Method and Description
--- | ---
`Series<Cookie>` | CookieSeries.`createSeries(java.util.List<Cookie> delegate)`
`Series<CookieSetting>` | CookieSettingSeries.`createSeries(java.util.List<CookieSetting> delegate)`

### Uses of Series in org.restlet.ext.netty.internal

Methods in org.restlet.ext.netty.internal that return Series
Modifier and Type | Method and Description
--- | ---
`Series<Parameter>` | NettyServerCall.`getRequestHeaders()`

### Uses of Series in org.restlet.ext.simple.internal

Methods in org.restlet.ext.simple.internal that return Series
Modifier and Type | Method and Description
--- | ---
`Series<Parameter>` | SimpleCall.`getRequestHeaders()` Returns the list of request headers.

### Uses of Series in org.restlet.resource

Methods in org.restlet.resource that return Series
Modifier and Type | Method and Description
--- | ---
`Series<Cookie>` | UniformResource.`getCookies()` Returns the modifiable series of cookies provided by the client.
`Series<CookieSetting>` | UniformResource.`getCookieSettings()` Returns the modifiable series of cookie settings provided by the server.

Methods in org.restlet.resource with parameters of type Series
Modifier and Type | Method and Description
--- | ---
`void` | ClientResource.`setCookies(Series<Cookie> cookies)` Sets the cookies provided by the client.
`void` | ServerResource.`setCookieSettings(Series<CookieSetting> cookieSettings)` Sets the cookie settings provided by the server.

### Uses of Series in org.restlet.security

Methods in org.restlet.security that return Series
Modifier and Type | Method and Description
--- | ---
`Series<Parameter>` | Realm.`getParameters()` Returns the modifiable series of parameters.

Methods in org.restlet.security with parameters of type Series
Modifier and Type | Method and Description
--- | ---
`void` | Realm.`setParameters(Series<Parameter> parameters)` Sets the modifiable series of parameters.

### Uses of Series in org.restlet.util

Methods in org.restlet.util that return Series
Modifier and Type | Method and Description
--- | ---
`abstract Series<E>` | Series.`createSeries(java.util.List<E> delegate)` Creates a new series.
`Series<Cookie>` | WrapperRequest.`getCookies()` Returns the cookies provided by the client.
`Series<CookieSetting>` | WrapperResponse.`getCookieSettings()` Returns the cookie settings provided by the server.
`Series<E>` | Series.`subList(int fromIndex, int toIndex)` Returns a view of the portion of this list between the specified fromIndex, inclusive, and toIndex, exclusive.
`Series<E>` | Series.`subList(java.lang.String name)` Returns a list of all the values associated to the parameter name.
`Series<E>` | Series.`subList(java.lang.String name, boolean ignoreCase)` Returns a list of all the values associated to the parameter name.
`static Series<? extends Parameter>` | Series.`unmodifiableSeries(Series<? extends Parameter> series)` Returns an unmodifiable view of the specified series.

Methods in org.restlet.util with parameters of type Series
Modifier and Type | Method and Description
--- | ---
`void` | WrapperRequest.`setCookies(Series<Cookie> cookies)`
`void` | WrapperResponse.`setCookieSettings(Series<CookieSetting> cookieSettings)`
`static Series<? extends Parameter>` | Series.`unmodifiableSeries(Series<? extends Parameter> series)` Returns an unmodifiable view of the specified series.