Uses of Class ratpack.func.Nullable (Ratpack API (2.0.0-rc-1))

Packages that use Nullable
Package	Description
ratpack.config	Provides the ability to access configuration data from a variety of sources, such as YAML, JSON, properties files, system properties, and environment variables.
ratpack.core.form	Support for handling uploaded forms, including file uploads.
ratpack.core.handling	The handling of application requests.
ratpack.core.health	Health checks report on the status of key components in the system and are generally used for monitoring and reporting.
ratpack.core.http	The HTTP protocol.
ratpack.core.jackson	Integration with the Jackson JSON marshalling library.
ratpack.core.parse	Parsing in Ratpack refers to deserializing a request body into a Java object of some type.
ratpack.core.server	Objects used to start a ratpack application.
ratpack.core.sse	Support for Server Sent Events.
ratpack.exec.stream	Support for reactive streams.
ratpack.func
ratpack.groovy	Support for writing Ratpack applications in the Groovy programming language.
ratpack.gson	Provides integration with Google Gson for JSON parsing and rendering.
ratpack.session	Objects for providing `Session` support.
ratpack.session.clientside	Support for Client Side Session.
ratpack.test.handling	Test fixtures for exercising `Handler` implementations without start a full `EmbeddedApp`.
ratpack.test.http	Test fixtures that provide HTTP client interfaces to applications under test.

Uses of Nullable in ratpack.config

Methods in ratpack.config with annotations of type Nullable
Modifier and Type	Method	Description
`Path`	FileSystemBinding.`file(String path)`	Creates a file reference relative to the bind point denoted by the given relative path.

Uses of Nullable in ratpack.core.form

Methods in ratpack.core.form with annotations of type Nullable
Modifier and Type	Method	Description
`UploadedFile`	Form.`file(String name)`	Return the first uploaded file with the given name.
`String`	UploadedFile.`getFileName()`	The name given for the file.

Uses of Nullable in ratpack.core.handling

Method parameters in ratpack.core.handling with annotations of type Nullable
Modifier and Type	Method	Description
`static Handler`	Handlers.`chain(ServerConfig serverConfig, Registry registry, Action<? super Chain> action)`	Builds a chain, backed by the given registry.
`static Handler`	Handlers.`chain(ServerConfig serverConfig, Registry registry, Action<? super Chain> action)`	Builds a chain, backed by the given registry.

Uses of Nullable in ratpack.core.health

Methods in ratpack.core.health with annotations of type Nullable
Modifier and Type	Method	Description
`Throwable`	HealthCheck.Result.`getError()`	The exception representing an unhealthy check, may be `null`.
`String`	HealthCheck.Result.`getMessage()`	Any message provided as part of the check, may be `null`.

Uses of Nullable in ratpack.core.http

Methods in ratpack.core.http with annotations of type Nullable
Modifier and Type	Method	Description
`String`	Headers.`get(CharSequence name)`	Returns the header value with the specified header name.
`String`	Headers.`get(String name)`	Returns the header value with the specified header name.
`String`	MediaType.`getCharset()`	The value of the "charset" parameter.
`Date`	Headers.`getDate(CharSequence name)`	Returns the header value as a date with the specified header name.
`Date`	Headers.`getDate(String name)`	Returns the header value as a date with the specified header name.
`default Instant`	Headers.`getInstant(CharSequence name)`	Returns the header value as an instant with the specified header name.
`String`	MediaType.`getType()`	The type without parameters.
`String`	Request.`oneCookie(String name)`	Returns the value of the cookie with the specified name if it was sent.

Uses of Nullable in ratpack.core.jackson

Methods in ratpack.core.jackson with annotations of type Nullable
Modifier and Type	Method	Description
`ObjectWriter`	JsonRender.`getObjectWriter()`	The object writer to use to render the object as JSON.
`Class<?>`	JsonRender.`getViewClass()`	The view class to use when rendering the object.

Method parameters in ratpack.core.jackson with annotations of type Nullable
Modifier and Type	Method	Description
`static <T> Parse<T,JsonParseOpts>`	Jackson.`fromJson(com.google.common.reflect.TypeToken<T> type, ObjectMapper objectMapper)`	Creates a `parseable object` to parse a request body into the given type.
`static <T> Parse<T,JsonParseOpts>`	Jackson.`fromJson(Class<T> type, ObjectMapper objectMapper)`	Creates a `parseable object` to parse a request body into the given type.
`static JsonRender`	Jackson.`json(Object object, ObjectWriter objectWriter)`	Creates a `renderable object` to render the given object as JSON.
`static JsonRender`	Jackson.`json(Object object, ObjectWriter objectWriter, Class<?> viewClass)`	Creates a `renderable object` to render the given object as JSON.
`static JsonRender`	Jackson.`json(Object object, ObjectWriter objectWriter, Class<?> viewClass)`	Creates a `renderable object` to render the given object as JSON.
`static JsonRender`	Jackson.`json(Object object, Class<?> viewClass)`	Creates a `renderable object` to render the given object as JSON.
`static Parse<JsonNode,JsonParseOpts>`	Jackson.`jsonNode(ObjectMapper objectMapper)`	Creates a `parseable object` to parse a request body into a `JsonNode`.

Uses of Nullable in ratpack.core.parse

Methods in ratpack.core.parse with annotations of type Nullable
Modifier and Type	Method	Description
`<T> T`	Parser.`parse(Context context, TypedData requestBody, Parse<T,O> parse)`	Deserializes the request body of the context into an object.

Uses of Nullable in ratpack.core.server

Methods in ratpack.core.server with annotations of type Nullable
Modifier and Type	Method	Description
`InetAddress`	ServerConfig.`getAddress()`	The address of the interface that the application should bind to.
`String`	RatpackServer.`getBindHost()`	The actual host/ip that the application is bound to.

Uses of Nullable in ratpack.core.sse

Methods in ratpack.core.sse with annotations of type Nullable
Modifier and Type	Method	Description
`String`	ServerSentEvent.`getComment()`	The “comment” value of the event.
`String`	ServerSentEvent.`getData()`	The “data” value of the event.
`String`	ServerSentEvent.`getEvent()`	The “event” value of the event.
`String`	ServerSentEvent.`getId()`	The “id” value of the event.

Method parameters in ratpack.core.sse with annotations of type Nullable
Modifier and Type	Method	Description
`ServerSentEventBuilder`	ServerSentEventBuilder.`comment(String comment)`	Specify a comment to include as part of this event.
`ServerSentEventBuilder`	ServerSentEventBuilder.`data(String data)`	Specify the event data for the server sent event.
`ServerSentEventBuilder`	ServerSentEventBuilder.`event(String event)`	Specify the event type for the server sent event.
`ServerSentEventBuilder`	ServerSentEventBuilder.`id(String id)`	Specify the event id for the server sent event.

Uses of Nullable in ratpack.exec.stream

Methods in ratpack.exec.stream with annotations of type Nullable
Modifier and Type	Method	Description
`T`	StreamEvent.`getItem()`	The data, if this event represents an emission of data.
`Throwable`	StreamEvent.`getThrowable()`	The error, if this event represents an error.

Uses of Nullable in ratpack.func

Methods in ratpack.func with annotations of type Nullable
Modifier and Type	Method	Description
`V`	MultiValueMap.`get(Object key)`	Get the first value for the key, or `null` if there are no values for the key.

Method parameters in ratpack.func with annotations of type Nullable
Modifier and Type	Method	Description
`static <T> Action<? super T>`	Action.`noopIfNull(Action<T> action)`	If the given action is `null`, returns `Action.noop()`, otherwise returns the given action.

Uses of Nullable in ratpack.groovy

Method parameters in ratpack.groovy with annotations of type Nullable
Modifier and Type	Method	Description
`static Handler`	Groovy.`chain(ServerConfig serverConfig, Registry registry, Closure<?> closure)`	Builds a chain, backed by the given registry.
`static Handler`	Groovy.`chain(ServerConfig serverConfig, Registry registry, Closure<?> closure)`	Builds a chain, backed by the given registry.

Uses of Nullable in ratpack.gson

Methods in ratpack.gson with annotations of type Nullable
Modifier and Type	Method	Description
`com.google.gson.Gson`	GsonRender.`getGson()`	The `Gson` instance to use when serializing the object to JSON.

Method parameters in ratpack.gson with annotations of type Nullable
Modifier and Type	Method	Description
`static <T> Parse<T,GsonParseOpts>`	Gson.`fromJson(com.google.common.reflect.TypeToken<T> type, com.google.gson.Gson gson)`	Creates a `parseable object` to parse a request body into the given type.
`static <T> Parse<T,GsonParseOpts>`	Gson.`fromJson(Class<T> type, com.google.gson.Gson gson)`	Creates a `parseable object` to parse a request body into the given type.
`static GsonRender`	Gson.`json(Object object, com.google.gson.Gson gson)`	Creates a `renderable object` to render the given object as JSON.
`static Parse<com.google.gson.JsonElement,GsonParseOpts>`	Gson.`jsonElement(com.google.gson.Gson gson)`	Creates a `parseable object` to parse a request body into a `JsonElement`.

Uses of Nullable in ratpack.session

Methods in ratpack.session with annotations of type Nullable
Modifier and Type	Method	Description
`String`	SessionKey.`getName()`	The name.
`Class<T>`	SessionKey.`getType()`	The type.

Method parameters in ratpack.session with annotations of type Nullable
Modifier and Type	Method	Description
`static <T> SessionKey<T>`	SessionKey.`of(String name, Class<T> type)`	Creates a key of the given name and type.
`static <T> SessionKey<T>`	SessionKey.`of(String name, Class<T> type)`	Creates a key of the given name and type.

Uses of Nullable in ratpack.session.clientside

Methods in ratpack.session.clientside with annotations of type Nullable
Modifier and Type	Method	Description
`String`	ClientSideSessionConfig.`getCipherAlgorithm()`	The `Cipher` algorithm used to encrypt/decrypt the serialized session
`String`	ClientSideSessionConfig.`getSecretKey()`	The secret key used in the symmetric-key encyrption/decryption of the serialized session.

Method parameters in ratpack.session.clientside with annotations of type Nullable
Modifier and Type	Method	Description
`void`	ClientSideSessionConfig.`setCipherAlgorithm(String cipherAlgorithm)`	Set the cipher algorithm used to encrypt/decrypt the serialized session data.
`void`	ClientSideSessionConfig.`setLastAccessTimeCookieName(String lastAccessTimeCookieName)`	Sets the name of the cookie used to store session's last access time.
`void`	ClientSideSessionConfig.`setSecretKey(String secretKey)`	Set the secret key used in the symmetric-key encryption/decryption of the serialized session data.

Uses of Nullable in ratpack.test.handling

Methods in ratpack.test.handling with annotations of type Nullable
Modifier and Type	Method	Description
`byte[]`	HandlingResult.`getBodyBytes()`	The response body, as bytes.
`String`	HandlingResult.`getBodyText()`	The response body, interpreted as a utf8 string.
`Integer`	HandlingResult.`getClientError()`	The client error raised if any, unless a custom client error handler is in use.
`Set<io.netty.handler.codec.http.cookie.Cookie>`	HandlingResult.`getCookies()`	The cookies to be set as part of the response.
`Path`	HandlingResult.`getSentFile()`	Indicates whether the result of invoking the handler was that it invoked one of the `Response.sendFile(java.nio.file.Path)` methods.
`<T> T`	HandlingResult.`rendered(Class<T> type)`	The object that was rendered to the response.

Uses of Nullable in ratpack.test.http

Method parameters in ratpack.test.http with annotations of type Nullable
Modifier and Type	Method	Description
`static TestHttpClient`	TestHttpClient.`testHttpClient(ApplicationUnderTest applicationUnderTest, Action<? super RequestSpec> requestConfigurer)`	A method to create an instance of the default implementation of TestHttpClient.