Uses of Class
ratpack.api.Nullable
-
Packages that use Nullable Package Description ratpack.file Types for dealing with the file system and serving files.ratpack.form Support for handling uploaded forms, including file uploads.ratpack.func General functional (i.e. Single Abstract Method) types.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.handling The handling of application requests.ratpack.health Health checks report on the status of key components in the system and are generally used for monitoring and reporting.ratpack.http The HTTP protocol.ratpack.jackson Integration with the Jackson JSON marshalling library.ratpack.parse Parsing in Ratpack refers to deserializing a request body into a Java object of some type.ratpack.server Objects used to start a ratpack application.ratpack.session Objects for providingSession
support.ratpack.stream Support for reactive streams.ratpack.test.handling Test fixtures for exercisingHandler
implementations without start a fullEmbeddedApp
.ratpack.test.http Test fixtures that provide HTTP client interfaces to applications under test.ratpack.util General purpose types and utilities. -
-
Uses of Nullable in ratpack.file
Methods in ratpack.file with annotations of type Nullable Modifier and Type Method Description java.nio.file.Path
FileSystemBinding. file(java.lang.String path)
Creates a file reference relative to the bind point denoted by the given relative path. -
Uses of Nullable in ratpack.form
Methods in ratpack.form with annotations of type Nullable Modifier and Type Method Description UploadedFile
Form. file(java.lang.String name)
Return the first uploaded file with the given name.java.lang.String
UploadedFile. getFileName()
The name given for the file. -
Uses of Nullable in ratpack.func
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 isnull
, returnsAction.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()
TheGson
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 aparseable object
to parse a request body into the given type.static <T> Parse<T,GsonParseOpts>
Gson. fromJson(java.lang.Class<T> type, com.google.gson.Gson gson)
Creates aparseable object
to parse a request body into the given type.static GsonRender
Gson. json(java.lang.Object object, com.google.gson.Gson gson)
Creates arenderable object
to render the given object as JSON.static Parse<com.google.gson.JsonElement,GsonParseOpts>
Gson. jsonElement(com.google.gson.Gson gson)
Creates aparseable object
to parse a request body into aJsonElement
. -
Uses of Nullable in ratpack.handling
Method parameters in ratpack.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.health
Methods in ratpack.health with annotations of type Nullable Modifier and Type Method Description java.lang.Throwable
HealthCheck.Result. getError()
The exception representing an unhealthy check, may benull
.java.lang.String
HealthCheck.Result. getMessage()
Any message provided as part of the check, may benull
. -
Uses of Nullable in ratpack.http
Methods in ratpack.http with annotations of type Nullable Modifier and Type Method Description java.lang.String
Headers. get(java.lang.CharSequence name)
Returns the header value with the specified header name.java.lang.String
Headers. get(java.lang.String name)
Returns the header value with the specified header name.java.lang.String
MediaType. getCharset()
The value of the "charset" parameter.java.util.Date
Headers. getDate(java.lang.CharSequence name)
Returns the header value as a date with the specified header name.java.util.Date
Headers. getDate(java.lang.String name)
Returns the header value as a date with the specified header name.default java.time.Instant
Headers. getInstant(java.lang.CharSequence name)
Returns the header value as an instant with the specified header name.java.lang.String
MediaType. getType()
The type without parameters.java.lang.String
Request. oneCookie(java.lang.String name)
Returns the value of the cookie with the specified name if it was sent. -
Uses of Nullable in ratpack.jackson
Methods in ratpack.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.java.lang.Class<?>
JsonRender. getViewClass()
The view class to use when rendering the object.Method parameters in ratpack.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 aparseable object
to parse a request body into the given type.static <T> Parse<T,JsonParseOpts>
Jackson. fromJson(java.lang.Class<T> type, ObjectMapper objectMapper)
Creates aparseable object
to parse a request body into the given type.static JsonRender
Jackson. json(java.lang.Object object, ObjectWriter objectWriter)
Creates arenderable object
to render the given object as JSON.static JsonRender
Jackson. json(java.lang.Object object, ObjectWriter objectWriter, java.lang.Class<?> viewClass)
Creates arenderable object
to render the given object as JSON.static JsonRender
Jackson. json(java.lang.Object object, ObjectWriter objectWriter, java.lang.Class<?> viewClass)
Creates arenderable object
to render the given object as JSON.static JsonRender
Jackson. json(java.lang.Object object, java.lang.Class<?> viewClass)
Creates arenderable object
to render the given object as JSON.static Parse<JsonNode,JsonParseOpts>
Jackson. jsonNode(ObjectMapper objectMapper)
Creates aparseable object
to parse a request body into aJsonNode
. -
Uses of Nullable in ratpack.parse
Methods in ratpack.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.server
Methods in ratpack.server with annotations of type Nullable Modifier and Type Method Description java.net.InetAddress
ServerConfig. getAddress()
The address of the interface that the application should bind to.java.lang.String
RatpackServer. getBindHost()
The actual host/ip that the application is bound to.javax.net.ssl.SSLContext
ServerConfig. getSslContext()
Deprecated.since 1.5, preferServerConfig.getNettySslContext()
-
Uses of Nullable in ratpack.session
Methods in ratpack.session with annotations of type Nullable Modifier and Type Method Description java.lang.String
SessionKey. getName()
The name.java.lang.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(java.lang.String name, java.lang.Class<T> type)
Creates a key of the given name and type.static <T> SessionKey<T>
SessionKey. of(java.lang.String name, java.lang.Class<T> type)
Creates a key of the given name and type. -
Uses of Nullable in ratpack.stream
Methods in ratpack.stream with annotations of type Nullable Modifier and Type Method Description T
StreamEvent. getItem()
The data, if this event represents an emission of data.java.lang.Throwable
StreamEvent. getThrowable()
The error, if this event represents an error. -
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.java.lang.String
HandlingResult. getBodyText()
The response body, interpreted as a utf8 string.java.lang.Integer
HandlingResult. getClientError()
The client error raised if any, unless a custom client error handler is in use.java.util.Set<io.netty.handler.codec.http.cookie.Cookie>
HandlingResult. getCookies()
The cookies to be set as part of the response.java.nio.file.Path
HandlingResult. getSentFile()
Indicates whether the result of invoking the handler was that it invoked one of theResponse.sendFile(java.nio.file.Path)
methods.<T> T
HandlingResult. rendered(java.lang.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. -
Uses of Nullable in ratpack.util
Methods in ratpack.util with annotations of type Nullable Modifier and Type Method Description V
MultiValueMap. get(java.lang.Object key)
Get the first value for the key, ornull
if there are no values for the key.
-