A B C D E F G H I J K L M N O P Q R S T U V W X Y _
All Classes All Packages
All Classes All Packages
A
- absoluteURL(boolean, String) - Method in class play.mvc.Call
-
Transform this call to an absolute URL.
- absoluteURL(Http.Request) - Method in class play.mvc.Call
-
Transform this call to an absolute URL.
- absoluteURL(Http.Request, boolean) - Method in class play.mvc.Call
-
Transform this call to an absolute URL.
- AbstractCSPAction - Class in play.filters.csp
-
Processes a request and adds content security policy header.
- AbstractCSPAction() - Constructor for class play.filters.csp.AbstractCSPAction
- accept(Function<Http.RequestHeader, Flow<In, Out, ?>>) - Method in class play.mvc.WebSocket.MappedWebSocketAcceptor
-
Accept a WebSocket.
- ACCEPT - Static variable in interface play.mvc.Http.HeaderNames
- ACCEPT_CHARSET - Static variable in interface play.mvc.Http.HeaderNames
- ACCEPT_ENCODING - Static variable in interface play.mvc.Http.HeaderNames
- ACCEPT_LANGUAGE - Static variable in interface play.mvc.Http.HeaderNames
- ACCEPT_RANGES - Static variable in interface play.mvc.Http.HeaderNames
- ACCEPTED - Static variable in interface play.mvc.Http.Status
- acceptedTypes() - Method in interface play.mvc.Http.RequestHeader
- acceptLanguages() - Method in interface play.mvc.Http.RequestHeader
-
The Request Langs extracted from the Accept-Language header and sorted by preference (preferred first).
- acceptOrResult(Function<Http.RequestHeader, CompletionStage<F.Either<Result, Flow<In, Out, ?>>>>) - Method in class play.mvc.WebSocket.MappedWebSocketAcceptor
-
Accept a WebSocket.
- accepts(String) - Method in interface play.mvc.Http.RequestHeader
-
Check if this request accepts a given media type.
- ACCESS_CONTROL_ALLOW_CREDENTIALS - Static variable in interface play.mvc.Http.HeaderNames
- ACCESS_CONTROL_ALLOW_HEADERS - Static variable in interface play.mvc.Http.HeaderNames
- ACCESS_CONTROL_ALLOW_METHODS - Static variable in interface play.mvc.Http.HeaderNames
- ACCESS_CONTROL_ALLOW_ORIGIN - Static variable in interface play.mvc.Http.HeaderNames
- ACCESS_CONTROL_EXPOSE_HEADERS - Static variable in interface play.mvc.Http.HeaderNames
- ACCESS_CONTROL_MAX_AGE - Static variable in interface play.mvc.Http.HeaderNames
- ACCESS_CONTROL_REQUEST_HEADERS - Static variable in interface play.mvc.Http.HeaderNames
- ACCESS_CONTROL_REQUEST_METHOD - Static variable in interface play.mvc.Http.HeaderNames
- AccessConnectionPoolDataSourceProxy - Class in org.jdbcdslog
-
This class is necessary because ConnectionPoolDataSourceProxy's targetDS field is protected.
- AccessConnectionPoolDataSourceProxy() - Constructor for class org.jdbcdslog.AccessConnectionPoolDataSourceProxy
- Accumulator<E,A> - Class in play.libs.streams
-
Accumulates inputs asynchronously into an output value.
- Action<T> - Class in play.mvc
-
An action acts as decorator for the action method call.
- Action() - Constructor for class play.mvc.Action
- Action.Simple - Class in play.mvc
-
A simple action with no configuration.
- actionCreator() - Method in interface play.BuiltInComponents
- actionCreator() - Method in interface play.components.HttpComponents
- actionCreator() - Method in class play.core.j.MappedJavaHandlerComponents
- ActionCreator - Interface in play.http
-
An interface for creating Java actions from Java methods.
- ActorFlow - Class in play.libs.streams
-
Provides a flow that is handled by an actor.
- ActorFlow() - Constructor for class play.libs.streams.ActorFlow
- actorRef(Function<ActorRef, Props>, int, OverflowStrategy, ActorRefFactory, Materializer) - Static method in class play.libs.streams.ActorFlow
-
Create a flow that is handled by an actor.
- actorRef(Function<ActorRef, Props>, ActorRefFactory, Materializer) - Static method in class play.libs.streams.ActorFlow
-
Create a flow that is handled by an actor.
- actorSystem() - Method in interface play.components.PekkoComponents
- actorSystem() - Method in interface play.components.PekkoTypedComponents
- actorSystem() - Method in class play.ContextBasedBuiltInComponents
- addAction(Class<A>, Supplier<A>) - Method in class play.core.j.MappedJavaHandlerComponents
- addAttr(TypedKey<A>, A) - Method in interface play.mvc.Http.Request
- addAttr(TypedKey<A>, A) - Method in interface play.mvc.Http.RequestHeader
-
Create a new versions of this object with the given attribute attached to it.
- addAttr(TypedKey<A>, A) - Method in class play.mvc.Result
-
Create a new versions of this object with the given attribute attached to it.
- addAttrs(List<TypedEntry<?>>) - Method in interface play.mvc.Http.Request
- addAttrs(List<TypedEntry<?>>) - Method in interface play.mvc.Http.RequestHeader
-
Create a new versions of this object with the given attributes attached to it.
- addAttrs(List<TypedEntry<?>>) - Method in class play.mvc.Result
-
Create a new versions of this object with the given attributes attached to it.
- addAttrs(TypedEntry<?>) - Method in interface play.mvc.Http.Request
- addAttrs(TypedEntry<?>) - Method in interface play.mvc.Http.RequestHeader
-
Create a new versions of this object with the given attribute attached to it.
- addAttrs(TypedEntry<?>) - Method in class play.mvc.Result
-
Create a new versions of this object with the given attribute attached to it.
- addAttrs(TypedEntry<?>...) - Method in class play.mvc.Result
-
Create a new versions of this object with the given attributes attached to it.
- addAttrs(TypedEntry<?>, TypedEntry<?>) - Method in interface play.mvc.Http.Request
- addAttrs(TypedEntry<?>, TypedEntry<?>) - Method in interface play.mvc.Http.RequestHeader
-
Create a new versions of this object with the given attributes attached to it.
- addAttrs(TypedEntry<?>, TypedEntry<?>) - Method in class play.mvc.Result
-
Create a new versions of this object with the given attributes attached to it.
- addAttrs(TypedEntry<?>, TypedEntry<?>, TypedEntry<?>) - Method in interface play.mvc.Http.Request
- addAttrs(TypedEntry<?>, TypedEntry<?>, TypedEntry<?>) - Method in interface play.mvc.Http.RequestHeader
-
Create a new versions of this object with the given attributes attached to it.
- addAttrs(TypedEntry<?>, TypedEntry<?>, TypedEntry<?>) - Method in class play.mvc.Result
-
Create a new versions of this object with the given attributes attached to it.
- addBodyParser(Class<B>, Supplier<B>) - Method in class play.core.j.MappedJavaHandlerComponents
- addConstraintValidator(Class<T>, Supplier<T>) - Method in class play.data.validation.MappedConstraintValidatorFactory
-
Adds validator as a non-singleton.
- addConstraintValidator(Class<T>, T) - Method in class play.data.validation.MappedConstraintValidatorFactory
-
Adds validator as a singleton.
- addCookie(WSCookie) - Method in class play.libs.ws.ahc.AhcWSRequest
- addCookie(WSCookie) - Method in interface play.libs.ws.WSRequest
-
Adds a cookie to the request
- addCookie(Http.Cookie) - Method in class play.libs.ws.ahc.AhcWSRequest
- addCookie(Http.Cookie) - Method in interface play.libs.ws.WSRequest
-
Adds a cookie to the request
- addCookies(WSCookie...) - Method in class play.libs.ws.ahc.AhcWSRequest
- addCookies(WSCookie...) - Method in interface play.libs.ws.WSRequest
-
Sets several cookies on the request.
- AddCSRFToken - Annotation Type in play.filters.csrf
-
This action adds a CSRF token to the request and response if not already there.
- addCSRFTokenAction() - Method in interface play.filters.components.CSRFComponents
- AddCSRFTokenAction - Class in play.filters.csrf
- AddCSRFTokenAction(CSRFConfig, SessionConfiguration, CSRF.TokenProvider, CSRFTokenSigner) - Constructor for class play.filters.csrf.AddCSRFTokenAction
- addHeader(String, String) - Method in class play.libs.ws.ahc.AhcWSRequest
- addHeader(String, String) - Method in interface play.libs.ws.WSRequest
-
Adds a header to the request.
- addHeader(String, String) - Method in class play.mvc.Http.Headers
-
Deprecated.Deprecated as of 2.8.0. Use
Http.Headers.adding(String, String)
instead. - addHeader(String, List<String>) - Method in class play.mvc.Http.Headers
-
Deprecated.Deprecated as of 2.8.0. Use
Http.Headers.adding(String, List)
instead. - adding(String, String) - Method in class play.mvc.Http.Flash
-
Returns a new flash with the given key-value pair added.
- adding(String, String) - Method in class play.mvc.Http.Headers
-
Add a new header with the given value.
- adding(String, String) - Method in class play.mvc.Http.Session
-
Returns a new session with the given key-value pair added.
- adding(String, List<String>) - Method in class play.mvc.Http.Headers
-
Add a new header with the given values.
- adding(Map<String, String>) - Method in class play.mvc.Http.Flash
-
Returns a new flash with the values from the given map added.
- adding(Map<String, String>) - Method in class play.mvc.Http.Session
-
Returns a new session with the values from the given map added.
- addingToSession(Http.Request, String, String) - Method in class play.mvc.Result
-
Adds the given key and value to the session.
- addingToSession(Http.Request, Map<String, String>) - Method in class play.mvc.Result
-
Adds values to the session.
- addQueryParameter(String, String) - Method in class play.libs.ws.ahc.AhcWSRequest
- addQueryParameter(String, String) - Method in interface play.libs.ws.WSRequest
-
Sets a query parameter with the given name, this can be called repeatedly.
- addStopHook(Callable<? extends CompletionStage<?>>) - Method in interface play.inject.ApplicationLifecycle
-
Add a stop hook to be called when the application stops.
- addStopHook(Callable<? extends CompletionStage<?>>) - Method in class play.inject.DelegateApplicationLifecycle
- addToSet(int, int, int, int) - Method in class play.libs.Time.CronExpression
- AGE - Static variable in interface play.mvc.Http.HeaderNames
- AhcWSClient - Class in play.libs.ws.ahc
-
A WS client backed by AsyncHttpClient implementation.
- AhcWSClient(StandaloneAhcWSClient, Materializer) - Constructor for class play.libs.ws.ahc.AhcWSClient
- AhcWSClient(AsyncHttpClient, Materializer) - Constructor for class play.libs.ws.ahc.AhcWSClient
- AhcWSClientProvider(StandaloneWSClient, Materializer) - Constructor for class play.libs.ws.ahc.AhcWSModule.AhcWSClientProvider
- AhcWSComponents - Interface in play.libs.ws.ahc
-
AsyncHttpClient WS implementation components.
- AhcWSModule - Class in play.libs.ws.ahc
-
The Play module to provide Java bindings for WS to an AsyncHTTPClient implementation.
- AhcWSModule() - Constructor for class play.libs.ws.ahc.AhcWSModule
- AhcWSModule.AhcWSClientProvider - Class in play.libs.ws.ahc
- AhcWSModule.StandaloneWSClientProvider - Class in play.libs.ws.ahc
- AhcWSRequest - Class in play.libs.ws.ahc
-
A Play WS request backed by AsyncHTTPClient implementation.
- AhcWSResponse - Class in play.libs.ws.ahc
-
A Play WS response backed by an AsyncHttpClient response.
- ALL_SPEC - Static variable in class play.libs.Time.CronExpression
- ALL_SPEC_INT - Static variable in class play.libs.Time.CronExpression
- ALLOW - Static variable in interface play.mvc.Http.HeaderNames
- AllowedHostsComponents - Interface in play.filters.components
-
Java Components for the Allowed Hosts filter.
- allowedHostsConfig() - Method in interface play.filters.components.AllowedHostsComponents
- allowedHostsFilter() - Method in interface play.filters.components.AllowedHostsComponents
- ALogger(Logger) - Constructor for class play.Logger.ALogger
- annotatedElement - Variable in class play.mvc.Action
-
Where an action was defined.
- AnnotationDateFormatter(MessagesApi) - Constructor for class play.data.format.Formats.AnnotationDateFormatter
-
Creates an annotation date formatter.
- AnnotationFormatter() - Constructor for class play.data.format.Formatters.AnnotationFormatter
- AnnotationNonEmptyFormatter() - Constructor for class play.data.format.Formats.AnnotationNonEmptyFormatter
- annotationType() - Method in class play.cache.NamedCacheImpl
- annotationType() - Method in class play.db.NamedDatabaseImpl
- annotationType() - Method in class play.inject.NamedImpl
- AnnotationUtils - Class in play.libs
-
Annotation utilities.
- AnnotationUtils() - Constructor for class play.libs.AnnotationUtils
- AnyContent(HttpErrorHandler, HttpConfiguration, PlayBodyParsers) - Constructor for class play.mvc.BodyParser.AnyContent
- anyContentBodyParser() - Method in interface play.components.BodyParserComponents
- app - Variable in class play.test.WithApplication
- app - Variable in class play.test.WithServer
- appendFragment() - Method in class play.mvc.Call
-
Returns the fragment (including the leading "#") if this call has one.
- application() - Method in interface play.components.ApplicationComponents
- application() - Method in class play.ContextBasedBuiltInComponents
- Application - Interface in play
-
A Play application.
- ApplicationComponents - Interface in play.components
-
The application component.
- applicationLifecycle() - Method in class play.ApplicationLoader.Context
-
Get the application lifecycle from the context.
- applicationLifecycle() - Method in interface play.cache.ehcache.EhCacheComponents
- applicationLifecycle() - Method in interface play.components.BaseComponents
- applicationLifecycle() - Method in class play.ContextBasedBuiltInComponents
- applicationLifecycle() - Method in interface play.controllers.AssetsComponents
- applicationLifecycle() - Method in interface play.data.validation.ValidatorsComponents
- applicationLifecycle() - Method in interface play.db.DBComponents
- applicationLifecycle() - Method in interface play.db.jpa.JPAComponents
- applicationLifecycle() - Method in interface play.libs.ws.ahc.AhcWSComponents
- ApplicationLifecycle - Interface in play.inject
-
Application lifecycle register.
- ApplicationLoader - Interface in play
-
Loads an application.
- ApplicationLoader.Context - Class in play
-
The context for loading an application.
- applicationModule() - Method in class play.inject.guice.GuiceBuilder
-
Create a Guice module that can be used to inject an Application.
- ApplicationProvider - Class in play.server
-
Provides information about a Play Application running inside a Play server.
- ApplicationProvider(Application) - Constructor for class play.server.ApplicationProvider
- apply() - Method in class play.mvc.EssentialAction
- apply(A, B, C) - Method in interface play.libs.F.Function3
- apply(A, B, C, D) - Method in interface play.libs.F.Function4
- apply(ClassLoader) - Static method in interface play.LoggerConfigurator
- apply(String) - Method in class play.data.Form
-
Retrieves a field.
- apply(String) - Method in class play.mvc.Http.Flash
-
Deprecated.Deprecated as of 2.8.0. Use
Http.Flash.get(String)
instead. - apply(String) - Method in class play.mvc.Http.Session
-
Deprecated.Deprecated as of 2.8.0. Use
Http.Session.get(String)
instead. - apply(String, Object...) - Method in interface play.i18n.Messages
-
Get the message at the given key.
- apply(String, Lang) - Method in class play.data.Form
-
Retrieves a field.
- apply(Function<Http.RequestHeader, CompletionStage<Result>>, Http.RequestHeader) - Method in class play.mvc.Filter
- apply(List<String>, Object...) - Method in interface play.i18n.Messages
-
Get the message at the first defined key.
- apply(EssentialAction) - Method in class play.mvc.EssentialFilter
- apply(RequestHeader) - Method in class play.mvc.EssentialAction
- apply(ApplicationLoader.Context) - Static method in interface play.ApplicationLoader
- apply(EssentialAction) - Method in class play.mvc.EssentialFilter
- apply(EssentialAction) - Method in class play.mvc.Filter
- apply(Http.RequestHeader) - Method in class play.mvc.BodyParser.AnyContent
- apply(Http.RequestHeader) - Method in interface play.mvc.BodyParser
-
Return an accumulator to parse the body of the given HTTP request.
- apply(Http.RequestHeader) - Method in class play.mvc.BodyParser.CompletableBodyParser
- apply(Http.RequestHeader) - Method in class play.mvc.BodyParser.Default
- apply(Http.RequestHeader) - Method in class play.mvc.BodyParser.DelegatingBodyParser
- apply(Http.RequestHeader) - Method in class play.mvc.BodyParser.Empty
- apply(Http.RequestHeader) - Method in class play.mvc.BodyParser.FormUrlEncoded
- apply(Http.RequestHeader) - Method in class play.mvc.BodyParser.Json
- apply(Http.RequestHeader) - Method in class play.mvc.BodyParser.MaxLengthBodyParser
- apply(Http.RequestHeader) - Method in class play.mvc.BodyParser.Text
- apply(Http.RequestHeader) - Method in class play.mvc.BodyParser.Xml
- apply(Http.RequestHeader) - Method in class play.mvc.EssentialAction
- apply(Http.RequestHeader) - Method in class play.mvc.WebSocket
-
Invoke the WebSocket.
- apply1(Http.RequestHeader) - Method in class play.mvc.BodyParser.BufferingBodyParser
- apply1(Http.RequestHeader) - Method in class play.mvc.BodyParser.DelegatingMultipartFormDataBodyParser
-
Delegates underlying functionality to another body parser and converts the result to Java API.
- apply1(Http.RequestHeader) - Method in class play.mvc.BodyParser.MaxLengthBodyParser
-
Implement this method to implement the actual body parser.
- apply1(Http.RequestHeader) - Method in class play.mvc.BodyParser.TemporaryFile
- apply1(Http.RequestHeader) - Method in class play.mvc.BodyParser.ToFile
- applyEvolutions(String, Database) - Static method in class play.db.evolutions.Evolutions
-
Apply evolutions for the given database.
- applyEvolutions(String, Database, boolean) - Static method in class play.db.evolutions.Evolutions
-
Apply evolutions for the given database.
- applyEvolutions(String, Database, boolean, Map<String, String>, String, String, boolean) - Static method in class play.db.evolutions.Evolutions
-
Apply evolutions for the given database.
- applyEvolutions(String, Database, Map<String, String>, String, String, boolean) - Static method in class play.db.evolutions.Evolutions
-
Apply evolutions for the given database.
- applyEvolutions(String, Database, EvolutionsReader) - Static method in class play.db.evolutions.Evolutions
-
Apply evolutions for the given database.
- applyEvolutions(String, Database, EvolutionsReader, boolean) - Static method in class play.db.evolutions.Evolutions
-
Apply evolutions for the given database.
- applyEvolutions(String, Database, EvolutionsReader, boolean, Map<String, String>, String, String, boolean) - Static method in class play.db.evolutions.Evolutions
-
Apply evolutions for the given database.
- applyEvolutions(String, Database, EvolutionsReader, Map<String, String>, String, String, boolean) - Static method in class play.db.evolutions.Evolutions
-
Apply evolutions for the given database.
- applyEvolutions(Database) - Static method in class play.db.evolutions.Evolutions
-
Apply evolutions for the given database.
- applyEvolutions(Database, boolean) - Static method in class play.db.evolutions.Evolutions
-
Apply evolutions for the given database.
- applyEvolutions(Database, boolean, String) - Static method in class play.db.evolutions.Evolutions
-
Apply evolutions for the given database.
- applyEvolutions(Database, boolean, String, String) - Static method in class play.db.evolutions.Evolutions
-
Apply evolutions for the given database.
- applyEvolutions(Database, boolean, String, String, Map<String, String>, String, String, boolean) - Static method in class play.db.evolutions.Evolutions
-
Apply evolutions for the given database.
- applyEvolutions(Database, boolean, String, Map<String, String>, String, String, boolean) - Static method in class play.db.evolutions.Evolutions
-
Apply evolutions for the given database.
- applyEvolutions(Database, boolean, Map<String, String>, String, String, boolean) - Static method in class play.db.evolutions.Evolutions
-
Apply evolutions for the given database.
- applyEvolutions(Database, String) - Static method in class play.db.evolutions.Evolutions
-
Apply evolutions for the given database.
- applyEvolutions(Database, String, String) - Static method in class play.db.evolutions.Evolutions
-
Apply evolutions for the given database.
- applyEvolutions(Database, String, String, Map<String, String>, String, String, boolean) - Static method in class play.db.evolutions.Evolutions
-
Apply evolutions for the given database.
- applyEvolutions(Database, String, Map<String, String>, String, String, boolean) - Static method in class play.db.evolutions.Evolutions
-
Apply evolutions for the given database.
- applyEvolutions(Database, Map<String, String>, String, String, boolean) - Static method in class play.db.evolutions.Evolutions
-
Apply evolutions for the given database.
- applyEvolutions(Database, EvolutionsReader) - Static method in class play.db.evolutions.Evolutions
-
Apply evolutions for the given database.
- applyEvolutions(Database, EvolutionsReader, boolean) - Static method in class play.db.evolutions.Evolutions
-
Apply evolutions for the given database.
- applyEvolutions(Database, EvolutionsReader, boolean, String) - Static method in class play.db.evolutions.Evolutions
-
Apply evolutions for the given database.
- applyEvolutions(Database, EvolutionsReader, boolean, String, String) - Static method in class play.db.evolutions.Evolutions
-
Apply evolutions for the given database.
- applyEvolutions(Database, EvolutionsReader, boolean, String, String, Map<String, String>, String, String, boolean) - Static method in class play.db.evolutions.Evolutions
-
Apply evolutions for the given database.
- applyEvolutions(Database, EvolutionsReader, boolean, String, Map<String, String>, String, String, boolean) - Static method in class play.db.evolutions.Evolutions
-
Apply evolutions for the given database.
- applyEvolutions(Database, EvolutionsReader, boolean, Map<String, String>, String, String, boolean) - Static method in class play.db.evolutions.Evolutions
-
Apply evolutions for the given database.
- applyEvolutions(Database, EvolutionsReader, String) - Static method in class play.db.evolutions.Evolutions
-
Apply evolutions for the given database.
- applyEvolutions(Database, EvolutionsReader, String, String) - Static method in class play.db.evolutions.Evolutions
-
Apply evolutions for the given database.
- applyEvolutions(Database, EvolutionsReader, String, String, Map<String, String>, String, String, boolean) - Static method in class play.db.evolutions.Evolutions
-
Apply evolutions for the given database.
- applyEvolutions(Database, EvolutionsReader, String, Map<String, String>, String, String, boolean) - Static method in class play.db.evolutions.Evolutions
-
Apply evolutions for the given database.
- applyEvolutions(Database, EvolutionsReader, Map<String, String>, String, String, boolean) - Static method in class play.db.evolutions.Evolutions
-
Apply evolutions for the given database.
- arguments() - Method in class play.data.validation.ValidationError
-
Returns the error arguments.
- as(Class<T>) - Method in class play.mvc.Http.RequestBody
-
Cast this RequestBody as T if possible.
- as(String) - Method in class play.http.HttpEntity
- as(String) - Method in class play.http.HttpEntity.Chunked
- as(String) - Method in class play.http.HttpEntity.Streamed
- as(String) - Method in class play.http.HttpEntity.Strict
- as(String) - Method in class play.mvc.Result
-
Return a copy of the result with a different Content-Type header.
- asArray(Class<T>, Seq<T>) - Static method in class play.libs.Scala
-
Converts a Scala List to an Array.
- asByteArray() - Method in class play.libs.ws.ahc.AhcWSResponse
-
Deprecated.Use
response.getBodyAsBytes().toArray()
- asByteArray() - Method in interface play.libs.ws.WSResponse
-
Gets the body as an array of bytes.
- asBytes() - Method in class play.mvc.Http.RawBuffer
- asBytes() - Method in class play.mvc.Http.RequestBody
-
The request content as a ByteString.
- asBytes(int) - Method in class play.mvc.Http.RawBuffer
-
Returns the buffer content as a bytes array.
- asciiStringify(JsonNode) - Static method in class play.libs.Json
-
Converts a JsonNode to its string representation, escaping non-ascii characters.
- asFile() - Method in class play.mvc.Http.RawBuffer
- asFormUrlEncoded() - Method in class play.mvc.Http.MultipartFormData
-
Extract the data parts as Form url encoded.
- asFormUrlEncoded() - Method in class play.mvc.Http.RequestBody
-
The request content parsed as URL form-encoded.
- asJava() - Method in class play.mvc.EssentialAction
- asJava() - Method in class play.mvc.EssentialFilter
- asJava(Map<K, V>) - Static method in class play.libs.Scala
-
Converts a Scala Map to Java.
- asJava(Seq<T>) - Static method in class play.libs.Scala
-
Converts a Scala List to Java.
- asJava(Tuple2<A, B>) - Static method in class play.libs.Scala
-
Converts a scala
Tuple2
to a java F.Tuple. - asJson() - Method in class play.libs.ws.ahc.AhcWSResponse
-
Deprecated.Use
response.getBody(json())
- asJson() - Method in interface play.libs.ws.WSResponse
-
Gets the body as JSON node.
- asJson() - Method in class play.mvc.Http.RequestBody
- asMap() - Method in class play.cache.caffeine.NamedCaffeineCache
- asMap() - Method in class play.mvc.Http.Headers
- asMultipartFormData() - Method in class play.mvc.Http.RequestBody
-
The request content parsed as multipart form data.
- asRaw() - Method in class play.mvc.Http.RequestBody
- asScala() - Method in interface play.Application
-
Get the application as a Scala application.
- asScala() - Method in class play.ApplicationLoader.Context
-
Get the wrapped Scala context.
- asScala() - Method in interface play.db.ConnectionPool
- asScala() - Method in interface play.db.Database
-
Converts the given database to a Scala database
- asScala() - Method in class play.db.DefaultConnectionPool
- asScala() - Method in enum play.db.TransactionIsolationLevel
- asScala() - Method in class play.DefaultApplication
-
Get the application as a Scala application.
- asScala() - Method in class play.Environment
-
The underlying Scala API Environment object that this Environment wraps.
- asScala() - Method in class play.http.HttpEntity
- asScala() - Method in class play.http.HttpEntity.Chunked
- asScala() - Method in class play.http.HttpEntity.Streamed
- asScala() - Method in class play.http.HttpEntity.Strict
- asScala() - Method in interface play.http.HttpFilters
- asScala() - Method in interface play.http.HttpRequestHandler
- asScala() - Method in class play.i18n.Langs
- asScala() - Method in interface play.i18n.Messages
- asScala() - Method in class play.i18n.MessagesApi
- asScala() - Method in class play.i18n.MessagesImpl
- asScala() - Method in interface play.inject.ApplicationLifecycle
- asScala() - Method in class play.inject.Binding
- asScala() - Method in class play.inject.BindingKey
- asScala() - Method in class play.inject.BindingKeyTarget
- asScala() - Method in class play.inject.BindingTarget
- asScala() - Method in class play.inject.ConstructionTarget
- asScala() - Method in class play.inject.DelegateApplicationLifecycle
- asScala() - Method in class play.inject.DelegateInjector
- asScala() - Method in interface play.inject.Injector
-
Get as an instance of the Scala injector.
- asScala() - Method in class play.inject.ProviderConstructionTarget
- asScala() - Method in class play.inject.ProviderTarget
- asScala() - Method in class play.inject.QualifierAnnotation
- asScala() - Method in class play.inject.QualifierClass
- asScala() - Method in class play.inject.QualifierInstance
- asScala() - Method in interface play.libs.crypto.CookieSigner
- asScala() - Method in interface play.libs.crypto.CSRFTokenSigner
-
Utility method needed for CSRFCheck.
- asScala() - Method in class play.libs.crypto.DefaultCookieSigner
- asScala() - Method in class play.libs.crypto.DefaultCSRFTokenSigner
- asScala() - Method in class play.libs.Files.DelegateTemporaryFileCreator
- asScala() - Method in class play.libs.Files.SingletonTemporaryFileCreator
- asScala() - Method in interface play.libs.Files.TemporaryFileCreator
- asScala() - Method in class play.libs.streams.Accumulator
-
Convert this accumulator to a Scala accumulator.
- asScala() - Method in class play.libs.typedmap.TypedEntry
- asScala() - Method in class play.libs.typedmap.TypedKey
- asScala() - Method in class play.libs.typedmap.TypedMap
- asScala() - Method in class play.libs.ws.ahc.AhcWSClient
- asScala() - Method in interface play.libs.ws.WSClient
- asScala() - Method in enum play.Mode
- asScala() - Method in class play.mvc.EssentialFilter
- asScala() - Method in class play.mvc.FileMimeTypes
- asScala() - Method in class play.mvc.Filter
- asScala() - Method in class play.mvc.Http.Cookie
- asScala() - Method in enum play.mvc.Http.Cookie.SameSite
- asScala() - Method in class play.mvc.Http.Flash
-
Convert this flash to a Scala flash.
- asScala() - Method in class play.mvc.Http.Headers
- asScala() - Method in class play.mvc.Http.MultipartFormData.FilePart
- asScala() - Method in interface play.mvc.Http.Request
- asScala() - Method in interface play.mvc.Http.RequestHeader
- asScala() - Method in class play.mvc.Http.Session
-
Convert this session to a Scala session.
- asScala() - Method in class play.mvc.ResponseHeader
- asScala() - Method in class play.mvc.Result
-
Convert this result to a Scala result.
- asScala() - Method in interface play.routing.Router
- asScala() - Method in class play.server.ApplicationProvider
- asScala(Collection<A>) - Static method in class play.libs.Scala
-
Converts a Java Collection to a Scala Seq.
- asScala(Callable<A>) - Static method in class play.libs.Scala
-
Converts a Java Callable to a Scala Function0.
- asScala(Map<K, V>) - Static method in class play.libs.Scala
-
Converts a Java Map to Scala.
- asScalaWithFuture(Callable<CompletionStage<A>>) - Static method in class play.libs.Scala
-
Converts a Java Callable to a Scala Function0.
- assets() - Method in interface play.controllers.AssetsComponents
- AssetsComponents - Interface in play.controllers
-
Java components for Assets.
- assetsConfiguration() - Method in interface play.controllers.AssetsComponents
- assetsFinder() - Method in interface play.controllers.AssetsComponents
- assetsMetadata() - Method in interface play.controllers.AssetsComponents
- asText() - Method in class play.mvc.Http.RequestBody
- asXml() - Method in class play.libs.ws.ahc.AhcWSResponse
-
Deprecated.Use
response.getBody(xml())
- asXml() - Method in interface play.libs.ws.WSResponse
-
return the body as XML.
- asXml() - Method in class play.mvc.Http.RequestBody
- AsyncCacheApi - Interface in play.cache
-
The Cache API.
- asyncHttpClient() - Method in interface play.libs.ws.ahc.AhcWSComponents
- asyncTryWithResource(T, Function<T, CompletionStage<U>>) - Static method in class play.libs.Resources
- at(String, Object...) - Method in interface play.i18n.Messages
-
Get the message at the given key.
- at(String, Object...) - Method in class play.i18n.MessagesImpl
-
Get the message at the given key.
- at(List<String>, Object...) - Method in interface play.i18n.Messages
-
Get the message at the first defined key.
- at(List<String>, Object...) - Method in class play.i18n.MessagesImpl
-
Get the message at the first defined key.
- atomicMoveFileWithFallback(File) - Method in class play.libs.Files.DelegateTemporaryFile
-
Deprecated.
- atomicMoveFileWithFallback(File) - Method in interface play.libs.Files.TemporaryFile
-
Deprecated.Deprecated as of 2.8.0. Renamed to
Files.TemporaryFile.atomicMoveWithFallback(File)
. - atomicMoveFileWithFallback(Path) - Method in interface play.libs.Files.TemporaryFile
-
Deprecated.Deprecated as of 2.8.0. Renamed to
Files.TemporaryFile.atomicMoveWithFallback(Path)
. - atomicMoveWithFallback(File) - Method in class play.libs.Files.DelegateTemporaryFile
- atomicMoveWithFallback(File) - Method in interface play.libs.Files.TemporaryFile
-
Attempts to move source to target atomically and falls back to a non-atomic move if it fails.
- atomicMoveWithFallback(Path) - Method in interface play.libs.Files.TemporaryFile
-
Attempts to move source to target atomically and falls back to a non-atomic move if it fails.
- attr(TypedKey<T>, T) - Method in class play.mvc.Http.RequestBuilder
-
Add an attribute to the request.
- attributes() - Method in annotation type play.data.Form.Display
- attributes() - Method in class play.libs.openid.UserInfo
- attrs() - Method in class play.mvc.Http.RequestBuilder
- attrs() - Method in interface play.mvc.Http.RequestHeader
- attrs() - Method in class play.mvc.Result
- attrs(TypedMap) - Method in class play.mvc.Http.RequestBuilder
-
Update the request attributes.
- Attrs() - Constructor for class play.http.HttpErrorHandler.Attrs
- Attrs() - Constructor for class play.i18n.Messages.Attrs
- Attrs() - Constructor for class play.routing.Router.Attrs
- AuthenticatedAction(Function<Security.Authenticated, Security.Authenticator>) - Constructor for class play.mvc.Security.AuthenticatedAction
- AuthenticatedAction(Injector) - Constructor for class play.mvc.Security.AuthenticatedAction
- AuthenticatedAction(Security.Authenticator) - Constructor for class play.mvc.Security.AuthenticatedAction
- Authenticator() - Constructor for class play.mvc.Security.Authenticator
- AUTHORIZATION - Static variable in interface play.mvc.Http.HeaderNames
- availables() - Method in class play.i18n.Langs
-
The available languages.
- availables(Application) - Static method in class play.i18n.Lang
-
Retrieve Lang availables from the application configuration.
- awaitTimeoutMillis - Variable in class play.cache.DefaultSyncCacheApi
B
- BAD_GATEWAY - Static variable in interface play.mvc.Http.Status
- BAD_REQUEST - Static variable in interface play.mvc.Http.Status
- badRequest() - Static method in class play.mvc.Results
-
Generates a 400 Bad Request result.
- badRequest(byte[]) - Static method in class play.mvc.Results
-
Generates a 400 Bad Request result.
- badRequest(JsonNode) - Static method in class play.mvc.Results
-
Generates a 400 Bad Request result.
- badRequest(JsonNode, JsonEncoding) - Static method in class play.mvc.Results
-
Generates a 400 Bad Request result.
- badRequest(File) - Static method in class play.mvc.Results
-
Generates a 400 Bad Request result.
- badRequest(File, boolean) - Static method in class play.mvc.Results
-
Generates a 400 Bad Request result.
- badRequest(File, boolean, Optional<String>) - Static method in class play.mvc.Results
-
Generates a 400 Bad Request result.
- badRequest(File, boolean, Optional<String>, FileMimeTypes) - Static method in class play.mvc.Results
-
Generates a 400 Bad Request result.
- badRequest(File, boolean, FileMimeTypes) - Static method in class play.mvc.Results
-
Generates a 400 Bad Request result.
- badRequest(File, String) - Static method in class play.mvc.Results
-
Deprecated.Deprecated as of 2.8.0. Use to
Results.badRequest(File, Optional)
. - badRequest(File, String, FileMimeTypes) - Static method in class play.mvc.Results
-
Deprecated.Deprecated as of 2.8.0. Use to
Results.badRequest(File, Optional, FileMimeTypes)
. - badRequest(File, Optional<String>) - Static method in class play.mvc.Results
-
Generates a 400 Bad Request result.
- badRequest(File, Optional<String>, FileMimeTypes) - Static method in class play.mvc.Results
-
Generates a 400 Bad Request result.
- badRequest(File, FileMimeTypes) - Static method in class play.mvc.Results
-
Generates a 400 Bad Request result.
- badRequest(InputStream) - Static method in class play.mvc.Results
-
Generates a 400 Bad Request result.
- badRequest(InputStream, long) - Static method in class play.mvc.Results
-
Generates a 400 Bad Request result.
- badRequest(String) - Static method in class play.mvc.Results
-
Generates a 400 Bad Request result.
- badRequest(String, String) - Static method in class play.mvc.Results
-
Generates a 400 Bad Request result.
- badRequest(Path) - Static method in class play.mvc.Results
-
Generates a 400 Bad Request result.
- badRequest(Path, boolean) - Static method in class play.mvc.Results
-
Generates a 400 Bad Request result.
- badRequest(Path, boolean, Optional<String>) - Static method in class play.mvc.Results
-
Generates a 400 Bad Request result.
- badRequest(Path, boolean, Optional<String>, FileMimeTypes) - Static method in class play.mvc.Results
-
Generates a 400 Bad Request result.
- badRequest(Path, boolean, FileMimeTypes) - Static method in class play.mvc.Results
-
Generates a 400 Bad Request result.
- badRequest(Path, Optional<String>) - Static method in class play.mvc.Results
-
Generates a 400 Bad Request result.
- badRequest(Path, Optional<String>, FileMimeTypes) - Static method in class play.mvc.Results
-
Generates a 400 Bad Request result.
- badRequest(Path, FileMimeTypes) - Static method in class play.mvc.Results
-
Generates a 400 Bad Request result.
- badRequest(Content) - Static method in class play.mvc.Results
-
Generates a 400 Bad Request result.
- badRequest(Content, String) - Static method in class play.mvc.Results
-
Generates a 400 Bad Request result.
- BaseComponents - Interface in play.components
- Binary - Static variable in class play.mvc.WebSocket
-
Acceptor for binary WebSockets.
- Binary(ByteString) - Constructor for class play.http.websocket.Message.Binary
- BINARY - Static variable in interface play.mvc.Http.MimeTypes
-
Content-Type of binary data.
- bind(Class<T>) - Static method in class play.inject.Bindings
-
Create a binding key for the given class.
- bind(String, String) - Method in interface play.mvc.PathBindable
-
Bind an URL path parameter.
- bind(String, Map<String, String[]>) - Method in interface play.mvc.QueryStringBindable
-
Bind a query string parameter.
- bind(Lang, TypedMap, JsonNode, long, int, String...) - Method in class play.data.Form
-
Binds Json data to this form - that is, handles form submission.
- bind(Lang, TypedMap, JsonNode, long, String...) - Method in class play.data.DynamicForm
- bind(Lang, TypedMap, JsonNode, long, String...) - Method in class play.data.Form
-
Binds Json data to this form - that is, handles form submission.
- bind(Lang, TypedMap, JsonNode, String...) - Method in class play.data.DynamicForm
-
Deprecated.
- bind(Lang, TypedMap, JsonNode, String...) - Method in class play.data.Form
-
Deprecated.Deprecated as of 2.8.3. Use
Form.bind(Lang, TypedMap, JsonNode, long, String...)
instead to specify the maximum chars that should be consumed by the flattened form representation of the JSON. - bind(Lang, TypedMap, Map<String, String>, String...) - Method in class play.data.DynamicForm
- bind(Lang, TypedMap, Map<String, String>, String...) - Method in class play.data.Form
-
Binds data to this form - that is, handles form submission.
- bind(Lang, TypedMap, Map<String, String>, Map<String, Http.MultipartFormData.FilePart<?>>, String...) - Method in class play.data.DynamicForm
- bind(Lang, TypedMap, Map<String, String>, Map<String, Http.MultipartFormData.FilePart<?>>, String...) - Method in class play.data.Form
-
Binds data to this form - that is, handles form submission.
- bindActor(Class<T>, String) - Method in interface play.libs.pekko.PekkoGuiceSupport
-
Bind an actor.
- bindActor(Class<T>, String, Function<Props, Props>) - Method in interface play.libs.pekko.PekkoGuiceSupport
-
Bind an actor.
- bindActorFactory(Class<T>, Class<?>) - Method in interface play.libs.pekko.PekkoGuiceSupport
-
Bind an actor factory.
- bindClass(Class<T>) - Static method in class play.inject.Module
-
Create a binding key for the given class.
- bindFromRequest(Http.Request, String...) - Method in class play.data.DynamicForm
- bindFromRequest(Http.Request, String...) - Method in class play.data.Form
-
Binds request data to this form - that is, handles form submission.
- bindFromRequestData(Lang, TypedMap, Map<String, String[]>, String...) - Method in class play.data.Form
-
Binds request data to this form - that is, handles form submission.
- bindFromRequestData(Lang, TypedMap, Map<String, String[]>, Map<String, Http.MultipartFormData.FilePart<?>>, String...) - Method in class play.data.DynamicForm
- bindFromRequestData(Lang, TypedMap, Map<String, String[]>, Map<String, Http.MultipartFormData.FilePart<?>>, String...) - Method in class play.data.Form
-
Binds request data to this form - that is, handles form submission.
- Binding<T> - Class in play.inject
-
A binding.
- Binding(Binding<T>) - Constructor for class play.inject.Binding
- Binding(BindingKey<T>, Optional<BindingTarget<T>>, Optional<Class<? extends Annotation>>, Boolean, Object) - Constructor for class play.inject.Binding
- BindingKey<T> - Class in play.inject
-
A binding key.
- BindingKey(Class<T>) - Constructor for class play.inject.BindingKey
- BindingKey(Class<T>, Optional<QualifierAnnotation>) - Constructor for class play.inject.BindingKey
-
A binding key.
- BindingKey(BindingKey<T>) - Constructor for class play.inject.BindingKey
- BindingKeyTarget<T> - Class in play.inject
-
A binding target that is provided by another key - essentially an alias.
- BindingKeyTarget(BindingKeyTarget<T>) - Constructor for class play.inject.BindingKeyTarget
- BindingKeyTarget(BindingKey<? extends T>) - Constructor for class play.inject.BindingKeyTarget
- bindings(Module...) - Method in class play.inject.guice.GuiceBuilder
-
Add bindings from Guice modules.
- bindings(Environment, Configuration) - Method in class play.inject.Module
- bindings(Binding...) - Static method in class play.inject.guice.Guiceable
- bindings(Binding<?>...) - Method in class play.inject.guice.GuiceBuilder
-
Add Play bindings.
- bindings(GuiceableModule...) - Method in class play.inject.guice.GuiceBuilder
-
Add bindings from guiceable modules.
- bindings(Module...) - Method in class play.inject.guice.GuiceBuilder
-
Add bindings from Play modules.
- bindings(Environment, Config) - Method in class play.data.format.FormattersModule
- bindings(Environment, Config) - Method in class play.data.FormFactoryModule
- bindings(Environment, Config) - Method in class play.data.validation.ValidatorsModule
- bindings(Environment, Config) - Method in class play.db.DBModule
- bindings(Environment, Config) - Method in class play.db.jpa.JPAModule
- bindings(Environment, Config) - Method in class play.inject.BuiltInModule
- bindings(Environment, Config) - Method in class play.inject.Module
- bindings(Environment, Config) - Method in class play.libs.openid.OpenIdModule
- bindings(Environment, Config) - Method in class play.libs.ws.ahc.AhcWSModule
- Bindings - Class in play.inject
- Bindings() - Constructor for class play.inject.Bindings
- BindingTarget<T> - Class in play.inject
-
A binding target.
- bindValue(A) - Method in class play.libs.typedmap.TypedKey
-
Bind this key to a value.
- blankInstance() - Method in class play.data.Form
- body() - Method in class play.libs.Jsonp
- body() - Method in interface play.mvc.Http.Request
- body() - Method in class play.mvc.Http.RequestBuilder
- body() - Method in class play.mvc.Result
-
Get the body of this result.
- body(Http.RequestBody) - Method in class play.mvc.Http.RequestBuilder
-
Set the body of the request.
- body(Http.RequestBody, String) - Method in class play.mvc.Http.RequestBuilder
-
Set the body of the request.
- bodyForm(Map<String, String>) - Method in class play.mvc.Http.RequestBuilder
-
Set a Form url encoded body to this request.
- bodyFormArrayValues(Map<String, String[]>) - Method in class play.mvc.Http.RequestBuilder
-
Set a Form url encoded body to this request.
- bodyJson(JsonNode) - Method in class play.mvc.Http.RequestBuilder
-
Set a Json Body to this request.
- bodyJson(JsValue) - Method in class play.mvc.Http.RequestBuilder
-
Set a Json Body to this request.
- bodyMultipart(List<Http.MultipartFormData.Part<Source<ByteString, ?>>>, Files.TemporaryFileCreator, Materializer) - Method in class play.mvc.Http.RequestBuilder
-
Deprecated.Deprecated as of 2.7.0. Renamed to
Http.RequestBuilder.bodyRaw(List, Files.TemporaryFileCreator, Materializer)
. - bodyMultipart(Map<String, String[]>, List<Http.MultipartFormData.FilePart>) - Method in class play.mvc.Http.RequestBuilder
-
Set a Multipart Form url encoded body to this request.
- BodyParser<A> - Interface in play.mvc
-
A body parser parses the HTTP request body content.
- BodyParser.AnyContent - Class in play.mvc
-
Guess the body content by checking the Content-Type header.
- BodyParser.BufferingBodyParser<A> - Class in play.mvc
-
A body parser that first buffers
- BodyParser.Bytes - Class in play.mvc
-
Parse the body as a byte string.
- BodyParser.CompletableBodyParser<A> - Class in play.mvc
-
A body parser that completes the underlying one.
- BodyParser.Default - Class in play.mvc
-
If the request has a body, guess the body content by checking the Content-Type header.
- BodyParser.DelegatingBodyParser<A,B> - Class in play.mvc
-
A body parser that delegates to a Scala body parser, and uses the supplied function to transform its result to a Java body.
- BodyParser.DelegatingMultipartFormDataBodyParser<A> - Class in play.mvc
-
A body parser that exposes a file part handler as an abstract method and delegates the implementation to the underlying Scala multipartParser.
- BodyParser.Empty - Class in play.mvc
-
Don't parse the body.
- BodyParser.FormUrlEncoded - Class in play.mvc
-
Parse the body as form url encoded if the Content-Type is application/x-www-form-urlencoded.
- BodyParser.Json - Class in play.mvc
-
Parse the body as Json if the Content-Type is text/json or application/json.
- BodyParser.MaxLengthBodyParser<A> - Class in play.mvc
-
Abstract body parser that enforces a maximum length.
- BodyParser.MultipartFormData - Class in play.mvc
-
Parse the body as multipart form-data without checking the Content-Type.
- BodyParser.Of - Annotation Type in play.mvc
-
Specify the body parser to use for an Action method.
- BodyParser.Raw - Class in play.mvc
-
Store the body content in a RawBuffer.
- BodyParser.TemporaryFile - Class in play.mvc
- BodyParser.Text - Class in play.mvc
-
Parse the body as text if the Content-Type is text/plain.
- BodyParser.ToFile - Class in play.mvc
- BodyParser.TolerantJson - Class in play.mvc
-
Parse the body as Json without checking the Content-Type.
- BodyParser.TolerantText - Class in play.mvc
-
Parse the body as text without checking the Content-Type.
- BodyParser.TolerantXml - Class in play.mvc
-
Parse the body as Xml without checking the Content-Type.
- BodyParser.Xml - Class in play.mvc
-
Parse the body as Xml if the Content-Type is application/xml.
- BodyParserComponents - Interface in play.components
-
Java BodyParser components.
- BodyParsers - Class in play.mvc
-
Utilities for creating body parsers.
- BodyParsers() - Constructor for class play.mvc.BodyParsers
- bodyRaw(byte[]) - Method in class play.mvc.Http.RequestBuilder
-
Set a Binary Data to this request using a singleton temporary file creator.
- bodyRaw(byte[], Files.TemporaryFileCreator) - Method in class play.mvc.Http.RequestBuilder
-
Set a Binary Data to this request.
- bodyRaw(List<Http.MultipartFormData.Part<Source<ByteString, ?>>>, Files.TemporaryFileCreator, Materializer) - Method in class play.mvc.Http.RequestBuilder
-
Set a Multipart Form url encoded body to this request saving it as a raw body.
- bodyRaw(ByteString) - Method in class play.mvc.Http.RequestBuilder
-
Set a Binary Data to this request using a singleton temp file creator The
Content-Type
header of the request is set toapplication/octet-stream
. - bodyRaw(ByteString, Files.TemporaryFileCreator) - Method in class play.mvc.Http.RequestBuilder
-
Set a Binary Data to this request.
- bodyText(String) - Method in class play.mvc.Http.RequestBuilder
-
Set a Text to this request.
- bodyText(String, Charset) - Method in class play.mvc.Http.RequestBuilder
-
Set a Text to this request.
- bodyXml(Document) - Method in class play.mvc.Http.RequestBuilder
-
Set a XML to this request.
- bodyXml(InputSource) - Method in class play.mvc.Http.RequestBuilder
-
Set a XML to this request.
- boundaryToContentType(String) - Static method in class play.mvc.MultipartFormatter
- browser - Variable in class play.test.WithBrowser
- BufferingBodyParser(long, HttpErrorHandler, String) - Constructor for class play.mvc.BodyParser.BufferingBodyParser
- BufferingBodyParser(HttpConfiguration, HttpErrorHandler, String) - Constructor for class play.mvc.BodyParser.BufferingBodyParser
- build() - Method in class play.inject.guice.GuiceApplicationBuilder
-
Create a new Play Application using this configured builder.
- build() - Method in class play.inject.guice.GuiceInjectorBuilder
-
Create a Play Injector backed by Guice using this configured builder.
- build() - Method in class play.mvc.Http.CookieBuilder
- build() - Method in class play.mvc.Http.RequestBuilder
-
Builds the request.
- build() - Method in class play.routing.RoutingDsl
-
Build the router.
- build(Function<BuiltInComponents, Router>) - Method in class play.server.Server.Builder
-
Build the server and begin serving the provided routes as configured.
- build(Router) - Method in class play.server.Server.Builder
-
Build the server and begin serving the provided routes as configured.
- builder(String, String) - Static method in class play.mvc.Http.Cookie
- builder(ApplicationLoader.Context) - Method in class play.inject.guice.GuiceApplicationLoader
-
Construct a builder to use for loading the given context.
- Builder() - Constructor for class play.server.Server.Builder
- buildExpression(String) - Method in class play.libs.Time.CronExpression
- BuiltInComponents - Interface in play
-
Helper to provide the Play built in components.
- BuiltInComponentsFromContext - Class in play
-
This helper class provides all the built-in component dependencies by trading them for a single dependency - the application loader context.
- BuiltInComponentsFromContext(ApplicationLoader.Context) - Constructor for class play.BuiltInComponentsFromContext
- BuiltInModule - Class in play.inject
- BuiltInModule() - Constructor for class play.inject.BuiltInModule
- bypassWith(Function<In, F.Either<FlowIn, Out>>, Flow<FlowIn, Out, ?>) - Static method in class play.libs.streams.PekkoStreams
-
Bypass the given flow using the given splitter function.
- bypassWith(Flow<In, F.Either<FlowIn, Out>, ?>, Graph<UniformFanInShape<Out, Out>, ?>, Flow<FlowIn, Out, ?>) - Static method in class play.libs.streams.PekkoStreams
-
Using the given splitter flow, allow messages to bypass a flow.
- Bytes(long, HttpErrorHandler) - Constructor for class play.mvc.BodyParser.Bytes
- Bytes(HttpConfiguration, HttpErrorHandler) - Constructor for class play.mvc.BodyParser.Bytes
- bytesBodyParser() - Method in interface play.components.BodyParserComponents
C
- CACHE_CONTROL - Static variable in interface play.mvc.Http.HeaderNames
- cacheApi(String) - Method in interface play.cache.caffeine.CaffeineCacheComponents
- cacheApi(String) - Method in interface play.cache.ehcache.EhCacheComponents
- Cached - Annotation Type in play.cache
-
Mark an action to be cached on server side.
- CachedAction - Class in play.cache
-
Cache another action.
- CachedAction(AsyncCacheApi) - Constructor for class play.cache.CachedAction
- cacheManager() - Method in interface play.libs.jcache.JCacheComponents
- CaffeineCacheComponents - Interface in play.cache.caffeine
-
Caffeine Cache Java Components for compile time injection.
- CaffeineDefaultExpiry - Class in play.cache.caffeine
-
Deprecated.Deprecated as of 2.8.0. This is an implementation detail and it was not supposed to be public.
- CaffeineDefaultExpiry() - Constructor for class play.cache.caffeine.CaffeineDefaultExpiry
-
Deprecated.
- CaffeineExecutionContext - Class in play.cache.caffeine
- CaffeineExecutionContext(ActorSystem, String) - Constructor for class play.cache.caffeine.CaffeineExecutionContext
- CaffeineParser - Class in play.cache.caffeine
-
A configuration parser for the
Caffeine
builder. - call(Connection) - Method in interface play.db.ConnectionCallable
- call(Http.Request) - Method in class play.cache.CachedAction
- call(Http.Request) - Method in class play.filters.csp.AbstractCSPAction
- call(Http.Request) - Method in class play.filters.csrf.AddCSRFTokenAction
- call(Http.Request) - Method in class play.filters.csrf.RequireCSRFCheckAction
- call(Http.Request) - Method in class play.mvc.Action
-
Executes this action with the given HTTP request and returns the result.
- call(Http.Request) - Method in class play.mvc.Security.AuthenticatedAction
- Call - Class in play.mvc
-
Defines a 'call', describing an HTTP request.
- Call() - Constructor for class play.mvc.Call
- canonical() - Method in class play.mvc.Call
-
Transform this path into its canonical form.
- canonical(String) - Static method in class play.core.Paths
-
Create a canonical path that does not contain parent directories, current directories, or superfluous directory separators.
- charset() - Method in interface play.mvc.Http.RequestHeader
- charset() - Method in class play.mvc.Result
-
Extracts the Charset of this Result value.
- checkNext(int, String, int, int) - Method in class play.libs.Time.CronExpression
- chunked(Source<ByteString, ?>) - Method in class play.mvc.StatusHeader
-
Send a chunked response with the given chunks.
- chunked(Source<ByteString, ?>, boolean, Optional<String>) - Method in class play.mvc.StatusHeader
-
Send a chunked response with the given chunks.
- chunked(Source<ByteString, ?>, boolean, Optional<String>, FileMimeTypes) - Method in class play.mvc.StatusHeader
-
Send a chunked response with the given chunks.
- chunked(Source<ByteString, ?>, Optional<String>) - Static method in class play.http.HttpEntity
-
Convert the given source of ByteStrings to a chunked entity.
- chunked(Source<ByteString, ?>, Optional<String>) - Method in class play.mvc.StatusHeader
-
Send a chunked response with the given chunks.
- Chunked(Source<HttpChunk, ?>, Optional<String>) - Constructor for class play.http.HttpEntity.Chunked
- chunks() - Method in class play.http.HttpEntity.Chunked
- classloader() - Method in interface play.Application
-
Get the application classloader.
- classLoader() - Method in class play.Environment
-
The classloader that all application classes and resources can be loaded from.
- classLoader() - Method in class play.routing.HandlerDef
- ClassLoaderExecution - Class in play.libs.concurrent
-
ExecutionContexts that preserve the current thread's context ClassLoader by passing it through
ClassLoaderExecutionContext
. - ClassLoaderExecution() - Constructor for class play.libs.concurrent.ClassLoaderExecution
- ClassLoaderExecutionContext - Class in play.libs.concurrent
-
Execution context for managing the ClassLoader scope.
- ClassLoaderExecutionContext(Executor) - Constructor for class play.libs.concurrent.ClassLoaderExecutionContext
- classTag() - Static method in class play.libs.Scala
- cleanupEvolutions(Database) - Static method in class play.db.evolutions.Evolutions
-
Cleanup evolutions for the given database.
- cleanupEvolutions(Database, boolean) - Static method in class play.db.evolutions.Evolutions
-
Cleanup evolutions for the given database.
- cleanupEvolutions(Database, boolean, String) - Static method in class play.db.evolutions.Evolutions
-
Cleanup evolutions for the given database.
- cleanupEvolutions(Database, boolean, String, String) - Static method in class play.db.evolutions.Evolutions
-
Cleanup evolutions for the given database.
- cleanupEvolutions(Database, boolean, String, String, Map<String, String>, String, String, boolean) - Static method in class play.db.evolutions.Evolutions
-
Cleanup evolutions for the given database.
- cleanupEvolutions(Database, String) - Static method in class play.db.evolutions.Evolutions
-
Cleanup evolutions for the given database.
- cleanupEvolutions(Database, String, String) - Static method in class play.db.evolutions.Evolutions
-
Cleanup evolutions for the given database.
- cleanupEvolutions(Database, String, String, Map<String, String>, String, String, boolean) - Static method in class play.db.evolutions.Evolutions
-
Cleanup evolutions for the given database.
- clearLang(Result) - Method in class play.i18n.MessagesApi
-
Given a Result, return a new Result with the lang cookie discarded.
- clientCertificateChain() - Method in class play.mvc.Http.RequestBuilder
- clientCertificateChain() - Method in interface play.mvc.Http.RequestHeader
-
The X509 certificate chain presented by a client during SSL requests.
- clientCertificateChain(List<X509Certificate>) - Method in class play.mvc.Http.RequestBuilder
- ClientCookieDecoder - Class in play.core.cookie.encoding
-
A RFC6265 compliant cookie decoder to be used client side.
- ClientCookieEncoder - Class in play.core.cookie.encoding
-
A RFC6265 compliant cookie encoder to be used client side, so only name=value pairs are sent.
- clock() - Method in interface play.components.CryptoComponents
- clone() - Method in class play.libs.Time.CronExpression
- close() - Method in class play.libs.ws.ahc.AhcWSClient
- close() - Method in interface play.libs.ws.WSClient
-
Closes this client, and releases underlying resources.
- close(DataSource) - Method in interface play.db.ConnectionPool
-
Close the given data source.
- close(DataSource) - Method in class play.db.DefaultConnectionPool
- Close(int) - Constructor for class play.http.websocket.Message.Close
- Close(int, String) - Constructor for class play.http.websocket.Message.Close
- Close(Optional<Integer>, String) - Constructor for class play.http.websocket.Message.Close
- clusterSharding() - Method in interface play.cluster.sharding.typed.ClusterShardingComponents
- ClusterShardingComponents - Interface in play.cluster.sharding.typed
- code() - Method in class play.http.websocket.Message.Close
- code() - Method in class play.i18n.Lang
-
The language tag (such as fr or en-US).
- Comet - Class in play.libs
-
Provides an easy way to use a Comet formatted output with Pekko Streams.
- Comet() - Constructor for class play.libs.Comet
- comments() - Method in class play.routing.HandlerDef
- compareSignedTokens(String, String) - Method in interface play.libs.crypto.CSRFTokenSigner
-
Compare two signed tokens.
- compareSignedTokens(String, String) - Method in class play.libs.crypto.DefaultCSRFTokenSigner
- compareTo(Cookie) - Method in class play.core.cookie.encoding.DefaultCookie
- CompletableBodyParser(CompletionStage<BodyParser<A>>, Materializer) - Constructor for class play.mvc.BodyParser.CompletableBodyParser
- config() - Method in interface play.Application
-
Get the application configuration.
- config() - Method in interface play.components.ConfigurationComponents
- config() - Method in class play.ContextBasedBuiltInComponents
- config() - Method in class play.DefaultApplication
-
Get the application configuration.
- configuration - Variable in class play.mvc.Action
-
The action configuration - typically the annotation used to decorate the action method.
- configuration() - Method in interface play.components.ConfigurationComponents
- ConfigurationComponents - Interface in play.components
-
Provides configuration components.
- configure(Config) - Method in class play.inject.guice.GuiceBuilder
-
Add additional configuration.
- configure(String, Object) - Method in class play.inject.guice.GuiceBuilder
-
Add additional configuration.
- configure(Map<String, Object>) - Method in class play.inject.guice.GuiceBuilder
-
Add additional configuration.
- configure(Map<String, String>, Optional<URL>) - Method in interface play.LoggerConfigurator
-
Configures the logger with a list of properties and an optional URL.
- configure(Environment) - Method in interface play.LoggerConfigurator
- configure(Environment, Configuration, Map<String, String>) - Method in interface play.LoggerConfigurator
- configure(Environment) - Method in interface play.LoggerConfigurator
-
This is a convenience method that adds no extra properties.
- configure(Environment, Config) - Method in interface play.LoggerConfigurator
-
Configures the logger with the environment and the application configuration.
- configure(Environment, Config, Map<String, String>) - Method in interface play.LoggerConfigurator
-
Configures the logger with the environment, the application configuration and additional properties.
- configure(Map<String, String>, Option<URL>) - Method in interface play.LoggerConfigurator
- CONFLICT - Static variable in interface play.mvc.Http.Status
- CONNECTION - Static variable in interface play.mvc.Http.HeaderNames
- ConnectionCallable<A> - Interface in play.db
-
Similar to java.util.concurrent.Callable with a Connection as argument.
- connectionPool() - Method in interface play.db.ConnectionPoolComponents
- connectionPool() - Method in interface play.db.HikariCPComponents
- ConnectionPool - Interface in play.db
-
Connection pool API for managing data sources.
- ConnectionPoolComponents - Interface in play.db
-
A base for Java connection pool components.
- ConnectionRunnable - Interface in play.db
-
Similar to java.lang.Runnable with a Connection as argument.
- Constants() - Constructor for class play.libs.XML.Constants
- constraints() - Method in class play.data.Form.Field
-
Returns all the constraints associated with this field.
- Constraints - Class in play.data.validation
-
Defines a set of built-in validation constraints.
- Constraints() - Constructor for class play.data.validation.Constraints
- Constraints.Email - Annotation Type in play.data.validation
-
Defines a email constraint for a string field.
- Constraints.Email.List - Annotation Type in play.data.validation
-
Defines several
@Email
annotations on the same element. - Constraints.EmailValidator - Class in play.data.validation
-
Validator for
@Email
fields. - Constraints.Max - Annotation Type in play.data.validation
-
Defines a maximum value for a numeric field.
- Constraints.Max.List - Annotation Type in play.data.validation
-
Defines several
@Max
annotations on the same element. - Constraints.MaxLength - Annotation Type in play.data.validation
-
Defines a maximum length for a string field.
- Constraints.MaxLength.List - Annotation Type in play.data.validation
-
Defines several
@MaxLength
annotations on the same element. - Constraints.MaxLengthValidator - Class in play.data.validation
-
Validator for
@MaxLength
fields. - Constraints.MaxValidator - Class in play.data.validation
-
Validator for
@Max
fields. - Constraints.Min - Annotation Type in play.data.validation
-
Defines a minimum value for a numeric field.
- Constraints.Min.List - Annotation Type in play.data.validation
-
Defines several
@Min
annotations on the same element. - Constraints.MinLength - Annotation Type in play.data.validation
-
Defines a minimum length for a string field.
- Constraints.MinLength.List - Annotation Type in play.data.validation
-
Defines several
@MinLength
annotations on the same element. - Constraints.MinLengthValidator - Class in play.data.validation
-
Validator for
@MinLength
fields. - Constraints.MinValidator - Class in play.data.validation
-
Validator for
@Min
fields. - Constraints.Pattern - Annotation Type in play.data.validation
-
Defines a pattern constraint for a string field.
- Constraints.Pattern.List - Annotation Type in play.data.validation
-
Defines several
@Pattern
annotations on the same element. - Constraints.PatternValidator - Class in play.data.validation
-
Validator for
@Pattern
fields. - Constraints.PlayConstraintValidator<A extends Annotation,T> - Interface in play.data.validation
- Constraints.PlayConstraintValidatorWithPayload<A extends Annotation,T> - Interface in play.data.validation
- Constraints.Required - Annotation Type in play.data.validation
-
Defines a field as required.
- Constraints.Required.List - Annotation Type in play.data.validation
-
Defines several
@Required
annotations on the same element. - Constraints.RequiredValidator - Class in play.data.validation
-
Validator for
@Required
fields. - Constraints.Validatable<T> - Interface in play.data.validation
- Constraints.ValidatableWithPayload<T> - Interface in play.data.validation
- Constraints.Validate - Annotation Type in play.data.validation
- Constraints.Validate.List - Annotation Type in play.data.validation
-
Defines several
@Validate
annotations on the same element. - Constraints.ValidatePayloadWith - Annotation Type in play.data.validation
-
Defines a custom validator.
- Constraints.ValidatePayloadWith.List - Annotation Type in play.data.validation
-
Defines several
@ValidatePayloadWith
annotations on the same element. - Constraints.ValidatePayloadWithValidator - Class in play.data.validation
-
Validator for
@ValidatePayloadWith
fields. - Constraints.ValidateValidator - Class in play.data.validation
- Constraints.ValidateValidatorWithPayload - Class in play.data.validation
- Constraints.ValidateWith - Annotation Type in play.data.validation
-
Defines a custom validator.
- Constraints.ValidateWith.List - Annotation Type in play.data.validation
-
Defines several
@ValidateWith
annotations on the same element. - Constraints.ValidateWithPayload - Annotation Type in play.data.validation
- Constraints.ValidateWithPayload.List - Annotation Type in play.data.validation
-
Defines several
@ValidateWithPayload
annotations on the same element. - Constraints.ValidateWithValidator - Class in play.data.validation
-
Validator for
@ValidateWith
fields. - Constraints.ValidationPayload - Class in play.data.validation
- Constraints.Validator<T> - Class in play.data.validation
-
Super-type for validators.
- Constraints.ValidatorWithPayload<T> - Class in play.data.validation
-
Super-type for validators with a payload.
- constraintValidatorFactory() - Method in interface play.data.validation.ValidatorsComponents
- ConstructionTarget<T> - Class in play.inject
-
A binding target that is provided by a class.
- ConstructionTarget(Class<? extends T>) - Constructor for class play.inject.ConstructionTarget
- ConstructionTarget(ConstructionTarget<T>) - Constructor for class play.inject.ConstructionTarget
- ConstructorUtils - Class in play.libs.reflect
-
Imported from apache.commons.lang3 3.6
- ConstructorUtils() - Constructor for class play.libs.reflect.ConstructorUtils
- consumeData(Materializer) - Method in class play.http.HttpEntity
-
Consumes the data.
- contains(String) - Method in class play.mvc.Http.Headers
-
Checks if the given header is present.
- containsKey(TypedKey<?>) - Method in class play.libs.typedmap.TypedMap
-
Check if the map contains a value with the given key.
- CONTENT_DISPOSITION - Static variable in interface play.mvc.Http.HeaderNames
- CONTENT_ENCODING - Static variable in interface play.mvc.Http.HeaderNames
- CONTENT_LANGUAGE - Static variable in interface play.mvc.Http.HeaderNames
- CONTENT_LENGTH - Static variable in interface play.mvc.Http.HeaderNames
- CONTENT_LOCATION - Static variable in interface play.mvc.Http.HeaderNames
- CONTENT_MD5 - Static variable in interface play.mvc.Http.HeaderNames
- CONTENT_RANGE - Static variable in interface play.mvc.Http.HeaderNames
- CONTENT_SECURITY_POLICY - Static variable in interface play.mvc.Http.HeaderNames
- CONTENT_SECURITY_POLICY_REPORT_ONLY - Static variable in interface play.mvc.Http.HeaderNames
- CONTENT_TRANSFER_ENCODING - Static variable in interface play.mvc.Http.HeaderNames
- CONTENT_TYPE - Static variable in interface play.mvc.Http.HeaderNames
- contentAsBytes(Result) - Static method in class play.test.Helpers
-
Extracts the content as a
ByteString
. - contentAsBytes(Result, Materializer) - Static method in class play.test.Helpers
-
Extracts the content as a
ByteString
. - contentAsBytes(Result, Materializer, long) - Static method in class play.test.Helpers
-
Extracts the content as a
ByteString
. - contentAsBytes(Content) - Static method in class play.test.Helpers
-
Extracts the content as bytes.
- contentAsString(Result) - Static method in class play.test.Helpers
-
Extracts the content as a String.
- contentAsString(Result, Materializer) - Static method in class play.test.Helpers
-
Extracts the content as a String.
- contentAsString(Result, Materializer, long) - Static method in class play.test.Helpers
-
Extracts the content as a String.
- contentAsString(Content) - Static method in class play.test.Helpers
-
Extracts the content as a String.
- contentDispositionHeader(boolean, Optional<String>) - Static method in class play.mvc.Results
-
Creates a
Content-Disposition
header.
According to RFC 6266 (Section 4.2) there is no need to send the header"Content-Disposition: inline"
. - contentLength() - Method in class play.http.HttpEntity.Chunked
- contentLength() - Method in class play.http.HttpEntity
- contentLength() - Method in class play.http.HttpEntity.Streamed
- contentLength() - Method in class play.http.HttpEntity.Strict
- contentType() - Method in class play.http.HttpEntity.Chunked
- contentType() - Method in class play.http.HttpEntity
- contentType() - Method in class play.http.HttpEntity.Streamed
- contentType() - Method in class play.http.HttpEntity.Strict
- contentType() - Method in class play.libs.Jsonp
- contentType() - Method in interface play.mvc.Http.RequestHeader
- contentType() - Method in class play.mvc.Result
-
Extracts the Content-Type of this Result value.
- context() - Method in class play.BuiltInComponentsFromContext
- context() - Method in class play.ContextBasedBuiltInComponents
-
Returns the application loader context.
- context() - Method in interface play.libs.pekko.InjectedActorSupport
-
Context method expected to be implemented by
AbstractActor
. - Context(ApplicationLoader.Context) - Constructor for class play.ApplicationLoader.Context
-
The context for loading an application.
- Context(Environment) - Constructor for class play.ApplicationLoader.Context
-
The context for loading an application.
- Context(Environment, Map<String, Object>) - Constructor for class play.ApplicationLoader.Context
-
The context for loading an application.
- ContextBasedBuiltInComponents - Class in play
-
This helper class provides all the built-in component dependencies by trading them for a single dependency - the application loader context.
- ContextBasedBuiltInComponents() - Constructor for class play.ContextBasedBuiltInComponents
- contextComponents() - Method in class play.core.j.MappedJavaHandlerComponents
-
Deprecated.
- contextComponents() - Static method in class play.test.Helpers
-
Deprecated.Deprecated as of 2.8.0. Inject MessagesApi, Langs, FileMimeTypes or HttpConfiguration instead
- CONTINUE - Static variable in interface play.mvc.Http.Status
- controller() - Method in class play.routing.HandlerDef
- Controller - Class in play.mvc
-
Superclass for a Java-based controller.
- Controller() - Constructor for class play.mvc.Controller
- conversion - Variable in class play.data.format.Formatters
-
The underlying conversion service.
- cookie(String) - Method in interface play.mvc.Http.RequestHeader
- cookie(String) - Method in class play.mvc.Result
-
Extracts a Cookie value from this Result value
- cookie(Http.Cookie) - Method in class play.mvc.Http.RequestBuilder
-
Sets one cookie.
- Cookie - Interface in play.core.cookie.encoding
-
An interface defining an HTTP cookie.
- Cookie(String, String, Integer, String, String, boolean, boolean, Http.Cookie.SameSite) - Constructor for class play.mvc.Http.Cookie
-
Construct a new cookie.
- COOKIE - Static variable in interface play.mvc.Http.HeaderNames
- cookies() - Method in class play.mvc.Http.RequestBuilder
- cookies() - Method in interface play.mvc.Http.RequestHeader
- cookies() - Method in class play.mvc.Result
-
Extracts the Cookies (an iterator) from this result value.
- cookieSigner() - Method in interface play.components.CryptoComponents
- cookieSigner() - Method in class play.ContextBasedBuiltInComponents
- CookieSigner - Interface in play.libs.crypto
-
Authenticates a cookie by returning a message authentication code (MAC).
- coordinatedShutdown() - Method in interface play.components.PekkoComponents
- coordinatedShutdown() - Method in class play.ContextBasedBuiltInComponents
- copyTo(File) - Method in interface play.libs.Files.TemporaryFile
-
Copy the temporary file to the specified destination.
- copyTo(File, boolean) - Method in interface play.libs.Files.TemporaryFile
-
Copy the file to the specified destination and, if the destination exists, decide if replace it based on the
replace
parameter. - copyTo(Path) - Method in interface play.libs.Files.TemporaryFile
-
Copy the file to the specified path destination.
- copyTo(Path, boolean) - Method in class play.libs.Files.DelegateTemporaryFile
- copyTo(Path, boolean) - Method in interface play.libs.Files.TemporaryFile
-
Copy the file to the specified path destination and, if the destination exists, decide if replace it based on the
replace
parameter. - CORSComponents - Interface in play.filters.components
-
Java Components for the CORS Filter.
- corsConfig() - Method in interface play.filters.components.CORSComponents
- corsFilter() - Method in interface play.filters.components.CORSComponents
- corsPathPrefixes() - Method in interface play.filters.components.CORSComponents
- country() - Method in class play.i18n.Lang
-
A valid ISO Country Code.
- create() - Static method in class play.libs.typedmap.TypedKey
-
Creates a TypedKey without a name.
- create(String) - Static method in class play.libs.typedmap.TypedKey
-
Creates a TypedKey with the given name.
- create(String, Config, Environment) - Method in interface play.db.ConnectionPool
-
Create a data source with the given configuration.
- create(String, Config, Environment) - Method in class play.db.DefaultConnectionPool
- create(String, String) - Method in class play.libs.Files.DelegateTemporaryFileCreator
- create(String, String) - Method in class play.libs.Files.SingletonTemporaryFileCreator
- create(String, String) - Method in interface play.libs.Files.TemporaryFileCreator
- create(String, String, String, JavaScriptReverseRoute...) - Static method in class play.routing.JavaScriptReverseRouter
-
Generates a JavaScript reverse router.
- create(Path) - Method in class play.libs.Files.DelegateTemporaryFileCreator
- create(Path) - Method in class play.libs.Files.SingletonTemporaryFileCreator
- create(Path) - Method in interface play.libs.Files.TemporaryFileCreator
- create(AhcWSClientConfig, AhcHttpCache, Materializer) - Static method in class play.libs.ws.ahc.AhcWSClient
-
Creates WS client manually from configuration, internally creating a new instance of AsyncHttpClient and managing its own thread pool.
- create(Environment) - Static method in interface play.ApplicationLoader
-
Create an application loading context.
- create(Environment, Map<String, Object>) - Static method in interface play.ApplicationLoader
-
Create an application loading context.
- create(TypedEntry<?>) - Static method in class play.libs.typedmap.TypedMap
- create(TypedEntry<?>...) - Static method in class play.libs.typedmap.TypedMap
- create(TypedEntry<?>, TypedEntry<?>) - Static method in class play.libs.typedmap.TypedMap
- create(TypedEntry<?>, TypedEntry<?>, TypedEntry<?>) - Static method in class play.libs.typedmap.TypedMap
- createAction(Http.Request, Method) - Method in interface play.http.ActionCreator
-
Call to create the root Action for a Java controller method call.
- createAction(Http.Request, Method) - Method in class play.http.DefaultActionCreator
- createBrowser() - Method in class play.test.WithBrowser
- created() - Static method in class play.mvc.Results
-
Generates a 201 Created result.
- created(byte[]) - Static method in class play.mvc.Results
-
Generates a 201 Created result.
- created(JsonNode) - Static method in class play.mvc.Results
-
Generates a 201 Created result.
- created(JsonNode, JsonEncoding) - Static method in class play.mvc.Results
-
Generates a 201 Created result.
- created(File) - Static method in class play.mvc.Results
-
Generates a 201 Created result.
- created(File, boolean) - Static method in class play.mvc.Results
-
Generates a 201 Created result.
- created(File, boolean, Optional<String>) - Static method in class play.mvc.Results
-
Generates a 201 Created result.
- created(File, boolean, Optional<String>, FileMimeTypes) - Static method in class play.mvc.Results
-
Generates a 201 Created result.
- created(File, boolean, FileMimeTypes) - Static method in class play.mvc.Results
-
Generates a 201 Created result.
- created(File, String) - Static method in class play.mvc.Results
-
Deprecated.Deprecated as of 2.8.0. Use to
Results.created(File, Optional)
. - created(File, String, FileMimeTypes) - Static method in class play.mvc.Results
-
Deprecated.Deprecated as of 2.8.0. Use to
Results.created(File, Optional, FileMimeTypes)
. - created(File, Optional<String>) - Static method in class play.mvc.Results
-
Generates a 201 Created result.
- created(File, Optional<String>, FileMimeTypes) - Static method in class play.mvc.Results
-
Generates a 201 Created result.
- created(File, FileMimeTypes) - Static method in class play.mvc.Results
-
Generates a 201 Created result.
- created(InputStream) - Static method in class play.mvc.Results
-
Generates a 201 Created result.
- created(InputStream, long) - Static method in class play.mvc.Results
-
Generates a 201 Created result.
- created(String) - Static method in class play.mvc.Results
-
Generates a 201 Created result.
- created(String, String) - Static method in class play.mvc.Results
-
Generates a 201 Created result.
- created(Path) - Static method in class play.mvc.Results
-
Generates a 201 Created result.
- created(Path, boolean) - Static method in class play.mvc.Results
-
Generates a 201 Created result.
- created(Path, boolean, Optional<String>) - Static method in class play.mvc.Results
-
Generates a 201 Created result.
- created(Path, boolean, Optional<String>, FileMimeTypes) - Static method in class play.mvc.Results
-
Generates a 201 Created result.
- created(Path, boolean, FileMimeTypes) - Static method in class play.mvc.Results
-
Generates a 201 Created result.
- created(Path, Optional<String>) - Static method in class play.mvc.Results
-
Generates a 201 Created result.
- created(Path, Optional<String>, FileMimeTypes) - Static method in class play.mvc.Results
-
Generates a 201 Created result.
- created(Path, FileMimeTypes) - Static method in class play.mvc.Results
-
Generates a 201 Created result.
- created(Content) - Static method in class play.mvc.Results
-
Generates a 201 Created result.
- created(Content, String) - Static method in class play.mvc.Results
-
Generates a 201 Created result.
- CREATED - Static variable in interface play.mvc.Http.Status
- createFilePartHandler() - Method in class play.mvc.BodyParser.DelegatingMultipartFormDataBodyParser
-
Returns a FilePartHandler expressed as a Java function.
- createFrom(String, String) - Static method in class play.db.Databases
-
Create a pooled database named "default" with the given driver and url.
- createFrom(String, String, String) - Static method in class play.db.Databases
-
Create a pooled database with the given configuration.
- createFrom(String, String, String, Map<String, ? extends Object>) - Static method in class play.db.Databases
-
Create a pooled database with the given configuration.
- createFrom(String, String, Map<String, ? extends Object>) - Static method in class play.db.Databases
-
Create a pooled database named "default" with the given configuration.
- createSSLEngine() - Method in interface play.server.SSLEngineProvider
- CronExpression(String) - Constructor for class play.libs.Time.CronExpression
-
Constructs a new
CronExpression
based on the specified parameter. - cronInterval(String) - Static method in class play.libs.Time
-
Computes the number of milliseconds between the next valid date and the one after.
- cronInterval(String, Date) - Static method in class play.libs.Time
-
Compute the number of milliseconds between the next valid date and the one after.
- CryptoComponents - Interface in play.components
- CSP - Annotation Type in play.filters.csp
-
This annotation runs the play.filters.csp.CSPAction on a controller method.
- cspAction() - Method in interface play.filters.components.CSPComponents
- CSPAction - Class in play.filters.csp
-
This action is used to add a CSP header to the response through injection.
- CSPAction(CSPProcessor) - Constructor for class play.filters.csp.CSPAction
- CSPComponents - Interface in play.filters.components
-
The Java CSP components.
- cspConfig() - Method in interface play.filters.components.CSPComponents
- cspFilter() - Method in interface play.filters.components.CSPComponents
- cspProcessor() - Method in interface play.filters.components.CSPComponents
- cspReportAction() - Method in interface play.filters.components.CSPReportComponents
- cspReportBodyParser() - Method in interface play.filters.components.CSPReportComponents
- CSPReportComponents - Interface in play.filters.components
-
Components for reporting CSP violations.
- cspResultProcessor() - Method in interface play.filters.components.CSPComponents
- csrfAddToken() - Method in interface play.filters.components.CSRFComponents
- csrfCheck() - Method in interface play.filters.components.CSRFComponents
- CSRFComponents - Interface in play.filters.components
-
The Java CSRF components.
- csrfConfig() - Method in interface play.filters.components.CSRFComponents
- csrfErrorHandler() - Method in interface play.filters.components.CSRFComponents
- CSRFErrorHandler - Interface in play.filters.csrf
-
This interface handles the CSRF error.
- CSRFErrorHandler.DefaultCSRFErrorHandler - Class in play.filters.csrf
- csrfFilter() - Method in interface play.filters.components.CSRFComponents
- csrfTokenProvider() - Method in interface play.filters.components.CSRFComponents
- csrfTokenSigner() - Method in interface play.components.CryptoComponents
- csrfTokenSigner() - Method in class play.ContextBasedBuiltInComponents
- CSRFTokenSigner - Interface in play.libs.crypto
-
Cryptographic utilities for generating and validating CSRF tokens.
- CSS - Static variable in interface play.mvc.Http.MimeTypes
-
Content-Type of css.
- current() - Method in class play.libs.concurrent.ClassLoaderExecutionContext
-
Get the current executor associated with the current ClassLoader.
- current() - Method in class play.libs.concurrent.CustomExecutionContext
-
Get this executor associated with the current ClassLoader.
- current() - Method in class play.libs.concurrent.HttpExecutionContext
-
Deprecated.Deprecated as of 2.9.0. Use to
ClassLoaderExecutionContext.current()
} instead. - CurrentLang - Static variable in class play.i18n.Messages.Attrs
- CustomExecutionContext - Class in play.libs.concurrent
-
Provides a custom execution context from an Pekko dispatcher.
- CustomExecutionContext(ActorSystem, String) - Constructor for class play.libs.concurrent.CustomExecutionContext
D
- data() - Method in class play.http.HttpEntity.Streamed
- data() - Method in class play.http.HttpEntity.Strict
- data() - Method in class play.http.websocket.Message.Binary
- data() - Method in class play.http.websocket.Message.Ping
- data() - Method in class play.http.websocket.Message.Pong
- data() - Method in class play.http.websocket.Message.Text
- data() - Method in class play.mvc.Http.Flash
- data() - Method in class play.mvc.Http.Session
- database(String) - Method in interface play.db.DBComponents
- Database - Interface in play.db
-
Database API for managing data sources and connections.
- databases() - Method in interface play.db.DBComponents
- Databases - Class in play.db
-
Creation helpers for manually instantiating databases.
- DataPart(String, String) - Constructor for class play.mvc.Http.MultipartFormData.DataPart
- dataStream() - Method in class play.http.HttpEntity.Chunked
- dataStream() - Method in class play.http.HttpEntity
- dataStream() - Method in class play.http.HttpEntity.Streamed
- dataStream() - Method in class play.http.HttpEntity.Strict
- DATE - Static variable in interface play.mvc.Http.HeaderNames
- DateFormatter(MessagesApi) - Constructor for class play.data.format.Formats.DateFormatter
-
Creates a date formatter.
- DateFormatter(MessagesApi, String) - Constructor for class play.data.format.Formats.DateFormatter
-
Creates a date formatter.
- DateFormatter(MessagesApi, String, String) - Constructor for class play.data.format.Formats.DateFormatter
-
Creates a date formatter.
- DAY_OF_MONTH - Static variable in class play.libs.Time.CronExpression
- DAY_OF_WEEK - Static variable in class play.libs.Time.CronExpression
- dayMap - Static variable in class play.libs.Time.CronExpression
- daysOfMonth - Variable in class play.libs.Time.CronExpression
- daysOfWeek - Variable in class play.libs.Time.CronExpression
- dbApi() - Method in interface play.db.DBComponents
- DBApi - Interface in play.db
-
DB API for managing application databases.
- DBComponents - Interface in play.db
-
Java DB components.
- DBModule - Class in play.db
-
Injection module with default DB components.
- DBModule() - Constructor for class play.db.DBModule
- DBModule.NamedDatabaseProvider - Class in play.db
-
Inject provider for named databases.
- debug(String) - Method in class play.Logger.ALogger
-
Logs a message with the DEBUG level.
- debug(String) - Static method in class play.Logger
-
Deprecated.Deprecated as of 2.7.0. Create an instance of
Logger.ALogger
viaLogger.of(String)
/Logger.of(Class)
and use the same-named method. Or use SLF4J directly. - debug(String, Object...) - Method in class play.Logger.ALogger
-
Logs a message with the DEBUG level.
- debug(String, Object...) - Static method in class play.Logger
-
Deprecated.Deprecated as of 2.7.0. Create an instance of
Logger.ALogger
viaLogger.of(String)
/Logger.of(Class)
and use the same-named method. Or use SLF4J directly. - debug(String, Throwable) - Method in class play.Logger.ALogger
-
Logs a message with the DEBUG level, with the given error.
- debug(String, Throwable) - Static method in class play.Logger
-
Deprecated.Deprecated as of 2.7.0. Create an instance of
Logger.ALogger
viaLogger.of(String)
/Logger.of(Class)
and use the same-named method. Or use SLF4J directly. - debug(String, Supplier<?>...) - Method in class play.Logger.ALogger
-
Log a message with the DEBUG level.
- debug(String, Supplier<?>...) - Static method in class play.Logger
-
Deprecated.Deprecated as of 2.7.0. Create an instance of
Logger.ALogger
viaLogger.of(String)
/Logger.of(Class)
and use the same-named method. Or use SLF4J directly. - debug(Supplier<String>) - Method in class play.Logger.ALogger
-
Log a message with the DEBUG level.
- debug(Supplier<String>) - Static method in class play.Logger
-
Deprecated.Deprecated as of 2.7.0. Create an instance of
Logger.ALogger
viaLogger.of(String)
/Logger.of(Class)
and use the same-named method. Or use SLF4J directly. - debug(Marker, String) - Method in class play.Logger.ALogger
-
Logs a message with the DEBUG level.
- debug(Marker, String, Object...) - Method in class play.Logger.ALogger
-
Logs a message with the DEBUG level.
- debug(Marker, String, Throwable) - Method in class play.Logger.ALogger
-
Logs a message with the DEBUG level, with the given error.
- decode(String) - Method in class play.core.cookie.encoding.ClientCookieDecoder
-
Decodes the specified Set-Cookie HTTP header value into a
Cookie
. - decode(String) - Method in class play.core.cookie.encoding.ServerCookieDecoder
-
Decodes the specified Set-Cookie HTTP header value into a
Cookie
. - Default(HttpErrorHandler, HttpConfiguration, PlayBodyParsers) - Constructor for class play.mvc.BodyParser.Default
- DEFAULT_INSTANCE - Static variable in class play.inject.SourceProvider
- DEFAULT_TIMEOUT - Static variable in class play.test.Helpers
-
Default Timeout (milliseconds) for fake requests issued by these Helpers.
- DefaultActionCreator - Class in play.http
-
A default implementation of the action creator.
- DefaultActionCreator() - Constructor for class play.http.DefaultActionCreator
- DefaultApplication - Class in play
-
Default implementation of a Play Application.
- DefaultApplication(Application, Config, Injector) - Constructor for class play.DefaultApplication
-
Deprecated.
- DefaultApplication(Application, Config, Injector, Environment) - Constructor for class play.DefaultApplication
-
Create an application that wraps a Scala application.
- DefaultApplication(Application, Injector) - Constructor for class play.DefaultApplication
-
Create an application that wraps a Scala application.
- DefaultAsyncCacheApi - Class in play.cache
-
Adapts a Scala AsyncCacheApi to a Java AsyncCacheApi.
- DefaultAsyncCacheApi(AsyncCacheApi) - Constructor for class play.cache.DefaultAsyncCacheApi
- defaultBodyParser() - Method in interface play.components.BodyParserComponents
- defaultCacheApi() - Method in interface play.cache.caffeine.CaffeineCacheComponents
- defaultCacheApi() - Method in interface play.cache.ehcache.EhCacheComponents
- DefaultConnectionPool - Class in play.db
-
Default delegating implementation of the connection pool API.
- DefaultConnectionPool(ConnectionPool) - Constructor for class play.db.DefaultConnectionPool
- DefaultConstraintValidatorFactory - Class in play.data.validation
-
Creates validator instances with injections available.
- DefaultConstraintValidatorFactory(Injector) - Constructor for class play.data.validation.DefaultConstraintValidatorFactory
- DefaultCookie - Class in play.core.cookie.encoding
-
The default
Cookie
implementation. - DefaultCookie(String, String) - Constructor for class play.core.cookie.encoding.DefaultCookie
-
Creates a new cookie with the specified name and value.
- DefaultCookieSigner - Class in play.libs.crypto
-
This class delegates to the Scala CookieSigner.
- DefaultCookieSigner(CookieSigner) - Constructor for class play.libs.crypto.DefaultCookieSigner
- DefaultCSRFErrorHandler(CSRF.CSRFHttpErrorHandler) - Constructor for class play.filters.csrf.CSRFErrorHandler.DefaultCSRFErrorHandler
- DefaultCSRFTokenSigner - Class in play.libs.crypto
-
Cryptographic utilities for generating and validating CSRF tokens.
- DefaultCSRFTokenSigner(CSRFTokenSigner) - Constructor for class play.libs.crypto.DefaultCSRFTokenSigner
- DefaultDatabase - Class in play.db
-
Default delegating implementation of the database API.
- DefaultDatabase(String, Config) - Constructor for class play.db.DefaultDatabase
-
Create a default HikariCP-backed database.
- DefaultDatabase(String, Map<String, ? extends Object>) - Constructor for class play.db.DefaultDatabase
-
Create a default HikariCP-backed database.
- DefaultDatabase(Database) - Constructor for class play.db.DefaultDatabase
- DefaultDBApi - Class in play.db
-
Default delegating implementation of the DB API.
- DefaultDBApi(DBApi) - Constructor for class play.db.DefaultDBApi
- DefaultFutures - Class in play.libs.concurrent
-
The default implementation of the Futures trait.
- DefaultFutures(Futures) - Constructor for class play.libs.concurrent.DefaultFutures
- DefaultHttpErrorHandler - Class in play.http
-
Default implementation of the http error handler.
- DefaultHttpErrorHandler(Config, Environment, OptionalSourceMapper, Provider<Router>) - Constructor for class play.http.DefaultHttpErrorHandler
- DefaultHttpFilters - Class in play.http
-
Helper class which has a varargs constructor taking the filters.
- DefaultHttpFilters(List<? extends EssentialFilter>) - Constructor for class play.http.DefaultHttpFilters
- DefaultHttpFilters(EssentialFilter...) - Constructor for class play.http.DefaultHttpFilters
- DefaultHttpRequestHandler - Class in play.http
- DefaultHttpRequestHandler(JavaCompatibleHttpRequestHandler) - Constructor for class play.http.DefaultHttpRequestHandler
- DefaultJPAApi - Class in play.db.jpa
-
Default implementation of the JPA API.
- DefaultJPAApi(JPAConfig) - Constructor for class play.db.jpa.DefaultJPAApi
- DefaultJPAApi.JPAApiProvider - Class in play.db.jpa
- DefaultJPAConfig - Class in play.db.jpa
-
Default JPA configuration.
- DefaultJPAConfig(Set<JPAConfig.PersistenceUnit>) - Constructor for class play.db.jpa.DefaultJPAConfig
- DefaultJPAConfig(JPAConfig.PersistenceUnit...) - Constructor for class play.db.jpa.DefaultJPAConfig
- DefaultJPAConfig.JPAConfigProvider - Class in play.db.jpa
- defaultLang() - Static method in class play.i18n.Lang
-
The default Lang (platform default).
- defaultMessage - Static variable in class play.data.validation.Constraints.ValidatePayloadWithValidator
- defaultMessage - Static variable in class play.data.validation.Constraints.ValidateWithValidator
- DefaultOpenIdClient - Class in play.libs.openid
- DefaultOpenIdClient(OpenIdClient, ExecutionContext) - Constructor for class play.libs.openid.DefaultOpenIdClient
- defaultScalaBodyParser() - Method in interface play.components.BodyParserComponents
- DefaultSyncCacheApi - Class in play.cache
-
An implementation of SyncCacheApi that wraps AsyncCacheApi
- DefaultSyncCacheApi(AsyncCacheApi) - Constructor for class play.cache.DefaultSyncCacheApi
- delay(long, TimeUnit) - Method in class play.libs.concurrent.DefaultFutures
- delay(long, TimeUnit) - Method in interface play.libs.concurrent.Futures
-
Creates a completion stage which is only completed after the delay.
- delay(Duration) - Method in class play.libs.concurrent.DefaultFutures
- delay(Duration) - Method in interface play.libs.concurrent.Futures
-
Creates a completion stage which is only completed after the delay.
- delayed(Callable<CompletionStage<A>>, long, TimeUnit) - Method in class play.libs.concurrent.DefaultFutures
-
Create a CompletionStage which, after a delay, will be redeemed with the result of a given supplier.
- delayed(Callable<CompletionStage<A>>, long, TimeUnit) - Method in interface play.libs.concurrent.Futures
-
Create a
CompletionStage
which, after a delay, will be redeemed with the result of a given callable. - delayed(Callable<CompletionStage<A>>, Duration) - Method in class play.libs.concurrent.DefaultFutures
-
Create a CompletionStage which, after a delay, will be redeemed with the result of a given supplier.
- delayed(Callable<CompletionStage<A>>, Duration) - Method in interface play.libs.concurrent.Futures
-
Create a
CompletionStage
which, after a delay, will be redeemed with the result of a given supplier. - delegate - Variable in class play.inject.guice.GuiceBuilder
- delegate - Variable in class play.mvc.Action
-
The wrapped action.
- DelegateApplicationLifecycle - Class in play.inject
- DelegateApplicationLifecycle(ApplicationLifecycle) - Constructor for class play.inject.DelegateApplicationLifecycle
- DelegateInjector - Class in play.inject
- DelegateInjector(Injector) - Constructor for class play.inject.DelegateInjector
- DelegateTemporaryFile(Files.TemporaryFile) - Constructor for class play.libs.Files.DelegateTemporaryFile
- DelegateTemporaryFileCreator(Files.TemporaryFileCreator) - Constructor for class play.libs.Files.DelegateTemporaryFileCreator
- DelegatingBodyParser(BodyParser<B>, Function<B, A>) - Constructor for class play.mvc.BodyParser.DelegatingBodyParser
- DelegatingMultipartFormDataBodyParser(Materializer, long, long, boolean, HttpErrorHandler) - Constructor for class play.mvc.BodyParser.DelegatingMultipartFormDataBodyParser
- DelegatingMultipartFormDataBodyParser(Materializer, long, long, HttpErrorHandler) - Constructor for class play.mvc.BodyParser.DelegatingMultipartFormDataBodyParser
-
Deprecated.Deprecated as of 2.9.0. Use
DelegatingMultipartFormDataBodyParser(Materializer, long, long, boolean, HttpErrorHandler)
instead. - DelegatingMultipartFormDataBodyParser(Materializer, long, HttpErrorHandler) - Constructor for class play.mvc.BodyParser.DelegatingMultipartFormDataBodyParser
-
Deprecated.Deprecated as of 2.8.0. Use
DelegatingMultipartFormDataBodyParser(Materializer, long, long, HttpErrorHandler)
instead. - delete() - Method in class play.libs.ws.ahc.AhcWSRequest
- delete() - Method in interface play.libs.ws.WSRequest
-
Perform a DELETE on the request asynchronously.
- delete(Files.TemporaryFile) - Method in class play.libs.Files.DelegateTemporaryFileCreator
- delete(Files.TemporaryFile) - Method in class play.libs.Files.SingletonTemporaryFileCreator
- delete(Files.TemporaryFile) - Method in interface play.libs.Files.TemporaryFileCreator
- DELETE - Static variable in interface play.mvc.Http.HttpVerbs
- DELETE - Static variable in class play.test.Helpers
- DELETE(String) - Method in class play.routing.RoutingDsl
-
Create a DELETE route for the given path pattern.
- DEV - play.Mode
- devContext() - Method in class play.ApplicationLoader.Context
-
If an application is loaded in dev mode then this additional context is available.
- devContext() - Method in interface play.BuiltInComponents
-
Helper to interact with the Play build environment.
- devContext() - Method in class play.ContextBasedBuiltInComponents
- devServerError(Http.RequestHeader, UsefulException) - Method in class play.http.JsonHttpErrorHandler
-
Invoked in dev mode when a server error occurs.
- disable(Class<?>...) - Method in class play.inject.guice.GuiceBuilder
-
Disable modules by class.
- DISALLOW_DOCTYPE_DECL_FEATURE - Static variable in class play.libs.XML.Constants
- discardingCookie(String) - Method in class play.mvc.Result
-
Discard a cookie on the default path ("/") with no domain and that's not secure.
- discardingCookie(String, String) - Method in class play.mvc.Result
-
Discard a cookie on the given path with no domain and not that's secure.
- discardingCookie(String, String, String) - Method in class play.mvc.Result
-
Discard a cookie on the given path and domain that's not secure.
- discardingCookie(String, String, String, boolean) - Method in class play.mvc.Result
-
Discard a cookie in this result
- discardingCookie(String, String, String, boolean, Http.Cookie.SameSite) - Method in class play.mvc.Result
-
Discard a cookie in this result
- discardingErrors() - Method in class play.data.DynamicForm
- discardingErrors() - Method in class play.data.Form
- displayableConstraint(Set<ConstraintDescriptor<?>>) - Static method in class play.data.validation.Constraints
-
Converts a set of constraints to human-readable values.
- displayableConstraint(Set<ConstraintDescriptor<?>>, Annotation[]) - Static method in class play.data.validation.Constraints
-
Converts a set of constraints to human-readable values in guaranteed order.
- displayableConstraint(ConstraintDescriptor<?>) - Static method in class play.data.validation.Constraints
-
Converts a constraint to a human-readable value.
- documentation() - Method in interface play.routing.Router
- domain() - Method in interface play.core.cookie.encoding.Cookie
-
Returns the domain of this
Cookie
. - domain() - Method in class play.core.cookie.encoding.DefaultCookie
- domain() - Method in class play.mvc.Http.Cookie
- done(A) - Static method in class play.libs.streams.Accumulator
-
Create a done accumulator with the given value.
- done(CompletionStage<A>) - Static method in class play.libs.streams.Accumulator
-
Create a done accumulator with the given future.
- duration() - Method in annotation type play.cache.Cached
-
The duration the action should be cached for.
- Dynamic() - Constructor for class play.data.DynamicForm.Dynamic
- Dynamic(Map<String, Object>) - Constructor for class play.data.DynamicForm.Dynamic
- DynamicForm - Class in play.data
-
A dynamic form.
- DynamicForm(Map<String, String>, List<ValidationError>, Optional<DynamicForm.Dynamic>, MessagesApi, Formatters, ValidatorFactory, Config) - Constructor for class play.data.DynamicForm
-
Creates a new dynamic form.
- DynamicForm(Map<String, String>, List<ValidationError>, Optional<DynamicForm.Dynamic>, MessagesApi, Formatters, ValidatorFactory, Config, Lang) - Constructor for class play.data.DynamicForm
-
Creates a new dynamic form.
- DynamicForm(Map<String, String>, Map<String, Http.MultipartFormData.FilePart<?>>, List<ValidationError>, Optional<DynamicForm.Dynamic>, MessagesApi, Formatters, ValidatorFactory, Config) - Constructor for class play.data.DynamicForm
-
Creates a new dynamic form.
- DynamicForm(Map<String, String>, Map<String, Http.MultipartFormData.FilePart<?>>, List<ValidationError>, Optional<DynamicForm.Dynamic>, MessagesApi, Formatters, ValidatorFactory, Config, Lang) - Constructor for class play.data.DynamicForm
-
Creates a new dynamic form.
- DynamicForm(MessagesApi, Formatters, ValidatorFactory, Config) - Constructor for class play.data.DynamicForm
-
Creates a new empty dynamic form.
- DynamicForm.Dynamic - Class in play.data
-
Simple data structure used by
DynamicForm
.
E
- eagerly() - Method in class play.inject.Binding
-
Eagerly instantiate this binding when Play starts up.
- EhCacheComponents - Interface in play.cache.ehcache
-
EhCache Java Components for compile time injection.
- ehCacheManager() - Method in interface play.cache.ehcache.EhCacheComponents
- em(String) - Method in class play.db.jpa.DefaultJPAApi
-
Get a newly created EntityManager for the specified persistence unit name.
- em(String) - Method in interface play.db.jpa.JPAApi
-
Get a newly created EntityManager for the specified persistence unit name.
- email() - Static method in class play.data.validation.Constraints
-
Constructs a 'email' validator.
- EmailValidator() - Constructor for class play.data.validation.Constraints.EmailValidator
- empty() - Static method in class play.libs.typedmap.TypedMap
- empty() - Static method in interface play.routing.Router
- Empty() - Constructor for class play.mvc.BodyParser.Empty
- EMPTY_STRING_ARRAY - Static variable in class play.libs.exception.ExceptionUtils
-
Copied from apache.commons.lang3 3.7 ArrayUtils class
- emptyBodyParser() - Method in interface play.components.BodyParserComponents
- emptyMap() - Static method in class play.libs.Scala
- emptySeq() - Static method in class play.libs.Scala
- encode(Iterable<? extends Cookie>) - Method in class play.core.cookie.encoding.ClientCookieEncoder
-
Encodes the specified cookies into a single Cookie header value.
- encode(Iterable<? extends Cookie>) - Method in class play.core.cookie.encoding.ServerCookieEncoder
-
Batch encodes cookies into Set-Cookie header values.
- encode(String, String) - Method in class play.core.cookie.encoding.ClientCookieEncoder
-
Encodes the specified cookie into a Cookie header value.
- encode(String, String) - Method in class play.core.cookie.encoding.ServerCookieEncoder
-
Encodes the specified cookie name-value pair into a Set-Cookie header value.
- encode(Collection<? extends Cookie>) - Method in class play.core.cookie.encoding.ServerCookieEncoder
-
Batch encodes cookies into Set-Cookie header values.
- encode(Cookie) - Method in class play.core.cookie.encoding.ClientCookieEncoder
-
Encodes the specified cookie into a Cookie header value.
- encode(Cookie) - Method in class play.core.cookie.encoding.ServerCookieEncoder
-
Encodes the specified cookie into a Set-Cookie header value.
- encode(Cookie...) - Method in class play.core.cookie.encoding.ClientCookieEncoder
-
Encodes the specified cookies into a single Cookie header value.
- encode(Cookie...) - Method in class play.core.cookie.encoding.ServerCookieEncoder
-
Batch encodes cookies into Set-Cookie header values.
- environment() - Method in interface play.Application
-
Get the application environment.
- environment() - Method in class play.ApplicationLoader.Context
-
Get the environment from the context.
- environment() - Method in interface play.cache.ehcache.EhCacheComponents
- environment() - Method in interface play.components.BaseComponents
-
The application environment.
- environment() - Method in class play.ContextBasedBuiltInComponents
- environment() - Method in interface play.controllers.AssetsComponents
- environment() - Method in interface play.db.DBComponents
- environment() - Method in interface play.db.HikariCPComponents
- environment() - Method in class play.DefaultApplication
-
Get the application environment.
- environment() - Method in interface play.filters.components.IPFilterComponents
- environment() - Method in interface play.filters.components.RedirectHttpsComponents
- environment() - Method in interface play.libs.jcache.JCacheComponents
- environment() - Method in interface play.libs.ws.ahc.AhcWSComponents
- Environment - Class in play
-
The environment for the application.
- Environment(File) - Constructor for class play.Environment
- Environment(File, ClassLoader, Mode) - Constructor for class play.Environment
- Environment(File, Mode) - Constructor for class play.Environment
- Environment(Environment) - Constructor for class play.Environment
- Environment(Mode) - Constructor for class play.Environment
- equals(Object) - Method in class play.cache.NamedCacheImpl
- equals(Object) - Method in class play.core.cookie.encoding.DefaultCookie
- equals(Object) - Method in class play.db.evolutions.Evolution
- equals(Object) - Method in class play.db.NamedDatabaseImpl
- equals(Object) - Method in class play.http.websocket.Message.Binary
- equals(Object) - Method in class play.http.websocket.Message.Close
- equals(Object) - Method in class play.http.websocket.Message.Ping
- equals(Object) - Method in class play.http.websocket.Message.Pong
- equals(Object) - Method in class play.http.websocket.Message.Text
- equals(Object) - Method in class play.inject.NamedImpl
- equals(Object) - Method in class play.libs.F.Tuple
- equals(Object) - Method in class play.libs.F.Tuple3
- equals(Object) - Method in class play.libs.F.Tuple4
- equals(Object) - Method in class play.libs.F.Tuple5
- equals(Object) - Method in class play.libs.typedmap.TypedKey
- error() - Method in annotation type play.filters.csrf.RequireCSRFCheck
-
Calls a implementation class for handling the CSRF error.
- error(String) - Method in class play.data.DynamicForm
- error(String) - Method in class play.data.Form
- error(String) - Method in class play.Logger.ALogger
-
Log a message with the ERROR level.
- error(String) - Static method in class play.Logger
-
Deprecated.Deprecated as of 2.7.0. Create an instance of
Logger.ALogger
viaLogger.of(String)
/Logger.of(Class)
and use the same-named method. Or use SLF4J directly. - error(String, Object...) - Method in class play.Logger.ALogger
-
Log a message with the ERROR level.
- error(String, Object...) - Static method in class play.Logger
-
Deprecated.Deprecated as of 2.7.0. Create an instance of
Logger.ALogger
viaLogger.of(String)
/Logger.of(Class)
and use the same-named method. Or use SLF4J directly. - error(String, Throwable) - Method in class play.Logger.ALogger
-
Log a message with the ERROR level, with the given error.
- error(String, Throwable) - Static method in class play.Logger
-
Deprecated.Deprecated as of 2.7.0. Create an instance of
Logger.ALogger
viaLogger.of(String)
/Logger.of(Class)
and use the same-named method. Or use SLF4J directly. - error(String, Supplier<?>) - Static method in class play.Logger
-
Deprecated.Deprecated as of 2.7.0. Create an instance of
Logger.ALogger
viaLogger.of(String)
/Logger.of(Class)
and use the same-named method. Or use SLF4J directly. - error(String, Supplier<?>...) - Method in class play.Logger.ALogger
-
Log a message with the ERROR level.
- error(Supplier<String>) - Method in class play.Logger.ALogger
-
Log a message with the ERROR level.
- error(Supplier<String>) - Static method in class play.Logger
-
Deprecated.Deprecated as of 2.7.0. Create an instance of
Logger.ALogger
viaLogger.of(String)
/Logger.of(Class)
and use the same-named method. Or use SLF4J directly. - error(Marker, String) - Method in class play.Logger.ALogger
-
Log a message with the ERROR level.
- error(Marker, String, Object...) - Method in class play.Logger.ALogger
-
Log a message with the ERROR level.
- error(Marker, String, Throwable) - Method in class play.Logger.ALogger
-
Log a message with the ERROR level, with the given error.
- errors() - Method in class play.data.Form
-
Returns all errors.
- errors() - Method in class play.data.Form.Field
-
Returns all the errors associated with this field.
- errors(String) - Method in class play.data.Form
- errorsAsJson() - Method in class play.data.Form
- errorsAsJson(Lang) - Method in class play.data.Form
-
Returns the form errors serialized as Json using the given Lang.
- EssentialAction - Class in play.mvc
-
Given a `RequestHeader`, an `EssentialAction` consumes the request body (a `ByteString`) and returns a `Result`.
- EssentialAction() - Constructor for class play.mvc.EssentialAction
- EssentialFilter - Class in play.mvc
- EssentialFilter() - Constructor for class play.mvc.EssentialFilter
- ETAG - Static variable in interface play.mvc.Http.HeaderNames
- event(JsonNode) - Static method in class play.libs.EventSource.Event
- event(String) - Static method in class play.libs.EventSource.Event
- Event(String, String, String) - Constructor for class play.libs.EventSource.Event
- EVENT_STREAM - Static variable in interface play.mvc.Http.MimeTypes
-
Content-Type of server sent events.
- EventSource - Class in play.libs
-
This class provides an easy way to use Server Sent Events (SSE) as a chunked encoding, using an Pekko Source.
- EventSource() - Constructor for class play.libs.EventSource
- EventSource.Event - Class in play.libs
-
Utility class to build events.
- Evolution - Class in play.db.evolutions
-
An evolution.
- Evolution(int, String, String) - Constructor for class play.db.evolutions.Evolution
-
Create the evolution.
- evolutions(String) - Method in class play.db.evolutions.EvolutionsReader
- Evolutions - Class in play.db.evolutions
-
Utilities for working with evolutions.
- Evolutions() - Constructor for class play.db.evolutions.Evolutions
- EvolutionsReader - Class in play.db.evolutions
-
Reads evolutions.
- EvolutionsReader() - Constructor for class play.db.evolutions.EvolutionsReader
- ExceptionUtils - Class in play.libs.exception
-
Copied from apache.commons.lang3 3.7
- ExceptionUtils() - Constructor for class play.libs.exception.ExceptionUtils
- execute() - Method in class play.libs.ws.ahc.AhcWSRequest
- execute() - Method in interface play.libs.ws.WSRequest
-
Execute an arbitrary method on the request asynchronously.
- execute(Runnable) - Method in class play.libs.concurrent.CustomExecutionContext
- execute(String) - Method in class play.libs.ws.ahc.AhcWSRequest
- execute(String) - Method in interface play.libs.ws.WSRequest
-
Execute an arbitrary method on the request asynchronously.
- executionContext() - Method in interface play.components.PekkoComponents
- executionContext() - Method in class play.core.j.MappedJavaHandlerComponents
- EXPECT - Static variable in interface play.mvc.Http.HeaderNames
- EXPECTATION_FAILED - Static variable in interface play.mvc.Http.Status
- expireAfterCreate(Object, Object, long) - Method in class play.cache.caffeine.CaffeineDefaultExpiry
-
Deprecated.
- expireAfterRead(Object, Object, long, long) - Method in class play.cache.caffeine.CaffeineDefaultExpiry
-
Deprecated.
- expireAfterUpdate(Object, Object, long, long) - Method in class play.cache.caffeine.CaffeineDefaultExpiry
-
Deprecated.
- EXPIRES - Static variable in interface play.mvc.Http.HeaderNames
- expressionParsed - Variable in class play.libs.Time.CronExpression
- EXTERNAL_GENERAL_ENTITIES_FEATURE - Static variable in class play.libs.XML.Constants
- EXTERNAL_PARAMETER_ENTITIES_FEATURE - Static variable in class play.libs.XML.Constants
- extractSignedToken(String) - Method in interface play.libs.crypto.CSRFTokenSigner
-
Extract a signed token that was signed by
CSRFTokenSigner.signToken(String)
. - extractSignedToken(String) - Method in class play.libs.crypto.DefaultCSRFTokenSigner
F
- F - Class in play.libs
-
Defines a set of functional programming style helpers.
- F() - Constructor for class play.libs.F
- F.Either<L,R> - Class in play.libs
-
Represents a value of one of two possible types (a disjoint union)
- F.Function3<A,B,C,R> - Interface in play.libs
-
A Function with 3 arguments.
- F.Function4<A,B,C,D,R> - Interface in play.libs
-
A Function with 4 arguments.
- F.LazySupplier<T> - Class in play.libs
- F.PromiseTimeoutException - Exception in play.libs
-
Exception thrown when an operation times out.
- F.Tuple<A,B> - Class in play.libs
-
A pair - a tuple of the types
A
andB
. - F.Tuple3<A,B,C> - Class in play.libs
-
A tuple of A,B,C
- F.Tuple4<A,B,C,D> - Class in play.libs
-
A tuple of A,B,C,D
- F.Tuple5<A,B,C,D,E> - Class in play.libs
-
A tuple of A,B,C,D,E
- FAILED_DEPENDENCY - Static variable in interface play.mvc.Http.Status
- fakeApplication() - Static method in class play.test.Helpers
-
Builds a new fake application, using GuiceApplicationBuilder.
- fakeApplication(Map<String, ?>) - Static method in class play.test.Helpers
-
Build a new fake application.
- fakeRequest() - Static method in class play.test.Helpers
-
Builds a new "GET /" fake request.
- fakeRequest(String, String) - Static method in class play.test.Helpers
-
Builds a new fake request.
- fakeRequest(Call) - Static method in class play.test.Helpers
-
Builds a new fake request corresponding to a given route call.
- fatalErrorJson(Http.RequestHeader, Throwable) - Method in class play.http.JsonHttpErrorHandler
-
Invoked when handling a server error with this error handler failed.
- fatalErrorMessage(Http.RequestHeader, Throwable) - Method in class play.http.DefaultHttpErrorHandler
-
Invoked when handling a server error with this error handler failed.
- field(String) - Method in class play.data.Form
-
Retrieves a field.
- field(String, Lang) - Method in class play.data.DynamicForm
- field(String, Lang) - Method in class play.data.Form
-
Retrieves a field.
- Field(Form<?>, String, List<F.Tuple<String, List<Object>>>, F.Tuple<String, List<Object>>, List<ValidationError>, String) - Constructor for class play.data.Form.Field
-
Creates a form field.
- Field(Form<?>, String, List<F.Tuple<String, List<Object>>>, F.Tuple<String, List<Object>>, List<ValidationError>, String, Http.MultipartFormData.FilePart<?>) - Constructor for class play.data.Form.Field
- Field(Form<?>, String, List<F.Tuple<String, List<Object>>>, F.Tuple<String, List<Object>>, List<ValidationError>, Http.MultipartFormData.FilePart<?>) - Constructor for class play.data.Form.Field
- file() - Method in class play.data.Form.Field
- file(String) - Method in class play.data.DynamicForm
-
Gets the concrete value only if the submission was a success.
- FileInfo(String, String, String) - Constructor for class play.mvc.Http.MultipartFormData.FileInfo
- fileMimeTypes() - Method in interface play.components.FileMimeTypesComponents
- fileMimeTypes() - Method in class play.ContextBasedBuiltInComponents
- fileMimeTypes() - Static method in class play.mvc.StaticFileMimeTypes
- FileMimeTypes - Class in play.mvc
- FileMimeTypes(FileMimeTypes) - Constructor for class play.mvc.FileMimeTypes
- FileMimeTypesComponents - Interface in play.components
-
Java File Mime Types components.
- FilePart(String, String, String, A) - Constructor for class play.mvc.Http.MultipartFormData.FilePart
- FilePart(String, String, String, A, long) - Constructor for class play.mvc.Http.MultipartFormData.FilePart
- FilePart(String, String, String, A, long, String) - Constructor for class play.mvc.Http.MultipartFormData.FilePart
- FilePart(String, String, String, A, long, String, Function<A, Optional<ByteString>>) - Constructor for class play.mvc.Http.MultipartFormData.FilePart
- FilePart(String, String, String, A, long, Function<A, Optional<ByteString>>) - Constructor for class play.mvc.Http.MultipartFormData.FilePart
- FilePart(String, String, String, A, Function<A, Optional<ByteString>>) - Constructor for class play.mvc.Http.MultipartFormData.FilePart
- files() - Method in class play.data.DynamicForm
- files() - Method in class play.data.Form
- Files - Class in play.libs
-
Contains TemporaryFile and TemporaryFileCreator operations.
- Files() - Constructor for class play.libs.Files
- Files.DelegateTemporaryFile - Class in play.libs
-
Delegates to the Scala implementation.
- Files.DelegateTemporaryFileCreator - Class in play.libs
-
A temporary file creator that delegates to a Scala TemporaryFileCreator.
- Files.SingletonTemporaryFileCreator - Class in play.libs
-
A temporary file creator that uses the Scala play.api.libs.Files.SingletonTemporaryFileCreator class behind the scenes.
- Files.TemporaryFile - Interface in play.libs
-
A temporary file created by a TemporaryFileCreator.
- Files.TemporaryFileCreator - Interface in play.libs
-
This creates temporary files when Play needs to keep overflow data on the filesystem.
- fill(Map<String, Object>) - Method in class play.data.DynamicForm
-
Fills the form with existing data.
- fill(T) - Method in class play.data.Form
-
Populates this form with an existing value, used for edit forms.
- fillDataWith(String, Map<String, T>, int, Function<Integer, T>) - Method in class play.data.Form
- fillDataWith(Map<String, String>, Map<String, String[]>) - Method in class play.data.Form
- Filter - Class in play.mvc
- Filter(Materializer) - Constructor for class play.mvc.Filter
- findNextWhiteSpace(int, String) - Method in class play.libs.Time.CronExpression
- FIREFOX - Static variable in class play.test.Helpers
- flash() - Method in class play.mvc.Http.RequestBuilder
- flash() - Method in interface play.mvc.Http.RequestHeader
-
Parses the Flash cookie and returns the Flash data.
- flash() - Method in class play.mvc.Result
-
Extracts the Flash values of this Result value.
- flash(String, String) - Method in class play.mvc.Http.RequestBuilder
-
Sets a cookie in the request.
- flash(Map<String, String>) - Method in class play.mvc.Http.RequestBuilder
-
Sets cookies in a request.
- Flash() - Constructor for class play.mvc.Http.Flash
- Flash(Map<String, String>) - Constructor for class play.mvc.Http.Flash
- Flash(Flash) - Constructor for class play.mvc.Http.Flash
- flashing(String, String) - Method in class play.mvc.Result
-
Adds the given key and value to the flash.
- flashing(Map<String, String>) - Method in class play.mvc.Result
-
Adds values to the flash.
- flatten(CompletionStage<Accumulator<E, A>>, Materializer) - Static method in class play.libs.streams.Accumulator
-
Flatten a completion stage of an accumulator to an accumulator.
- flow() - Static method in class play.libs.EventSource
- flow(String) - Static method in class play.libs.Comet
-
Produces a flow of ByteString with a prepended block and a script wrapper.
- flow(String, String) - Static method in class play.libs.Comet
-
Produces a flow of ByteString with a prepended block and a script wrapper.
- fluentWait() - Method in class play.test.TestBrowser
-
Creates a generic
FluentWait<WebDriver>
instance using the underlying web driver. - forbidden() - Static method in class play.mvc.Results
-
Generates a 403 Forbidden result.
- forbidden(byte[]) - Static method in class play.mvc.Results
-
Generates a 403 Forbidden result.
- forbidden(JsonNode) - Static method in class play.mvc.Results
-
Generates a 403 Forbidden result.
- forbidden(JsonNode, JsonEncoding) - Static method in class play.mvc.Results
-
Generates a 403 Forbidden result.
- forbidden(File) - Static method in class play.mvc.Results
-
Generates a 403 Forbidden result.
- forbidden(File, boolean) - Static method in class play.mvc.Results
-
Generates a 403 Forbidden result.
- forbidden(File, boolean, Optional<String>) - Static method in class play.mvc.Results
-
Generates a 403 Forbidden result.
- forbidden(File, boolean, Optional<String>, FileMimeTypes) - Static method in class play.mvc.Results
-
Generates a 403 Forbidden result.
- forbidden(File, boolean, FileMimeTypes) - Static method in class play.mvc.Results
-
Generates a 403 Forbidden result.
- forbidden(File, String) - Static method in class play.mvc.Results
-
Deprecated.Deprecated as of 2.8.0. Use to
Results.forbidden(File, Optional)
. - forbidden(File, String, FileMimeTypes) - Static method in class play.mvc.Results
-
Deprecated.Deprecated as of 2.8.0. Use to
Results.forbidden(File, Optional, FileMimeTypes)
. - forbidden(File, Optional<String>) - Static method in class play.mvc.Results
-
Generates a 403 Forbidden result.
- forbidden(File, Optional<String>, FileMimeTypes) - Static method in class play.mvc.Results
-
Generates a 403 Forbidden result.
- forbidden(File, FileMimeTypes) - Static method in class play.mvc.Results
-
Generates a 403 Forbidden result.
- forbidden(InputStream) - Static method in class play.mvc.Results
-
Generates a 403 Forbidden result.
- forbidden(InputStream, long) - Static method in class play.mvc.Results
-
Generates a 403 Forbidden result.
- forbidden(String) - Static method in class play.mvc.Results
-
Generates a 403 Forbidden result.
- forbidden(String, String) - Static method in class play.mvc.Results
-
Generates a 403 Forbidden result.
- forbidden(Path) - Static method in class play.mvc.Results
-
Generates a 403 Forbidden result.
- forbidden(Path, boolean) - Static method in class play.mvc.Results
-
Generates a 403 Forbidden result.
- forbidden(Path, boolean, Optional<String>) - Static method in class play.mvc.Results
-
Generates a 403 Forbidden result.
- forbidden(Path, boolean, Optional<String>, FileMimeTypes) - Static method in class play.mvc.Results
-
Generates a 403 Forbidden result.
- forbidden(Path, boolean, FileMimeTypes) - Static method in class play.mvc.Results
-
Generates a 403 Forbidden result.
- forbidden(Path, Optional<String>) - Static method in class play.mvc.Results
-
Generates a 403 Forbidden result.
- forbidden(Path, Optional<String>, FileMimeTypes) - Static method in class play.mvc.Results
-
Generates a 403 Forbidden result.
- forbidden(Path, FileMimeTypes) - Static method in class play.mvc.Results
-
Generates a 403 Forbidden result.
- forbidden(Content) - Static method in class play.mvc.Results
-
Generates a 403 Forbidden result.
- forbidden(Content, String) - Static method in class play.mvc.Results
-
Generates a 403 Forbidden result.
- FORBIDDEN - Static variable in interface play.mvc.Http.Status
- forCode(String) - Static method in class play.i18n.Lang
-
Create a Lang value from a code (such as fr or en-US).
- forDefault(Evolution...) - Static method in class play.db.evolutions.Evolutions
-
Create an evolutions reader for the default database from a list of evolutions.
- forFileName(String) - Method in class play.mvc.FileMimeTypes
- form() - Method in class play.data.FormFactory
- form(Class<T>) - Method in class play.data.FormFactory
- form(Class<T>, Class<?>...) - Method in class play.data.FormFactory
- form(String, Class<T>) - Method in class play.data.FormFactory
- form(String, Class<T>, Class<?>...) - Method in class play.data.FormFactory
- Form<T> - Class in play.data
-
Helper to manage HTML form description, submission and validation.
- Form(Class<T>, MessagesApi, Formatters, ValidatorFactory, Config) - Constructor for class play.data.Form
-
Creates a new
Form
. - Form(String, Class<T>, Class<?>[], MessagesApi, Formatters, ValidatorFactory, Config) - Constructor for class play.data.Form
- Form(String, Class<T>, Class<?>, MessagesApi, Formatters, ValidatorFactory, Config) - Constructor for class play.data.Form
- Form(String, Class<T>, Map<String, String>, List<ValidationError>, Optional<T>, Class<?>[], MessagesApi, Formatters, ValidatorFactory, Config) - Constructor for class play.data.Form
-
Creates a new
Form
. - Form(String, Class<T>, Map<String, String>, List<ValidationError>, Optional<T>, Class<?>[], MessagesApi, Formatters, ValidatorFactory, Config, Lang) - Constructor for class play.data.Form
-
Creates a new
Form
. - Form(String, Class<T>, Map<String, String>, List<ValidationError>, Optional<T>, Class<?>[], MessagesApi, Formatters, ValidatorFactory, Config, Lang, boolean) - Constructor for class play.data.Form
-
Creates a new
Form
. - Form(String, Class<T>, Map<String, String>, List<ValidationError>, Optional<T>, Class<?>, MessagesApi, Formatters, ValidatorFactory, Config) - Constructor for class play.data.Form
- Form(String, Class<T>, Map<String, String>, List<ValidationError>, Optional<T>, MessagesApi, Formatters, ValidatorFactory, Config) - Constructor for class play.data.Form
- Form(String, Class<T>, Map<String, String>, Map<String, Http.MultipartFormData.FilePart<?>>, List<ValidationError>, Optional<T>, Class<?>[], MessagesApi, Formatters, ValidatorFactory, Config) - Constructor for class play.data.Form
-
Creates a new
Form
. - Form(String, Class<T>, Map<String, String>, Map<String, Http.MultipartFormData.FilePart<?>>, List<ValidationError>, Optional<T>, Class<?>[], MessagesApi, Formatters, ValidatorFactory, Config, Lang) - Constructor for class play.data.Form
-
Creates a new
Form
. - Form(String, Class<T>, Map<String, String>, Map<String, Http.MultipartFormData.FilePart<?>>, List<ValidationError>, Optional<T>, Class<?>[], MessagesApi, Formatters, ValidatorFactory, Config, Lang, boolean) - Constructor for class play.data.Form
-
Creates a new
Form
. - Form(String, Class<T>, Map<String, String>, Map<String, Http.MultipartFormData.FilePart<?>>, List<ValidationError>, Optional<T>, Class<?>, MessagesApi, Formatters, ValidatorFactory, Config) - Constructor for class play.data.Form
- Form(String, Class<T>, Map<String, String>, Map<String, Http.MultipartFormData.FilePart<?>>, List<ValidationError>, Optional<T>, MessagesApi, Formatters, ValidatorFactory, Config) - Constructor for class play.data.Form
- Form(String, Class<T>, MessagesApi, Formatters, ValidatorFactory, Config) - Constructor for class play.data.Form
- FORM - Static variable in interface play.mvc.Http.MimeTypes
-
Content-Type of form-urlencoded.
- Form.Display - Annotation Type in play.data
-
Defines a form element's display name.
- Form.Field - Class in play.data
-
A form field.
- format() - Method in class play.data.Form.Field
-
Returns the expected format for this field.
- format(Messages) - Method in class play.data.validation.ValidationError
-
Returns the formatted error message (message + arguments) in the given Messages.
- formatDevServerErrorException(Throwable) - Method in class play.http.JsonHttpErrorHandler
-
Format a
Throwable
as a JSON value. - Formats - Class in play.data.format
-
Defines several default formatters.
- Formats() - Constructor for class play.data.format.Formats
- Formats.AnnotationDateFormatter - Class in play.data.format
-
Annotation formatter, triggered by the
@DateTime
annotation. - Formats.AnnotationNonEmptyFormatter - Class in play.data.format
-
Annotation formatter, triggered by the
@NonEmpty
annotation. - Formats.DateFormatter - Class in play.data.format
-
Formatter for
java.util.Date
values. - Formats.DateTime - Annotation Type in play.data.format
-
Defines the format for a
Date
field. - Formats.NonEmpty - Annotation Type in play.data.format
-
Defines the format for a
String
field that cannot be empty. - formatted() - Method in class play.libs.EventSource.Event
- formatters() - Method in interface play.data.FormFactoryComponents
- Formatters - Class in play.data.format
-
Formatters helper.
- Formatters(MessagesApi) - Constructor for class play.data.format.Formatters
- Formatters.AnnotationFormatter<A extends Annotation,T> - Class in play.data.format
-
Super-type for annotation-based formatters.
- Formatters.SimpleFormatter<T> - Class in play.data.format
-
Super-type for custom simple formatters.
- FormattersModule - Class in play.data.format
- FormattersModule() - Constructor for class play.data.format.FormattersModule
- formFactory() - Method in interface play.data.FormFactoryComponents
- FormFactory - Class in play.data
-
Helper to create HTML forms.
- FormFactory(MessagesApi, Formatters, ValidatorFactory, Config) - Constructor for class play.data.FormFactory
- FormFactoryComponents - Interface in play.data
-
Java Components for FormFactory.
- FormFactoryModule - Class in play.data
- FormFactoryModule() - Constructor for class play.data.FormFactoryModule
- FormUrlEncoded(long, HttpErrorHandler) - Constructor for class play.mvc.BodyParser.FormUrlEncoded
- FormUrlEncoded(HttpConfiguration, HttpErrorHandler) - Constructor for class play.mvc.BodyParser.FormUrlEncoded
- formUrlEncodedBodyParser() - Method in interface play.components.BodyParserComponents
- forRouter(int, Function<BuiltInComponents, Router>) - Static method in class play.server.Server
-
Create a server for the given router.
- forRouter(Function<BuiltInComponents, Router>) - Static method in class play.server.Server
-
Create a server for the given router.
- forRouter(Mode, int, Function<BuiltInComponents, Router>) - Static method in class play.server.Server
-
Create a server for the router returned by the given block.
- forRouter(Mode, Function<BuiltInComponents, Router>) - Static method in class play.server.Server
-
Create a server for the given router.
- FORWARDED - Static variable in interface play.mvc.Http.HeaderNames
- found(String) - Static method in class play.mvc.Results
-
Generates a 302 Found result.
- found(Call) - Static method in class play.mvc.Results
-
Generates a 302 Found result.
- FOUND - Static variable in interface play.mvc.Http.Status
- fragment() - Method in class play.mvc.Call
-
The fragment of the URL.
- from(Config, ActorSystem) - Static method in class play.cache.caffeine.CaffeineParser
-
Returns a configured
Caffeine
cache builder. - from(Map<String, String>) - Static method in class play.db.jpa.DefaultJPAConfig
-
Create a default JPA configuration from a map of names to unit names.
- FROM - Static variable in interface play.mvc.Http.HeaderNames
- fromClassLoader() - Static method in class play.db.evolutions.Evolutions
-
Create an evolutions reader that reads evolution files from this class's own classloader.
- fromClassLoader(ClassLoader) - Static method in class play.db.evolutions.Evolutions
-
Create an evolutions reader that reads evolution files from a classloader.
- fromClassLoader(ClassLoader, String) - Static method in class play.db.evolutions.Evolutions
-
Create an evolutions reader that reads evolution files from a classloader.
- fromComponents(BuiltInComponents) - Static method in class play.routing.RoutingDsl
- fromContent(Content, String) - Static method in class play.http.HttpEntity
-
Create an entity from the given content.
- fromId(int) - Static method in enum play.db.TransactionIsolationLevel
- fromInputSource(InputSource) - Static method in class play.libs.XML
-
Parses the input source as DOM.
- fromInputStream(InputStream, String) - Static method in class play.libs.XML
-
Parses an InputStream as DOM.
- fromJson(JsonNode, Class<A>) - Static method in class play.libs.Json
-
Converts a JsonNode to a Java value
- fromMap(Map<String, List<Evolution>>) - Static method in class play.db.evolutions.Evolutions
-
Create an evolutions reader based on a simple map of database names to evolutions.
- fromScalaBuilder(GuiceApplicationBuilder) - Static method in class play.inject.guice.GuiceApplicationBuilder
- fromSink(Sink<E, CompletionStage<A>>) - Static method in class play.libs.streams.Accumulator
-
Create an accumulator from an Pekko streams sink.
- fromString(String) - Static method in class play.libs.XML
-
Parses an XML string as DOM.
- fromString(String, String) - Static method in class play.http.HttpEntity
-
Create an entity from the given String.
- fromThread(Executor) - Static method in class play.libs.concurrent.ClassLoaderExecution
-
An ExecutionContext that executes work on the given ExecutionContext.
- fromThread(Executor) - Static method in class play.libs.concurrent.HttpExecution
-
Deprecated.Deprecated as of 2.9.0. Use to
ClassLoaderExecution.fromThread(Executor)
instead. - fromThread(ExecutionContext) - Static method in class play.libs.concurrent.ClassLoaderExecution
-
An ExecutionContext that executes work on the given ExecutionContext.
- fromThread(ExecutionContext) - Static method in class play.libs.concurrent.HttpExecution
-
Deprecated.Deprecated as of 2.9.0. Use to
ClassLoaderExecution.fromThread(ExecutionContext)
instead. - fromThread(ExecutionContextExecutor) - Static method in class play.libs.concurrent.ClassLoaderExecution
-
An ExecutionContext that executes work on the given ExecutionContext.
- fromThread(ExecutionContextExecutor) - Static method in class play.libs.concurrent.HttpExecution
-
Deprecated.Deprecated as of 2.9.0. Use to
ClassLoaderExecution.fromThread(ExecutionContextExecutor)
instead. - Futures - Interface in play.libs.concurrent
-
Utilities for creating
CompletionStage
operations.
G
- GATEWAY_TIMEOUT - Static variable in interface play.mvc.Http.Status
- generateProperties(Environment, Config, Map<String, String>) - Static method in interface play.LoggerConfigurator
- generateSignedToken() - Method in interface play.libs.crypto.CSRFTokenSigner
-
Generates a signed token by calling generateToken / signToken.
- generateSignedToken() - Method in class play.libs.crypto.DefaultCSRFTokenSigner
- generateToken() - Method in interface play.libs.crypto.CSRFTokenSigner
-
Generates a cryptographically secure token.
- generateToken() - Method in class play.libs.crypto.DefaultCSRFTokenSigner
- get() - Method in class play.data.Form
-
Gets the concrete value only if the submission was a success.
- get() - Method in class play.data.validation.ValidatorFactoryProvider
- get() - Method in class play.data.validation.ValidatorProvider
-
Deprecated.
- get() - Method in class play.db.DBModule.NamedDatabaseProvider
- get() - Method in class play.db.jpa.DefaultJPAApi.JPAApiProvider
- get() - Method in class play.db.jpa.DefaultJPAConfig.JPAConfigProvider
- get() - Method in class play.inject.SourceProvider
-
Returns the calling line of code.
- get() - Method in class play.libs.F.LazySupplier
- get() - Method in class play.libs.ws.ahc.AhcWSModule.AhcWSClientProvider
- get() - Method in class play.libs.ws.ahc.AhcWSModule.StandaloneWSClientProvider
- get() - Method in class play.libs.ws.ahc.AhcWSRequest
- get() - Method in interface play.libs.ws.WSRequest
-
Perform a GET on the request asynchronously.
- get() - Method in class play.server.ApplicationProvider
- get(String) - Method in interface play.cache.AsyncCacheApi
-
Retrieves an object by key.
- get(String) - Method in class play.cache.DefaultAsyncCacheApi
- get(String) - Method in class play.cache.DefaultSyncCacheApi
- get(String) - Method in interface play.cache.SyncCacheApi
-
Retrieves an object by key.
- get(String) - Method in class play.cache.SyncCacheApiAdapter
- get(String) - Method in class play.data.DynamicForm
-
Gets the concrete value only if the submission was a success.
- get(String) - Method in interface play.mvc.Http.Cookies
- get(String) - Method in class play.mvc.Http.Flash
-
Optionally returns the flash scope value associated with a key.
- get(String) - Method in class play.mvc.Http.Headers
-
Gets the header value.
- get(String) - Method in class play.mvc.Http.Session
-
Optionally returns the session value associated with a key.
- get(K, BiFunction<? super K, ? super Executor, ? extends CompletableFuture<? extends V>>) - Method in class play.cache.caffeine.NamedCaffeineCache
- get(K, Function<? super K, ? extends V>) - Method in class play.cache.caffeine.NamedCaffeineCache
- get(Lang, String, Object...) - Method in class play.i18n.MessagesApi
-
Translates a message.
- get(Lang, List<String>, Object...) - Method in class play.i18n.MessagesApi
-
Translates the first defined message.
- get(Lang) - Method in class play.data.Form
-
Gets the concrete value only if the submission was a success.
- get(TypedKey<A>) - Method in class play.libs.typedmap.TypedMap
-
Get a value from the map, throwing an exception if it is not present.
- GET - Static variable in interface play.mvc.Http.HttpVerbs
- GET - Static variable in class play.test.Helpers
- GET(String) - Method in class play.routing.RoutingDsl
-
Create a GET route for the given path pattern.
- getAccessibleConstructor(Constructor<T>) - Static method in class play.libs.reflect.ConstructorUtils
-
Checks if the specified constructor is accessible.
- getAccessibleMethod(Method) - Static method in class play.libs.reflect.MethodUtils
-
Returns an accessible method (that is, one that can be invoked via reflection) that implements the specified Method.
- getAction(Class<A>) - Method in class play.core.j.MappedJavaHandlerComponents
- getAll(Iterable<? extends K>, BiFunction<? super Set<? extends K>, ? super Executor, ? extends CompletableFuture<? extends Map<? extends K, ? extends V>>>) - Method in class play.cache.caffeine.NamedCaffeineCache
- getAll(Iterable<? extends K>, Function<? super Set<? extends K>, ? extends Map<? extends K, ? extends V>>) - Method in class play.cache.caffeine.NamedCaffeineCache
- getAll(String) - Method in class play.mvc.Http.Headers
-
Get all the values associated with the header name.
- getAllHeaders() - Method in class play.libs.ws.ahc.AhcWSResponse
-
Deprecated.Deprecated since 2.6.0. Use
AhcWSResponse.getHeaders()
instead. - getAllHeaders() - Method in interface play.libs.ws.WSResponse
-
Deprecated.
- getArgumentsForConstraint(String, String, ConstraintViolation<Object>) - Method in class play.data.Form
- getAttrs() - Method in class play.data.validation.Constraints.ValidationPayload
- getAuth() - Method in class play.libs.ws.ahc.AhcWSRequest
- getBackedType() - Method in class play.data.Form
- getBody() - Method in class play.libs.ws.ahc.AhcWSRequest
- getBody() - Method in class play.libs.ws.ahc.AhcWSResponse
- getBody() - Method in interface play.libs.ws.WSResponse
- getBody(BodyReadable<T>) - Method in class play.libs.ws.ahc.AhcWSResponse
- getBody(BodyReadable<T>) - Method in interface play.libs.ws.WSResponse
-
Gets the body of the response as a T, using a
BodyReadable
. - getBodyAsBytes() - Method in class play.libs.ws.ahc.AhcWSResponse
- getBodyAsBytes() - Method in interface play.libs.ws.WSResponse
- getBodyAsSource() - Method in class play.libs.ws.ahc.AhcWSResponse
- getBodyAsSource() - Method in interface play.libs.ws.WSResponse
- getBodyAsStream() - Method in class play.libs.ws.ahc.AhcWSResponse
-
Deprecated.Use
response.getBody(inputStream())
- getBodyAsStream() - Method in interface play.libs.ws.WSResponse
-
Deprecated.use
getBody(BodyReadable)
withWSBodyWritables.inputStream()
. - getBodyParser(Class<A>) - Method in class play.core.j.MappedJavaHandlerComponents
- getCalculator() - Method in class play.libs.ws.ahc.AhcWSRequest
- getClazz() - Method in class play.inject.BindingKey
- getClazz() - Method in class play.inject.QualifierClass
- getConfig() - Method in class play.data.validation.Constraints.ValidationPayload
- getConnection() - Method in interface play.db.Database
-
Get a JDBC connection from the underlying data source.
- getConnection() - Method in class play.db.DefaultDatabase
- getConnection(boolean) - Method in interface play.db.Database
-
Get a JDBC connection from the underlying data source.
- getConnection(boolean) - Method in class play.db.DefaultDatabase
- getContentType() - Method in class play.libs.ws.ahc.AhcWSRequest
- getContentType() - Method in class play.libs.ws.ahc.AhcWSResponse
- getContentType() - Method in interface play.libs.ws.WSResponse
- getContentType() - Method in class play.mvc.Http.MultipartFormData.FileInfo
- getContentType() - Method in class play.mvc.Http.MultipartFormData.FilePart
- getControllerMethodInvocation() - Method in class play.routing.Router.RouteDocumentation
- getCookie(String) - Method in class play.libs.ws.ahc.AhcWSResponse
- getCookie(String) - Method in interface play.libs.ws.WSResponse
- getCookie(String) - Method in interface play.mvc.Http.Cookies
-
Deprecated.Deprecated as of 2.8.0. Renamed to
Http.Cookies.get(String)
- getCookie(String) - Method in interface play.mvc.Http.RequestHeader
-
Deprecated.Deprecated as of 2.9.0. Use
Http.RequestHeader.cookie(String)
instead. - getCookie(String) - Method in class play.mvc.Result
-
Deprecated.Deprecated as of 2.8.0. Renamed to
Result.cookie(String)
- getCookies() - Method in class play.libs.ws.ahc.AhcWSResponse
- getCookies() - Method in interface play.libs.ws.WSResponse
- getCronExpression() - Method in class play.libs.Time.CronExpression
- getData() - Method in class play.data.DynamicForm.Dynamic
- getDatabase(String) - Method in interface play.db.DBApi
- getDatabase(String) - Method in class play.db.DefaultDBApi
- getDatabases() - Method in interface play.db.DBApi
- getDatabases() - Method in class play.db.DefaultDBApi
- getDataSource() - Method in interface play.db.Database
- getDataSource() - Method in class play.db.DefaultDatabase
- getDayOfWeekNumber(String) - Method in class play.libs.Time.CronExpression
- getDisableUrlEncoding() - Method in class play.libs.ws.ahc.AhcWSRequest
- getDispositionType() - Method in class play.mvc.Http.MultipartFormData.FilePart
- getEager() - Method in class play.inject.Binding
- getErrorMessageKey() - Method in class play.data.validation.Constraints.EmailValidator
- getErrorMessageKey() - Method in class play.data.validation.Constraints.MaxLengthValidator
- getErrorMessageKey() - Method in class play.data.validation.Constraints.MaxValidator
- getErrorMessageKey() - Method in class play.data.validation.Constraints.MinLengthValidator
- getErrorMessageKey() - Method in class play.data.validation.Constraints.MinValidator
- getErrorMessageKey() - Method in class play.data.validation.Constraints.PatternValidator
- getErrorMessageKey() - Method in class play.data.validation.Constraints.RequiredValidator
- getErrorMessageKey() - Method in class play.data.validation.Constraints.ValidatePayloadWithValidator
- getErrorMessageKey() - Method in class play.data.validation.Constraints.ValidateWithValidator
- getErrorMessageKey() - Method in class play.data.validation.Constraints.Validator
- getErrorMessageKey() - Method in class play.data.validation.Constraints.ValidatorWithPayload
- getEvolutions(String) - Method in class play.db.evolutions.EvolutionsReader
-
Get the evolutions for the given database name.
- getEvolutions(String) - Method in class play.db.evolutions.SimpleEvolutionsReader
- getExistingFile(String) - Method in class play.Environment
-
Retrieves a file relative to the application root path.
- getExpressionSetSummary(ArrayList<Integer>) - Method in class play.libs.Time.CronExpression
- getExpressionSetSummary(Set<Integer>) - Method in class play.libs.Time.CronExpression
- getExpressionSummary() - Method in class play.libs.Time.CronExpression
- getFile(String) - Method in class play.Environment
-
Retrieves a file relative to the application root path.
- getFile(String) - Method in class play.mvc.Http.MultipartFormData
-
Access a file part.
- getFilename() - Method in class play.mvc.Http.MultipartFormData.FileInfo
- getFilename() - Method in class play.mvc.Http.MultipartFormData.FilePart
- getFiles() - Method in class play.mvc.Http.MultipartFormData
-
Retrieves all file parts.
- getFileSize() - Method in class play.mvc.Http.MultipartFormData.FilePart
- getFilters() - Method in class play.http.DefaultHttpFilters
- getFilters() - Method in interface play.http.HttpFilters
- getFinalFireTime() - Method in class play.libs.Time.CronExpression
-
NOT YET IMPLEMENTED: Returns the final time that the
CronExpression
will match. - getFollowRedirects() - Method in class play.libs.ws.ahc.AhcWSRequest
- getHandler() - Method in class play.http.HandlerForRequest
- getHeader() - Method in class play.mvc.Result
-
Get the response header
- getHeader(String) - Method in class play.libs.ws.ahc.AhcWSRequest
- getHeader(String) - Method in class play.mvc.ResponseHeader
- getHeaders() - Method in class play.libs.ws.ahc.AhcWSRequest
- getHeaders() - Method in class play.libs.ws.ahc.AhcWSResponse
- getHeaders() - Method in interface play.libs.ws.WSRequest
- getHeaders() - Method in interface play.libs.ws.WSResponse
- getHeaders() - Method in class play.mvc.Http.RequestBuilder
-
Deprecated.Deprecated as of 2.9.0. Renamed to
Http.RequestBuilder.headers()
. - getHeaders() - Method in interface play.mvc.Http.RequestHeader
-
Deprecated.Deprecated as of 2.9.0. Renamed to
Http.RequestHeader.headers()
. - getHeaderValues(String) - Method in class play.libs.ws.ahc.AhcWSRequest
- getHeaderValues(String) - Method in class play.libs.ws.ahc.AhcWSResponse
- getHeaderValues(String) - Method in interface play.libs.ws.WSResponse
- getHttpMethod() - Method in class play.routing.Router.RouteDocumentation
- getId() - Method in enum play.db.TransactionIsolationLevel
- getIfPresent(K) - Method in class play.cache.caffeine.NamedCaffeineCache
- getImplementation() - Method in class play.inject.ConstructionTarget
- getIndirectlyPresentAnnotations(A) - Static method in class play.libs.AnnotationUtils
-
If the return type of an existing
value()
method of the passed annotation is anAnnotation[]
array and the annotations inside thatAnnotation[]
array are annotated with theRepeatable
annotation the annotations of that array will be returned. - getInstance() - Method in class play.inject.QualifierInstance
- getInstance(Class<T>) - Method in class play.data.validation.DefaultConstraintValidatorFactory
- getInstance(Class<T>) - Method in class play.data.validation.MappedConstraintValidatorFactory
- getKey() - Method in class play.inject.Binding
- getKey() - Method in class play.inject.BindingKeyTarget
- getKey() - Method in class play.mvc.Http.MultipartFormData.DataPart
- getKey() - Method in class play.mvc.Http.MultipartFormData.FileInfo
- getKey() - Method in class play.mvc.Http.MultipartFormData.FilePart
- getLang() - Method in class play.data.validation.Constraints.ValidationPayload
- getLastDayOfMonth(int, int) - Method in class play.libs.Time.CronExpression
- getMatchingAccessibleConstructor(Class<T>, Class<?>...) - Static method in class play.libs.reflect.ConstructorUtils
-
Finds an accessible constructor with compatible parameters.
- getMatchingAccessibleMethod(Class<?>, String, Class<?>...) - Static method in class play.libs.reflect.MethodUtils
-
Finds an accessible method that matches the given name and has compatible parameters.
- getMessageForConstraintViolation(ConstraintViolation<Object>) - Method in class play.data.Form
-
When dealing with @ValidateWith or @ValidatePayloadWith annotations, and message parameter is not used in the annotation, extract the message from validator's getErrorMessageKey() method
- getMessages() - Method in class play.data.validation.Constraints.ValidationPayload
- getModifiers() - Method in class play.routing.HandlerDef
- getMonthNumber(String) - Method in class play.libs.Time.CronExpression
- getName() - Method in class play.cache.caffeine.NamedCaffeineCache
- getName() - Method in interface play.db.Database
- getName() - Method in class play.db.DefaultDatabase
- getNextInterval(Date) - Method in class play.libs.Time.CronExpression
-
Return the interval between the next valid date and the one after
- getNextInvalidTimeAfter(Date) - Method in class play.libs.Time.CronExpression
-
Returns the next date/time after the given date/time which does not satisfy the expression
- getNextValidTimeAfter(Date) - Method in class play.libs.Time.CronExpression
-
Returns the next date/time after the given date/time which satisfies the cron expression.
- getNumericValue(String, int) - Method in class play.libs.Time.CronExpression
- getOffset() - Method in class play.mvc.RangeResults.SourceAndOffset
- getOptional(String) - Method in interface play.cache.AsyncCacheApi
-
Deprecated.Deprecated as of 2.8.0. Renamed to
AsyncCacheApi.get(String)
. - getOptional(String) - Method in interface play.cache.SyncCacheApi
-
Deprecated.Deprecated as of 2.8.0. Renamed to
SyncCacheApi.get(String)
. - getOptional(String) - Method in class play.mvc.Http.Flash
-
Deprecated.Deprecated as of 2.8.0. Renamed to
Http.Flash.get(String)
. - getOptional(String) - Method in class play.mvc.Http.Session
-
Deprecated.Deprecated as of 2.8.0. Renamed to
Http.Session.get(String)
. - getOptional(TypedKey<A>) - Method in class play.libs.typedmap.TypedMap
-
Get a value from the map, returning an empty
Optional
if it is not present. - getOrElseUpdate(String, Callable<CompletionStage<T>>) - Method in interface play.cache.AsyncCacheApi
-
Retrieve a value from the cache, or set it from a default Callable function.
- getOrElseUpdate(String, Callable<CompletionStage<T>>) - Method in class play.cache.DefaultAsyncCacheApi
- getOrElseUpdate(String, Callable<CompletionStage<T>>, int) - Method in interface play.cache.AsyncCacheApi
-
Retrieve a value from the cache, or set it from a default Callable function.
- getOrElseUpdate(String, Callable<CompletionStage<T>>, int) - Method in class play.cache.DefaultAsyncCacheApi
- getOrElseUpdate(String, Callable<T>) - Method in class play.cache.DefaultSyncCacheApi
- getOrElseUpdate(String, Callable<T>) - Method in interface play.cache.SyncCacheApi
-
Retrieve a value from the cache, or set it from a default Callable function.
- getOrElseUpdate(String, Callable<T>) - Method in class play.cache.SyncCacheApiAdapter
- getOrElseUpdate(String, Callable<T>, int) - Method in class play.cache.DefaultSyncCacheApi
- getOrElseUpdate(String, Callable<T>, int) - Method in interface play.cache.SyncCacheApi
-
Retrieve a value from the cache, or set it from a default Callable function.
- getOrElseUpdate(String, Callable<T>, int) - Method in class play.cache.SyncCacheApiAdapter
- getParameterTypes() - Method in class play.routing.HandlerDef
- getPathPattern() - Method in class play.routing.Router.RouteDocumentation
- getProvider() - Method in class play.inject.ProviderConstructionTarget
- getProvider() - Method in class play.inject.ProviderTarget
- getQualifier() - Method in class play.inject.BindingKey
- getQueryParameters() - Method in class play.libs.ws.ahc.AhcWSRequest
- getQueryParameters() - Method in interface play.libs.ws.WSRequest
- getQueryString(String) - Method in interface play.mvc.Http.RequestHeader
-
Deprecated.Deprecated as of 2.8.0. Use
Http.RequestHeader.queryString(String)
instead. - getRef() - Method in class play.mvc.Http.MultipartFormData.FilePart
-
The File.
- getRequestHeader() - Method in class play.http.HandlerForRequest
- getRequestTimeout() - Method in class play.libs.ws.ahc.AhcWSRequest
- getRevision() - Method in class play.db.evolutions.Evolution
-
Get the revision of the evolution.
- getRunningHttpPort() - Method in class play.test.TestServer
-
The HTTP port that the server is running on.
- getRunningHttpsPort() - Method in class play.test.TestServer
-
The HTTPS port that the server is running on.
- getScope() - Method in class play.inject.Binding
- getSet(int) - Method in class play.libs.Time.CronExpression
- getSingleHeader(String) - Method in class play.libs.ws.ahc.AhcWSResponse
- getSingleHeader(String) - Method in interface play.libs.ws.WSResponse
- getSource() - Method in class play.inject.Binding
- getSource() - Method in class play.mvc.RangeResults.SourceAndOffset
- getSqlDown() - Method in class play.db.evolutions.Evolution
-
Get the SQL script for tearing the evolution down.
- getSqlUp() - Method in class play.db.evolutions.Evolution
-
Get the SQL script for bringing the evolution up.
- getStackFrames(Throwable) - Static method in class play.libs.exception.ExceptionUtils
-
Captures the stack trace associated with the specified
Throwable
object, decomposing it into a list of stack frames. - getStackTrace(Throwable) - Static method in class play.libs.exception.ExceptionUtils
-
Gets the stack trace from a Throwable as a String.
- getStandaloneWSClient() - Method in class play.libs.ws.ahc.AhcWSClient
-
Return the implementation interface of
StandaloneAhcWSClient
. - getStatus() - Method in class play.libs.ws.ahc.AhcWSResponse
- getStatus() - Method in interface play.libs.ws.WSResponse
- getStatusText() - Method in class play.libs.ws.ahc.AhcWSResponse
- getStatusText() - Method in interface play.libs.ws.WSResponse
- getTarget() - Method in class play.inject.Binding
- getTargetDatasource(ConnectionPoolDataSourceProxy) - Static method in class org.jdbcdslog.AccessConnectionPoolDataSourceProxy
- getTimeAfter(Date) - Method in class play.libs.Time.CronExpression
- getTimeBefore(Date) - Method in class play.libs.Time.CronExpression
-
NOT YET IMPLEMENTED: Returns the time before the given time that the
CronExpression
matches. - getTimeZone() - Method in class play.libs.Time.CronExpression
-
Returns the time zone for which this
CronExpression
will be resolved. - getUnderlying() - Method in class play.libs.ws.ahc.AhcWSClient
- getUnderlying() - Method in class play.libs.ws.ahc.AhcWSResponse
- getUnderlying() - Method in interface play.libs.ws.WSClient
-
The underlying implementation of the client, if any.
- getUnderlying() - Method in interface play.libs.ws.WSResponse
-
Gets the underlying implementation response object, if any.
- getUri() - Method in class play.libs.ws.ahc.AhcWSResponse
- getUrl() - Method in interface play.db.Database
- getUrl() - Method in class play.db.DefaultDatabase
- getUrl() - Method in class play.libs.ws.ahc.AhcWSRequest
- getUrl() - Method in interface play.libs.ws.WSRequest
- getUsername(Http.Request) - Method in class play.mvc.Security.Authenticator
-
Retrieves the username from the HTTP request; the default is to read from the session cookie.
- getValue() - Method in class play.mvc.Http.MultipartFormData.DataPart
- getValue(int, String, int) - Method in class play.libs.Time.CronExpression
- getWrappedApplication() - Method in interface play.Application
-
Deprecated.Use
Application.asScala()
instead. - getWrappedApplication() - Method in class play.DefaultApplication
-
Deprecated.
- globalError() - Method in class play.data.Form
-
Retrieves the first global error (an error without any key), if it exists.
- globalErrors() - Method in class play.data.Form
-
Retrieve all global errors - errors without a key.
- GONE - Static variable in interface play.mvc.Http.Status
- groups() - Method in annotation type play.data.validation.Constraints.Email
- groups() - Method in annotation type play.data.validation.Constraints.Max
- groups() - Method in annotation type play.data.validation.Constraints.MaxLength
- groups() - Method in annotation type play.data.validation.Constraints.Min
- groups() - Method in annotation type play.data.validation.Constraints.MinLength
- groups() - Method in annotation type play.data.validation.Constraints.Pattern
- groups() - Method in annotation type play.data.validation.Constraints.Required
- groups() - Method in annotation type play.data.validation.Constraints.Validate
- groups() - Method in annotation type play.data.validation.Constraints.ValidatePayloadWith
- groups() - Method in annotation type play.data.validation.Constraints.ValidateWith
- groups() - Method in annotation type play.data.validation.Constraints.ValidateWithPayload
- Guiceable - Class in play.inject.guice
- Guiceable() - Constructor for class play.inject.guice.Guiceable
- GuiceApplicationBuilder - Class in play.inject.guice
- GuiceApplicationBuilder() - Constructor for class play.inject.guice.GuiceApplicationBuilder
- GuiceApplicationLoader - Class in play.inject.guice
-
An ApplicationLoader that uses Guice to bootstrap the application.
- GuiceApplicationLoader() - Constructor for class play.inject.guice.GuiceApplicationLoader
- GuiceApplicationLoader(GuiceApplicationBuilder) - Constructor for class play.inject.guice.GuiceApplicationLoader
- GuiceBuilder<Self,Delegate extends play.api.inject.guice.GuiceBuilder<Delegate>> - Class in play.inject.guice
-
A builder for creating Guice-backed Play Injectors.
- GuiceBuilder(Delegate) - Constructor for class play.inject.guice.GuiceBuilder
- GuiceInjectorBuilder - Class in play.inject.guice
-
Default empty builder for creating Guice-backed Injectors.
- GuiceInjectorBuilder() - Constructor for class play.inject.guice.GuiceInjectorBuilder
- gzipFilter() - Method in interface play.filters.components.GzipFilterComponents
- GzipFilterComponents - Interface in play.filters.components
-
The GZIP filter Java components.
- gzipFilterConfig() - Method in interface play.filters.components.GzipFilterComponents
H
- handle(Http.RequestHeader, String) - Method in class play.filters.csrf.CSRFErrorHandler.DefaultCSRFErrorHandler
- handle(Http.RequestHeader, String) - Method in interface play.filters.csrf.CSRFErrorHandler
-
Handle the CSRF error.
- HANDLER_DEF - Static variable in class play.routing.Router.Attrs
-
Key for the
HandlerDef
used to handle the request. - HandlerDef - Class in play.routing
- HandlerDef() - Constructor for class play.routing.HandlerDef
- handlerForRequest(Http.RequestHeader) - Method in class play.http.DefaultHttpRequestHandler
- handlerForRequest(Http.RequestHeader) - Method in interface play.http.HttpRequestHandler
-
Get a handler for the given request.
- HandlerForRequest - Class in play.http
-
A request and a handler to handle it.
- HandlerForRequest(Http.RequestHeader, Handler) - Constructor for class play.http.HandlerForRequest
- handleWebCommand(Http.RequestHeader) - Method in class play.server.ApplicationProvider
-
Deprecated.Deprecated as of 2.7.0. WebCommands are now handled by the DefaultHttpRequestHandler.
- hasBody() - Method in interface play.mvc.Http.RequestHeader
- hasErrors() - Method in class play.data.Form
- hasGlobalErrors() - Method in class play.data.Form
- hashCode() - Method in class play.cache.NamedCacheImpl
- hashCode() - Method in class play.core.cookie.encoding.DefaultCookie
- hashCode() - Method in class play.db.evolutions.Evolution
- hashCode() - Method in class play.db.NamedDatabaseImpl
- hashCode() - Method in class play.http.websocket.Message.Binary
- hashCode() - Method in class play.http.websocket.Message.Close
- hashCode() - Method in class play.http.websocket.Message.Ping
- hashCode() - Method in class play.http.websocket.Message.Pong
- hashCode() - Method in class play.http.websocket.Message.Text
- hashCode() - Method in class play.inject.NamedImpl
- hashCode() - Method in class play.libs.F.Tuple
- hashCode() - Method in class play.libs.F.Tuple3
- hashCode() - Method in class play.libs.F.Tuple4
- hashCode() - Method in class play.libs.F.Tuple5
- hashCode() - Method in class play.libs.typedmap.TypedKey
- hasHeader(String) - Method in interface play.mvc.Http.RequestHeader
-
Checks if the request has the header.
- head() - Method in class play.libs.ws.ahc.AhcWSRequest
- head() - Method in interface play.libs.ws.WSRequest
-
Perform a HEAD on the request asynchronously.
- HEAD - Static variable in interface play.mvc.Http.HttpVerbs
- HEAD - Static variable in class play.test.Helpers
- HEAD(String) - Method in class play.routing.RoutingDsl
-
Create a HEAD route for the given path pattern.
- header(String) - Method in interface play.mvc.Http.RequestHeader
-
Retrieves a single header.
- header(String) - Method in class play.mvc.Result
-
Extracts an Header value of this Result value.
- header(String, String) - Method in class play.mvc.Http.RequestBuilder
- header(String, List<String>) - Method in class play.mvc.Http.RequestBuilder
- headers() - Method in class play.mvc.Http.RequestBuilder
- headers() - Method in interface play.mvc.Http.RequestHeader
-
Retrieve all headers.
- headers() - Method in class play.mvc.ResponseHeader
- headers() - Method in class play.mvc.Result
-
Extracts all Headers of this Result value.
- headers(Http.Headers) - Method in class play.mvc.Http.RequestBuilder
-
Set the headers to be used by the request builder.
- Headers(Map<String, List<String>>) - Constructor for class play.mvc.Http.Headers
- Helpers - Class in play.test
-
Helper functions to run tests.
- Helpers() - Constructor for class play.test.Helpers
- HikariCPComponents - Interface in play.db
-
HikariCP Java components (for compile-time injection).
- host() - Method in class play.mvc.Http.RequestBuilder
- host() - Method in interface play.mvc.Http.RequestHeader
- host(String) - Method in class play.mvc.Http.RequestBuilder
- HOST - Static variable in interface play.mvc.Http.HeaderNames
- HOUR - Static variable in class play.libs.Time.CronExpression
- hours - Variable in class play.libs.Time.CronExpression
- HTML - Static variable in interface play.mvc.Http.MimeTypes
-
Content-Type of html.
- HtmlOrJsonHttpErrorHandler - Class in play.http
-
An HttpErrorHandler that uses either HTML or JSON in the response depending on the client's preference.
- HtmlOrJsonHttpErrorHandler(DefaultHttpErrorHandler, JsonHttpErrorHandler) - Constructor for class play.http.HtmlOrJsonHttpErrorHandler
- HTMLUNIT - Static variable in class play.test.Helpers
- http(int) - Method in class play.server.Server.Builder
-
Instruct the server to serve HTTP on a particular port.
- Http - Class in play.mvc
-
Defines HTTP standard objects.
- Http() - Constructor for class play.mvc.Http
- HTTP - play.server.Server.Protocol
- HTTP_ERROR_INFO - Static variable in class play.http.HttpErrorHandler.Attrs
- HTTP_VERSION_NOT_SUPPORTED - Static variable in interface play.mvc.Http.Status
- Http.Cookie - Class in play.mvc
-
HTTP Cookie
- Http.Cookie.SameSite - Enum in play.mvc
-
The cookie SameSite attribute
- Http.CookieBuilder - Class in play.mvc
- Http.Cookies - Interface in play.mvc
-
HTTP Cookies set
- Http.Flash - Class in play.mvc
-
HTTP Flash.
- Http.HeaderNames - Interface in play.mvc
-
Defines all standard HTTP headers.
- Http.Headers - Class in play.mvc
- Http.HttpVerbs - Interface in play.mvc
-
Standard HTTP Verbs
- Http.MimeTypes - Interface in play.mvc
-
Common HTTP MIME types
- Http.MultipartFormData<A> - Class in play.mvc
-
Multipart form data body.
- Http.MultipartFormData.DataPart - Class in play.mvc
- Http.MultipartFormData.FileInfo - Class in play.mvc
-
Info about a file part
- Http.MultipartFormData.FilePart<A> - Class in play.mvc
-
A file part.
- Http.MultipartFormData.Part<A> - Interface in play.mvc
- Http.RawBuffer - Class in play.mvc
-
Handle the request body a raw bytes data.
- Http.Request - Interface in play.mvc
-
An HTTP request.
- Http.RequestBody - Class in play.mvc
-
The request body.
- Http.RequestBuilder - Class in play.mvc
-
The builder for building a request.
- Http.RequestHeader - Interface in play.mvc
- Http.RequestImpl - Class in play.mvc
-
An HTTP request.
- Http.Session - Class in play.mvc
-
HTTP Session.
- Http.Status - Interface in play.mvc
-
Defines all standard HTTP status codes.
- HttpComponents - Interface in play.components
- httpConfiguration() - Method in interface play.BuiltInComponents
- httpConfiguration() - Method in interface play.components.HttpConfigurationComponents
- httpConfiguration() - Method in class play.core.j.MappedJavaHandlerComponents
- HttpConfigurationComponents - Interface in play.components
-
Http Configuration Java Components.
- HttpEntity - Class in play.http
-
An HTTP entity
- HttpEntity.Chunked - Class in play.http
-
A chunked entity, backed by a source of chunks.
- HttpEntity.Streamed - Class in play.http
-
A streamed entity, backed by a source.
- HttpEntity.Strict - Class in play.http
-
A strict entity, where all the data for it is in memory.
- httpErrorHandler() - Method in interface play.components.HttpErrorHandlerComponents
- httpErrorHandler() - Method in class play.ContextBasedBuiltInComponents
- HttpErrorHandler - Interface in play.http
-
Component for handling HTTP errors in Play.
- HttpErrorHandler.Attrs - Class in play.http
-
Request attributes used by the error handler.
- HttpErrorHandlerComponents - Interface in play.components
-
The HTTP Error handler Java Components.
- HttpErrorInfo - Class in play.http
-
Used as request attribute which gets attached to the request that gets passed to an error handler.
- HttpErrorInfo() - Constructor for class play.http.HttpErrorInfo
- HttpExecution - Class in play.libs.concurrent
-
Deprecated.Deprecated as of 2.9.0. Renamed to
ClassLoaderExecution
. - HttpExecution() - Constructor for class play.libs.concurrent.HttpExecution
-
Deprecated.
- HttpExecutionContext - Class in play.libs.concurrent
-
Deprecated.Deprecated as of 2.9.0. Renamed to
ClassLoaderExecutionContext
. - HttpExecutionContext(Executor) - Constructor for class play.libs.concurrent.HttpExecutionContext
-
Deprecated.Deprecated as of 2.9.0. Use to
ClassLoaderExecutionContext
instead. - httpFilters() - Method in interface play.components.HttpComponents
-
List of filters, typically provided by mixing in play.filters.HttpFiltersComponents or play.api.NoHttpFiltersComponents.
- httpFilters() - Method in interface play.filters.components.HttpFiltersComponents
- httpFilters() - Method in interface play.filters.components.NoHttpFiltersComponents
- HttpFilters - Interface in play.http
-
Provides filters to the HttpRequestHandler.
- HttpFiltersComponents - Interface in play.filters.components
-
A compile time default filters components.
- httpOnly() - Method in class play.mvc.Http.Cookie
- httpPort() - Method in class play.server.Server
-
Get the HTTP port the server is running on.
- httpRequestHandler() - Method in interface play.components.HttpComponents
- httpRequestHandler() - Method in class play.ContextBasedBuiltInComponents
- HttpRequestHandler - Interface in play.http
-
An HTTP request handler
- https(int) - Method in class play.server.Server.Builder
-
Configure the server to serve HTTPS on a particular port.
- HTTPS - play.server.Server.Protocol
- httpsPort() - Method in class play.server.Server
-
Get the HTTPS port the server is running on.
I
- I18nComponents - Interface in play.i18n
-
Java I18n components.
- id() - Method in class play.libs.openid.UserInfo
- id() - Method in class play.mvc.Http.RequestBuilder
- id() - Method in interface play.mvc.Http.RequestHeader
-
The request id.
- id(Long) - Method in class play.mvc.Http.RequestBuilder
- IF_MATCH - Static variable in interface play.mvc.Http.HeaderNames
- IF_MODIFIED_SINCE - Static variable in interface play.mvc.Http.HeaderNames
- IF_NONE_MATCH - Static variable in interface play.mvc.Http.HeaderNames
- IF_RANGE - Static variable in interface play.mvc.Http.HeaderNames
- IF_UNMODIFIED_SINCE - Static variable in interface play.mvc.Http.HeaderNames
- IM_A_TEAPOT - Static variable in interface play.mvc.Http.Status
- in(File) - Method in class play.inject.guice.GuiceBuilder
-
Set the environment path.
- in(Class<A>) - Method in class play.inject.Binding
-
Configure the scope for this binding.
- in(ClassLoader) - Method in class play.inject.guice.GuiceBuilder
-
Set the environment class loader.
- in(Environment) - Method in class play.inject.guice.GuiceBuilder
-
Set the environment.
- in(Mode) - Method in class play.inject.guice.GuiceBuilder
-
Set the environment mode.
- indexes() - Method in class play.data.Form.Field
- info(String) - Method in class play.Logger.ALogger
-
Logs a message with the INFO level.
- info(String) - Static method in class play.Logger
-
Deprecated.Deprecated as of 2.7.0. Create an instance of
Logger.ALogger
viaLogger.of(String)
/Logger.of(Class)
and use the same-named method. Or use SLF4J directly. - info(String, Object...) - Method in class play.Logger.ALogger
-
Logs a message with the INFO level.
- info(String, Object...) - Static method in class play.Logger
-
Deprecated.Deprecated as of 2.7.0. Create an instance of
Logger.ALogger
viaLogger.of(String)
/Logger.of(Class)
and use the same-named method. Or use SLF4J directly. - info(String, Throwable) - Method in class play.Logger.ALogger
-
Logs a message with the INFO level, with the given error.
- info(String, Throwable) - Static method in class play.Logger
-
Deprecated.Deprecated as of 2.7.0. Create an instance of
Logger.ALogger
viaLogger.of(String)
/Logger.of(Class)
and use the same-named method. Or use SLF4J directly. - info(String, Supplier<?>...) - Method in class play.Logger.ALogger
-
Log a message with the INFO level.
- info(String, Supplier<?>...) - Static method in class play.Logger
-
Deprecated.Deprecated as of 2.7.0. Create an instance of
Logger.ALogger
viaLogger.of(String)
/Logger.of(Class)
and use the same-named method. Or use SLF4J directly. - info(Supplier<String>) - Method in class play.Logger.ALogger
-
Log a message with the INFO level.
- info(Supplier<String>) - Static method in class play.Logger
-
Deprecated.Deprecated as of 2.7.0. Create an instance of
Logger.ALogger
viaLogger.of(String)
/Logger.of(Class)
and use the same-named method. Or use SLF4J directly. - info(Marker, String) - Method in class play.Logger.ALogger
-
Logs a message with the INFO level.
- info(Marker, String, Object...) - Method in class play.Logger.ALogger
-
Logs a message with the INFO level.
- info(Marker, String, Throwable) - Method in class play.Logger.ALogger
-
Logs a message with the INFO level, with the given error.
- init(File, Mode) - Method in interface play.LoggerConfigurator
- init(File, Mode) - Method in interface play.LoggerConfigurator
-
Initialize the Logger when there's no application ClassLoader available.
- initialBuilder - Variable in class play.inject.guice.GuiceApplicationLoader
-
The initial builder to start construction from.
- initialConfig() - Method in class play.ApplicationLoader.Context
-
Get the configuration from the context.
- initialize(Constraints.Email) - Method in class play.data.validation.Constraints.EmailValidator
- initialize(Constraints.Max) - Method in class play.data.validation.Constraints.MaxValidator
- initialize(Constraints.MaxLength) - Method in class play.data.validation.Constraints.MaxLengthValidator
- initialize(Constraints.Min) - Method in class play.data.validation.Constraints.MinValidator
- initialize(Constraints.MinLength) - Method in class play.data.validation.Constraints.MinLengthValidator
- initialize(Constraints.Pattern) - Method in class play.data.validation.Constraints.PatternValidator
- initialize(Constraints.Required) - Method in class play.data.validation.Constraints.RequiredValidator
- initialize(Constraints.Validate) - Method in class play.data.validation.Constraints.ValidateValidator
- initialize(Constraints.ValidatePayloadWith) - Method in class play.data.validation.Constraints.ValidatePayloadWithValidator
- initialize(Constraints.ValidateWith) - Method in class play.data.validation.Constraints.ValidateWithValidator
- initialize(Constraints.ValidateWithPayload) - Method in class play.data.validation.Constraints.ValidateValidatorWithPayload
- InjectedActorSupport - Interface in play.libs.pekko
-
Support for creating injected child actors.
- injectedChild(Supplier<Actor>, String) - Method in interface play.libs.pekko.InjectedActorSupport
-
Create an injected child actor.
- injectedChild(Supplier<Actor>, String, Function<Props, Props>) - Method in interface play.libs.pekko.InjectedActorSupport
-
Create an injected child actor.
- injector - Variable in class play.inject.DelegateInjector
- injector() - Method in interface play.Application
-
Get the runtime injector for this application.
- injector() - Method in class play.DefaultApplication
-
Get the injector for this application.
- injector() - Method in class play.inject.guice.GuiceBuilder
-
Create a Play Injector backed by Guice using this configured builder.
- Injector - Interface in play.inject
-
An injector, capable of providing components.
- inMemory() - Static method in class play.db.Databases
-
Create an in-memory H2 database with name "default".
- inMemory(String) - Static method in class play.db.Databases
-
Create an in-memory H2 database.
- inMemory(String, String, Map<String, ? extends Object>) - Static method in class play.db.Databases
-
Create an in-memory H2 database.
- inMemory(String, Map<String, ? extends Object>) - Static method in class play.db.Databases
-
Create an in-memory H2 database.
- inMemory(String, Map<String, String>, Map<String, ? extends Object>) - Static method in class play.db.Databases
-
Create an in-memory H2 database.
- inMemory(Map<String, ? extends Object>) - Static method in class play.db.Databases
-
Create an in-memory H2 database with name "default".
- inMemoryDatabase() - Static method in class play.test.Helpers
-
Constructs a in-memory (h2) database configuration to add to a fake application.
- inMemoryDatabase(String) - Static method in class play.test.Helpers
-
Constructs a in-memory (h2) database configuration to add to a fake application.
- inMemoryDatabase(String, Map<String, String>) - Static method in class play.test.Helpers
-
Constructs a in-memory (h2) database configuration to add to a fake application.
- inMemoryWith(String, Object) - Static method in class play.db.Databases
-
Create an in-memory H2 database with name "default" and with extra configuration provided by the given entries.
- inMemoryWith(String, Object, String, Object) - Static method in class play.db.Databases
-
Create an in-memory H2 database with name "default" and with extra configuration provided by the given entries.
- inMemoryWith(String, Object, String, Object, String, Object) - Static method in class play.db.Databases
-
Create an in-memory H2 database with name "default" and with extra configuration provided by the given entries.
- instance - Static variable in interface play.libs.ws.WSBodyReadables
- instanceOf(Class<T>) - Method in class play.inject.DelegateInjector
- instanceOf(Class<T>) - Method in interface play.inject.Injector
-
Get an instance of the given class from the injector.
- instanceOf(Class<T>) - Method in class play.test.WithApplication
-
Provides an instance from the application.
- instanceOf(BindingKey<T>) - Method in class play.inject.DelegateInjector
- instanceOf(BindingKey<T>) - Method in interface play.inject.Injector
-
Get an instance of the given class from the injector.
- INSUFFICIENT_STORAGE - Static variable in interface play.mvc.Http.Status
- INTERNAL_SERVER_ERROR - Static variable in interface play.mvc.Http.Status
- internalServerError() - Static method in class play.mvc.Results
-
Generates a 500 Internal Server Error result.
- internalServerError(byte[]) - Static method in class play.mvc.Results
-
Generates a 500 Internal Server Error result.
- internalServerError(JsonNode) - Static method in class play.mvc.Results
-
Generates a 500 Internal Server Error result.
- internalServerError(JsonNode, JsonEncoding) - Static method in class play.mvc.Results
-
Generates a 500 Internal Server Error result.
- internalServerError(File) - Static method in class play.mvc.Results
-
Generates a 500 Internal Server Error result.
- internalServerError(File, boolean) - Static method in class play.mvc.Results
-
Generates a 500 Internal Server Error result.
- internalServerError(File, boolean, Optional<String>) - Static method in class play.mvc.Results
-
Generates a 500 Internal Server Error result.
- internalServerError(File, boolean, Optional<String>, FileMimeTypes) - Static method in class play.mvc.Results
-
Generates a 500 Internal Server Error result.
- internalServerError(File, boolean, FileMimeTypes) - Static method in class play.mvc.Results
-
Generates a 500 Internal Server Error result.
- internalServerError(File, String) - Static method in class play.mvc.Results
-
Deprecated.Deprecated as of 2.8.0. Use to
Results.internalServerError(File, Optional)
. - internalServerError(File, String, FileMimeTypes) - Static method in class play.mvc.Results
-
Deprecated.Deprecated as of 2.8.0. Use to
Results.internalServerError(File, Optional, FileMimeTypes)
. - internalServerError(File, Optional<String>) - Static method in class play.mvc.Results
-
Generates a 500 Internal Server Error result.
- internalServerError(File, Optional<String>, FileMimeTypes) - Static method in class play.mvc.Results
-
Generates a 500 Internal Server Error result.
- internalServerError(File, FileMimeTypes) - Static method in class play.mvc.Results
-
Generates a 500 Internal Server Error result.
- internalServerError(InputStream) - Static method in class play.mvc.Results
-
Generates a 500 Internal Server Error result.
- internalServerError(InputStream, long) - Static method in class play.mvc.Results
-
Generates a 500 Internal Server Error result.
- internalServerError(String) - Static method in class play.mvc.Results
-
Generates a 500 Internal Server Error result.
- internalServerError(String, String) - Static method in class play.mvc.Results
-
Generates a 500 Internal Server Error result.
- internalServerError(Path) - Static method in class play.mvc.Results
-
Generates a 500 Internal Server Error result.
- internalServerError(Path, boolean) - Static method in class play.mvc.Results
-
Generates a 500 Internal Server Error result.
- internalServerError(Path, boolean, Optional<String>) - Static method in class play.mvc.Results
-
Generates a 500 Internal Server Error result.
- internalServerError(Path, boolean, Optional<String>, FileMimeTypes) - Static method in class play.mvc.Results
-
Generates a 500 Internal Server Error result.
- internalServerError(Path, boolean, FileMimeTypes) - Static method in class play.mvc.Results
-
Generates a 500 Internal Server Error result.
- internalServerError(Path, Optional<String>) - Static method in class play.mvc.Results
-
Generates a 500 Internal Server Error result.
- internalServerError(Path, Optional<String>, FileMimeTypes) - Static method in class play.mvc.Results
-
Generates a 500 Internal Server Error result.
- internalServerError(Path, FileMimeTypes) - Static method in class play.mvc.Results
-
Generates a 500 Internal Server Error result.
- internalServerError(Content) - Static method in class play.mvc.Results
-
Generates a 500 Internal Server Error result.
- internalServerError(Content, String) - Static method in class play.mvc.Results
-
Generates a 500 Internal Server Error result.
- ipFilter() - Method in interface play.filters.components.IPFilterComponents
- IPFilterComponents - Interface in play.filters.components
-
The IP filter components for compile time dependency injection.
- ipFilterConfig() - Method in interface play.filters.components.IPFilterComponents
- isDebugEnabled() - Method in class play.Logger.ALogger
-
Returns
true
if the logger instance has DEBUG level logging enabled. - isDebugEnabled() - Static method in class play.Logger
-
Deprecated.Deprecated as of 2.7.0. Create an instance of
Logger.ALogger
viaLogger.of(String)
/Logger.of(Class)
and use the same-named method. Or use SLF4J directly. - isDebugEnabled(Marker) - Method in class play.Logger.ALogger
-
Similar to
Logger.ALogger.isDebugEnabled()
method except that the marker data is also taken into account. - isDefinedAt(String) - Method in interface play.i18n.Messages
-
Check if a message key is defined.
- isDefinedAt(String) - Method in class play.i18n.MessagesImpl
-
Check if a message key is defined.
- isDefinedAt(Lang, String) - Method in class play.i18n.MessagesApi
-
Check if a message key is defined.
- isDev() - Method in interface play.Application
-
Check whether the application is in
Mode.DEV
mode. - isDev() - Method in class play.Environment
-
Returns `true` if the application is `DEV` mode.
- isEmpty() - Method in class play.mvc.Http.MultipartFormData
- isErrorEnabled() - Method in class play.Logger.ALogger
-
Returns
true
if the logger instance has ERROR level logging enabled. - isErrorEnabled() - Static method in class play.Logger
-
Deprecated.Deprecated as of 2.7.0. Create an instance of
Logger.ALogger
viaLogger.of(String)
/Logger.of(Class)
and use the same-named method. Or use SLF4J directly. - isErrorEnabled(Marker) - Method in class play.Logger.ALogger
-
Similar to
Logger.ALogger.isErrorEnabled()
method except that the marker data is also taken into consideration. - isHttpOnly() - Method in interface play.core.cookie.encoding.Cookie
-
Checks to see if this
Cookie
can only be accessed via HTTP. - isHttpOnly() - Method in class play.core.cookie.encoding.DefaultCookie
- isInfoEnabled() - Method in class play.Logger.ALogger
-
Returns
true
if the logger instance has INFO level logging enabled. - isInfoEnabled() - Static method in class play.Logger
-
Deprecated.Deprecated as of 2.7.0. Create an instance of
Logger.ALogger
viaLogger.of(String)
/Logger.of(Class)
and use the same-named method. Or use SLF4J directly. - isInfoEnabled(Marker) - Method in class play.Logger.ALogger
-
Similar to
Logger.ALogger.isInfoEnabled()
method except that the marker data is also taken into consideration. - isKnownEmpty() - Method in class play.http.HttpEntity.Chunked
- isKnownEmpty() - Method in class play.http.HttpEntity
- isKnownEmpty() - Method in class play.http.HttpEntity.Streamed
- isKnownEmpty() - Method in class play.http.HttpEntity.Strict
- isLeapYear(int) - Method in class play.libs.Time.CronExpression
- isProd() - Method in interface play.Application
-
Check whether the application is in
Mode.PROD
mode. - isProd() - Method in class play.Environment
-
Returns `true` if the application is `PROD` mode.
- isSatisfiedBy(Date) - Method in class play.libs.Time.CronExpression
-
Indicates whether the given date satisfies the cron expression.
- isSecure() - Method in interface play.core.cookie.encoding.Cookie
-
Checks to see if this
Cookie
is secure - isSecure() - Method in class play.core.cookie.encoding.DefaultCookie
- isTest() - Method in interface play.Application
-
Check whether the application is in
Mode.TEST
mode. - isTest() - Method in class play.Environment
-
Returns `true` if the application is `TEST` mode.
- isTraceEnabled() - Method in class play.Logger.ALogger
-
Returns
true
if the logger instance has TRACE level logging enabled. - isTraceEnabled() - Static method in class play.Logger
-
Deprecated.Deprecated as of 2.7.0. Create an instance of
Logger.ALogger
viaLogger.of(String)
/Logger.of(Class)
and use the same-named method. Or use SLF4J directly. - isTraceEnabled(Marker) - Method in class play.Logger.ALogger
-
Similar to
Logger.ALogger.isTraceEnabled()
method except that the marker data is also taken into account. - isValid(Number) - Method in class play.data.validation.Constraints.MaxValidator
- isValid(Number) - Method in class play.data.validation.Constraints.MinValidator
- isValid(Object) - Method in class play.data.validation.Constraints.RequiredValidator
- isValid(Object) - Method in class play.data.validation.Constraints.ValidateWithValidator
- isValid(Object, Constraints.ValidationPayload) - Method in class play.data.validation.Constraints.ValidatePayloadWithValidator
- isValid(String) - Method in class play.data.validation.Constraints.EmailValidator
- isValid(String) - Method in class play.data.validation.Constraints.MaxLengthValidator
- isValid(String) - Method in class play.data.validation.Constraints.MinLengthValidator
- isValid(String) - Method in class play.data.validation.Constraints.PatternValidator
- isValid(Constraints.Validatable<?>, ConstraintValidatorContext) - Method in class play.data.validation.Constraints.ValidateValidator
- isValid(Constraints.ValidatableWithPayload<?>, Constraints.ValidationPayload, ConstraintValidatorContext) - Method in class play.data.validation.Constraints.ValidateValidatorWithPayload
- isValid(T) - Method in class play.data.validation.Constraints.Validator
- isValid(T, ConstraintValidatorContext) - Method in interface play.data.validation.Constraints.PlayConstraintValidatorWithPayload
- isValid(T, ConstraintValidatorContext) - Method in class play.data.validation.Constraints.Validator
- isValid(T, ConstraintValidatorContext) - Method in class play.data.validation.Constraints.ValidatorWithPayload
- isValid(T, Constraints.ValidationPayload) - Method in class play.data.validation.Constraints.ValidatorWithPayload
- isValid(T, Constraints.ValidationPayload, ConstraintValidatorContext) - Method in interface play.data.validation.Constraints.PlayConstraintValidatorWithPayload
- isValidExpression(String) - Static method in class play.libs.Time.CronExpression
-
Indicates whether the specified cron expression can be parsed into a valid cron expression
- isWarnEnabled() - Method in class play.Logger.ALogger
-
Returns
true
if the logger instance has WARN level logging enabled. - isWarnEnabled() - Static method in class play.Logger
-
Deprecated.Deprecated as of 2.7.0. Create an instance of
Logger.ALogger
viaLogger.of(String)
/Logger.of(Class)
and use the same-named method. Or use SLF4J directly. - isWarnEnabled(Marker) - Method in class play.Logger.ALogger
-
Similar to
Logger.ALogger.isWarnEnabled()
method except that the marker data is also taken into consideration.
J
- javaContextComponents() - Method in interface play.BuiltInComponents
-
Deprecated.
- javaContextComponents() - Method in interface play.components.HttpErrorHandlerComponents
-
Deprecated.Deprecated as of 2.8.0. Use the corresponding methods that provide MessagesApi, Langs, FileMimeTypes or HttpConfiguration.
- javaHandlerComponents() - Method in interface play.components.HttpComponents
- javaHandlerComponents() - Method in class play.ContextBasedBuiltInComponents
- JAVASCRIPT - Static variable in interface play.mvc.Http.MimeTypes
-
Content-Type of javascript.
- JavaScriptReverseRouter - Class in play.routing
-
Helpers for creating JavaScript reverse routers
- JavaScriptReverseRouter() - Constructor for class play.routing.JavaScriptReverseRouter
- javascriptUnbind() - Method in interface play.mvc.PathBindable
-
Javascript function to unbind in the Javascript router.
- javascriptUnbind() - Method in interface play.mvc.QueryStringBindable
-
Javascript function to unbind in the Javascript router.
- JCacheComponents - Interface in play.libs.jcache
-
JCache components
- jpaApi() - Method in interface play.db.jpa.JPAComponents
- JPAApi - Interface in play.db.jpa
-
JPA API.
- JPAApiProvider(JPAConfig, ApplicationLifecycle, DBApi) - Constructor for class play.db.jpa.DefaultJPAApi.JPAApiProvider
- JPAApiProvider(JPAConfig, ApplicationLifecycle, DBApi, Config) - Constructor for class play.db.jpa.DefaultJPAApi.JPAApiProvider
-
Deprecated.Deprecated as of 2.8.0. Use
JPAApiProvider(JPAConfig, ApplicationLifecycle, DBApi)
instead. - JPAComponents - Interface in play.db.jpa
-
Java JPA Components.
- jpaConfig() - Method in interface play.db.jpa.JPAComponents
- JPAConfig - Interface in play.db.jpa
-
JPA configuration.
- JPAConfig.PersistenceUnit - Class in play.db.jpa
- JPAConfigProvider(Config) - Constructor for class play.db.jpa.DefaultJPAConfig.JPAConfigProvider
- JPAModule - Class in play.db.jpa
-
Injection module with default JPA components.
- JPAModule() - Constructor for class play.db.jpa.JPAModule
- json(Class<In>) - Static method in class play.mvc.WebSocket
-
Acceptor for JSON WebSockets.
- json(String) - Static method in class play.libs.Comet
-
Produces a flow of ByteString using `Json.stringify` from a Flow of JsonNode.
- json(String, String) - Static method in class play.libs.Comet
-
Produces a flow of ByteString using `Json.stringify` from a Flow of JsonNode.
- Json - Class in play.libs
-
Helper functions to handle JsonNode values.
- Json - Static variable in class play.mvc.WebSocket
-
Acceptor for JSON WebSockets.
- Json() - Constructor for class play.libs.Json
- Json(long, HttpErrorHandler) - Constructor for class play.mvc.BodyParser.Json
- Json(HttpConfiguration, HttpErrorHandler) - Constructor for class play.mvc.BodyParser.Json
- JSON - Static variable in interface play.mvc.Http.MimeTypes
-
Content-Type of json.
- jsonBodyParser() - Method in interface play.components.BodyParserComponents
- JsonHttpErrorHandler - Class in play.http
-
An alternative default HTTP error handler which will render errors as JSON messages instead of HTML pages.
- JsonHttpErrorHandler(Environment, OptionalSourceMapper) - Constructor for class play.http.JsonHttpErrorHandler
- jsonp(String, JsonNode) - Static method in class play.libs.Jsonp
- Jsonp - Class in play.libs
-
The JSONP Content renders a JavaScript call of a JSON object.
Example of use, provided the following route definition: - Jsonp(String, JsonNode) - Constructor for class play.libs.Jsonp
K
- key() - Method in annotation type play.cache.Cached
-
The cache key to store the result in
- key() - Method in class play.data.validation.ValidationError
-
Returns the error key.
- key() - Method in class play.libs.typedmap.TypedEntry
L
- lang() - Method in class play.data.Form
- lang() - Method in interface play.i18n.Messages
-
Get the lang for these messages.
- lang() - Method in class play.i18n.MessagesImpl
- Lang - Class in play.i18n
-
A Lang supported by the application.
- Lang(Locale) - Constructor for class play.i18n.Lang
- Lang(Lang) - Constructor for class play.i18n.Lang
- langCookie(Locale, MessagesApi) - Method in class play.mvc.Http.RequestBuilder
-
Sets given lang in a cookie.
- langCookie(Lang, MessagesApi) - Method in class play.mvc.Http.RequestBuilder
-
Sets given lang in a cookie.
- langCookieHttpOnly() - Method in class play.i18n.MessagesApi
-
Whether the HTTP only attribute of the cookie should be set to true or not.
- langCookieMaxAge() - Method in class play.i18n.MessagesApi
-
An optional max age in seconds for the language Cookie.
- langCookieName() - Method in class play.i18n.MessagesApi
-
Name for the language Cookie.
- langCookieSameSite() - Method in class play.i18n.MessagesApi
-
The value of the [[SameSite]] attribute of the cookie.
- langCookieSecure() - Method in class play.i18n.MessagesApi
-
Whether the secure attribute of the cookie is true or not.
- langs() - Method in class play.ContextBasedBuiltInComponents
- langs() - Method in interface play.data.validation.ValidatorsComponents
- langs() - Method in interface play.i18n.I18nComponents
- Langs - Class in play.i18n
-
Manages languages in Play
- Langs(Langs) - Constructor for class play.i18n.Langs
- language() - Method in class play.i18n.Lang
-
A valid ISO Language Code.
- LAST_MODIFIED - Static variable in interface play.mvc.Http.HeaderNames
- lastdayOfMonth - Variable in class play.libs.Time.CronExpression
- lastdayOfWeek - Variable in class play.libs.Time.CronExpression
- LAX - play.mvc.Http.Cookie.SameSite
- LAX - Static variable in class play.core.cookie.encoding.ClientCookieDecoder
-
Lax instance that doesn't validate name and value
- LAX - Static variable in class play.core.cookie.encoding.ClientCookieEncoder
-
Lax instance that doesn't validate name and value
- LAX - Static variable in class play.core.cookie.encoding.ServerCookieDecoder
-
Lax instance that doesn't validate name and value
- LAX - Static variable in class play.core.cookie.encoding.ServerCookieEncoder
-
Lax instance that doesn't validate name and value
- lazy(Supplier<T>) - Static method in class play.libs.F.LazySupplier
- left - Variable in class play.libs.F.Either
-
The left value.
- Left(L) - Static method in class play.libs.F.Either
-
Constructs a left side of the disjoint union, as opposed to the Right side.
- LENGTH_REQUIRED - Static variable in interface play.mvc.Http.Status
- LINK - Static variable in interface play.mvc.Http.HeaderNames
- load(Module...) - Method in class play.inject.guice.GuiceApplicationBuilder
-
Override the module loader with the given Guice modules.
- load(Binding<?>...) - Method in class play.inject.guice.GuiceApplicationBuilder
-
Override the module loader with the given Play bindings.
- load(GuiceableModule...) - Method in class play.inject.guice.GuiceApplicationBuilder
-
Override the module loader with the given guiceable modules.
- load(Module...) - Method in class play.inject.guice.GuiceApplicationBuilder
-
Override the module loader with the given Play modules.
- load(ApplicationLoader.Context) - Method in interface play.ApplicationLoader
-
Load an application given the context.
- load(ApplicationLoader.Context) - Method in class play.inject.guice.GuiceApplicationLoader
- loadConfig(Config) - Method in class play.inject.guice.GuiceApplicationBuilder
-
Set the initial configuration.
- LOCATION - Static variable in interface play.mvc.Http.HeaderNames
- LOCKED - Static variable in interface play.mvc.Http.Status
- logger - Variable in class play.data.Form
- Logger - Class in play
-
High level API for logging operations.
- Logger() - Constructor for class play.Logger
- Logger.ALogger - Class in play
-
Typical logger interface
- LoggerConfigurator - Interface in play
-
Runs through underlying logger configuration.
- loggerFactory() - Method in interface play.LoggerConfigurator
-
Returns the logger factory for the configurator.
- logServerError(Http.RequestHeader, UsefulException) - Method in class play.http.DefaultHttpErrorHandler
-
Responsible for logging server errors.
- logServerError(Http.RequestHeader, UsefulException) - Method in class play.http.JsonHttpErrorHandler
-
Responsible for logging server errors.
M
- mainAddress() - Method in class play.server.Server
-
Get the address the server is running on.
- manage() - Method in class play.test.TestBrowser
-
Retrieves the underlying option interface that can be used to set cookies, manage timeouts among other things.
- map(Function<? super A, ? extends B>, Executor) - Method in class play.libs.streams.Accumulator
-
Map the accumulated value.
- mapFuture(Function<? super A, ? extends CompletionStage<B>>, Executor) - Method in class play.libs.streams.Accumulator
-
Map the accumulated value with a function that returns a future.
- MappedConstraintValidatorFactory - Class in play.data.validation
-
ConstraintValidatorFactory to be used with compile-time Dependency Injection.
- MappedConstraintValidatorFactory() - Constructor for class play.data.validation.MappedConstraintValidatorFactory
- MappedJavaHandlerComponents - Class in play.core.j
-
The components necessary to handle a Java handler.
- MappedJavaHandlerComponents(ActionCreator, HttpConfiguration, ExecutionContext) - Constructor for class play.core.j.MappedJavaHandlerComponents
- MappedJavaHandlerComponents(ActionCreator, HttpConfiguration, ExecutionContext, JavaContextComponents) - Constructor for class play.core.j.MappedJavaHandlerComponents
-
Deprecated.Deprecated as of 2.8.0. Use constructor without JavaContextComponents
- MappedWebSocketAcceptor(PartialFunction<Message, F.Either<In, Message>>, Function<Out, Message>) - Constructor for class play.mvc.WebSocket.MappedWebSocketAcceptor
- mapper() - Static method in class play.libs.Json
-
Gets the ObjectMapper used to serialize and deserialize objects to and from JSON values.
- mat - Variable in class play.test.WithApplication
-
The application's Pekko streams Materializer.
- match(String, String) - Method in class play.routing.RoutingDsl
-
Create a route for the given method and path pattern.
- materializer - Variable in class play.mvc.Filter
- materializer() - Method in interface play.components.PekkoComponents
- max(long) - Static method in class play.data.validation.Constraints
-
Constructs a 'max' validator.
- MAX_FORWARDS - Static variable in interface play.mvc.Http.HeaderNames
- maxAge() - Method in interface play.core.cookie.encoding.Cookie
-
Returns the maximum age of this
Cookie
in seconds orInteger.MIN_VALUE
if unspecified - maxAge() - Method in class play.core.cookie.encoding.DefaultCookie
- maxAge() - Method in class play.mvc.Http.Cookie
- maxJsonChars() - Method in class play.data.Form
-
The default maximum number of chars to support when binding a form from JSON.
- maxJsonDepth() - Method in class play.data.Form
-
The default maximum depth of JSON objects and arrays when binding a form from JSON.
- maxLength(long) - Static method in class play.data.validation.Constraints
-
Constructs a 'maxLength' validator.
- MaxLengthBodyParser(long, HttpErrorHandler) - Constructor for class play.mvc.BodyParser.MaxLengthBodyParser
- MaxLengthValidator() - Constructor for class play.data.validation.Constraints.MaxLengthValidator
- MaxLengthValidator(long) - Constructor for class play.data.validation.Constraints.MaxLengthValidator
- MaxValidator() - Constructor for class play.data.validation.Constraints.MaxValidator
- MaxValidator(long) - Constructor for class play.data.validation.Constraints.MaxValidator
- message - Static variable in class play.data.validation.Constraints.EmailValidator
- message - Static variable in class play.data.validation.Constraints.MaxLengthValidator
- message - Static variable in class play.data.validation.Constraints.MaxValidator
- message - Static variable in class play.data.validation.Constraints.MinLengthValidator
- message - Static variable in class play.data.validation.Constraints.MinValidator
- message - Static variable in class play.data.validation.Constraints.PatternValidator
- message - Static variable in class play.data.validation.Constraints.RequiredValidator
- message() - Method in annotation type play.data.validation.Constraints.Email
- message() - Method in annotation type play.data.validation.Constraints.Max
- message() - Method in annotation type play.data.validation.Constraints.MaxLength
- message() - Method in annotation type play.data.validation.Constraints.Min
- message() - Method in annotation type play.data.validation.Constraints.MinLength
- message() - Method in annotation type play.data.validation.Constraints.Pattern
- message() - Method in annotation type play.data.validation.Constraints.Required
- message() - Method in annotation type play.data.validation.Constraints.Validate
- message() - Method in annotation type play.data.validation.Constraints.ValidatePayloadWith
- message() - Method in annotation type play.data.validation.Constraints.ValidateWith
- message() - Method in annotation type play.data.validation.Constraints.ValidateWithPayload
- message() - Method in class play.data.validation.ValidationError
-
Returns the error message.
- Message - Class in play.http.websocket
-
A WebSocket message.
- Message.Binary - Class in play.http.websocket
-
A binary WebSocket message
- Message.Close - Class in play.http.websocket
-
A close WebSocket message
- Message.Ping - Class in play.http.websocket
-
A ping WebSocket message
- Message.Pong - Class in play.http.websocket
-
A pong WebSocket message
- Message.Text - Class in play.http.websocket
-
A text WebSocket message
- messages() - Method in class play.data.validation.ValidationError
-
Returns the error messages.
- messages() - Method in interface play.i18n.Messages
- Messages - Interface in play.i18n
-
A Messages will produce messages using a specific language.
- Messages.Attrs - Class in play.i18n
- messagesApi() - Method in interface play.BuiltInComponents
- messagesApi() - Method in interface play.i18n.I18nComponents
- messagesApi() - Method in class play.i18n.MessagesImpl
- MessagesApi - Class in play.i18n
-
The messages API.
- MessagesApi(MessagesApi) - Constructor for class play.i18n.MessagesApi
- MessagesImpl - Class in play.i18n
-
This class implements the Messages interface.
- MessagesImpl(Lang, MessagesApi) - Constructor for class play.i18n.MessagesImpl
- method() - Method in class play.mvc.Call
-
The request HTTP method.
- method() - Method in class play.mvc.Http.RequestBuilder
- method() - Method in interface play.mvc.Http.RequestHeader
- method() - Method in class play.routing.HandlerDef
- method(String) - Method in class play.mvc.Http.RequestBuilder
- METHOD_NOT_ALLOWED - Static variable in interface play.mvc.Http.Status
- MethodUtils - Class in play.libs.reflect
-
Imported from apache.commons.lang3 3.6
- MethodUtils() - Constructor for class play.libs.reflect.MethodUtils
-
MethodUtils
instances should NOT be constructed in standard programming. - min(long) - Static method in class play.data.validation.Constraints
-
Constructs a 'min' validator.
- minLength(long) - Static method in class play.data.validation.Constraints
-
Constructs a 'minLength' validator.
- MinLengthValidator() - Constructor for class play.data.validation.Constraints.MinLengthValidator
- MinLengthValidator(long) - Constructor for class play.data.validation.Constraints.MinLengthValidator
- MINUTE - Static variable in class play.libs.Time.CronExpression
- minutes - Variable in class play.libs.Time.CronExpression
- MinValidator() - Constructor for class play.data.validation.Constraints.MinValidator
- MinValidator(long) - Constructor for class play.data.validation.Constraints.MinValidator
- mode() - Method in class play.Environment
-
The mode of the application.
- mode(Mode) - Method in class play.server.Server.Builder
-
Set the mode the server should be run on (defaults to TEST)
- Mode - Enum in play
-
Application mode, either `DEV`, `TEST`, or `PROD`.
- modifiers() - Method in class play.routing.HandlerDef
- module(Object) - Static method in class play.inject.guice.Guiceable
- Module - Class in play.inject
-
A Play dependency injection module.
- Module() - Constructor for class play.inject.Module
- modules(Module...) - Static method in class play.inject.guice.Guiceable
- modules(Module...) - Static method in class play.inject.guice.Guiceable
- MONTH - Static variable in class play.libs.Time.CronExpression
- monthMap - Static variable in class play.libs.Time.CronExpression
- months - Variable in class play.libs.Time.CronExpression
- MOVED_PERMANENTLY - Static variable in interface play.mvc.Http.Status
- movedPermanently(String) - Static method in class play.mvc.Results
-
Generates a 301 Moved Permanently result.
- movedPermanently(Call) - Static method in class play.mvc.Results
-
Generates a 301 Moved Permanently result.
- moveFileTo(File) - Method in interface play.libs.Files.TemporaryFile
-
Deprecated.Deprecated as of 2.8.0. Renamed to
Files.TemporaryFile.moveTo(File)
. - moveFileTo(File, boolean) - Method in class play.libs.Files.DelegateTemporaryFile
-
Deprecated.
- moveFileTo(File, boolean) - Method in interface play.libs.Files.TemporaryFile
-
Deprecated.Deprecated as of 2.8.0. Renamed to
Files.TemporaryFile.moveTo(File, boolean)
. - moveFileTo(Path) - Method in interface play.libs.Files.TemporaryFile
-
Deprecated.Deprecated as of 2.8.0. Renamed to
Files.TemporaryFile.moveTo(Path)
. - moveFileTo(Path, boolean) - Method in interface play.libs.Files.TemporaryFile
-
Deprecated.Deprecated as of 2.8.0. Renamed to
Files.TemporaryFile.moveTo(Path, boolean)
. - moveTo(File) - Method in interface play.libs.Files.TemporaryFile
-
Move the file using a
File
. - moveTo(File, boolean) - Method in class play.libs.Files.DelegateTemporaryFile
- moveTo(File, boolean) - Method in interface play.libs.Files.TemporaryFile
-
Move the file to the specified destination
File
. - moveTo(Path) - Method in interface play.libs.Files.TemporaryFile
-
Move the file using a
Path
. - moveTo(Path, boolean) - Method in interface play.libs.Files.TemporaryFile
-
Move the file using a
Path
. - MULTI_STATUS - Static variable in interface play.mvc.Http.Status
- multipartBody(Source<? super Http.MultipartFormData.Part<Source<ByteString, ?>>, ?>) - Method in interface play.libs.ws.WSBodyWritables
- MultipartFormatter - Class in play.mvc
- MultipartFormatter() - Constructor for class play.mvc.MultipartFormatter
- MultipartFormData() - Constructor for class play.mvc.Http.MultipartFormData
- MultipartFormData(PlayBodyParsers) - Constructor for class play.mvc.BodyParser.MultipartFormData
- MultipartFormData(PlayBodyParsers, boolean) - Constructor for class play.mvc.BodyParser.MultipartFormData
- MultipartFormData(PlayBodyParsers, long) - Constructor for class play.mvc.BodyParser.MultipartFormData
- MultipartFormData(PlayBodyParsers, long, boolean) - Constructor for class play.mvc.BodyParser.MultipartFormData
- multipartFormDataBodyParser() - Method in interface play.components.BodyParserComponents
- MULTIPLE_CHOICES - Static variable in interface play.mvc.Http.Status
N
- name - Variable in class play.db.jpa.JPAConfig.PersistenceUnit
- name() - Method in interface play.core.cookie.encoding.Cookie
-
Returns the name of this
Cookie
. - name() - Method in class play.core.cookie.encoding.DefaultCookie
- name() - Method in annotation type play.data.Form.Display
- name() - Method in class play.data.Form.Field
- name() - Method in class play.data.Form
- name() - Method in class play.mvc.Http.Cookie
- NamedCache - Annotation Type in play.cache
- NamedCacheImpl - Class in play.cache
- NamedCacheImpl(String) - Constructor for class play.cache.NamedCacheImpl
- NamedCaffeineCache<K,V> - Class in play.cache.caffeine
- NamedCaffeineCache(String, AsyncCache<K, V>) - Constructor for class play.cache.caffeine.NamedCaffeineCache
- NamedDatabase - Annotation Type in play.db
- NamedDatabaseImpl - Class in play.db
- NamedDatabaseImpl(String) - Constructor for class play.db.NamedDatabaseImpl
- NamedDatabaseProvider(String) - Constructor for class play.db.DBModule.NamedDatabaseProvider
- NamedImpl - Class in play.inject
-
An implementation of the [[javax.inject.Named]] annotation.
- NamedImpl(String) - Constructor for class play.inject.NamedImpl
- nearestWeekday - Variable in class play.libs.Time.CronExpression
- NETWORK_AUTHENTICATION_REQUIRED - Static variable in interface play.mvc.Http.Status
- networkAuthenticationRequired() - Static method in class play.mvc.Results
-
Generates a 511 Network Authentication Required result.
- networkAuthenticationRequired(byte[]) - Static method in class play.mvc.Results
-
Generates a 511 Network Authentication Required result.
- networkAuthenticationRequired(JsonNode) - Static method in class play.mvc.Results
-
Generates a 511 Network Authentication Required result.
- networkAuthenticationRequired(JsonNode, JsonEncoding) - Static method in class play.mvc.Results
-
Generates a 511 Network Authentication Required result.
- networkAuthenticationRequired(File) - Static method in class play.mvc.Results
-
Generates a 511 Network Authentication Required result.
- networkAuthenticationRequired(File, boolean) - Static method in class play.mvc.Results
-
Generates a 511 Network Authentication Required result.
- networkAuthenticationRequired(File, boolean, Optional<String>) - Static method in class play.mvc.Results
-
Generates a 511 Network Authentication Required result.
- networkAuthenticationRequired(File, boolean, Optional<String>, FileMimeTypes) - Static method in class play.mvc.Results
-
Generates a 511 Network Authentication Required result.
- networkAuthenticationRequired(File, boolean, FileMimeTypes) - Static method in class play.mvc.Results
-
Generates a 511 Network Authentication Required result.
- networkAuthenticationRequired(File, String) - Static method in class play.mvc.Results
-
Deprecated.Deprecated as of 2.8.0. Use to
Results.networkAuthenticationRequired(File, Optional)
. - networkAuthenticationRequired(File, String, FileMimeTypes) - Static method in class play.mvc.Results
-
Deprecated.Deprecated as of 2.8.0. Use to
Results.networkAuthenticationRequired(File, Optional, FileMimeTypes)
. - networkAuthenticationRequired(File, Optional<String>) - Static method in class play.mvc.Results
-
Generates a 511 Network Authentication Required result.
- networkAuthenticationRequired(File, Optional<String>, FileMimeTypes) - Static method in class play.mvc.Results
-
Generates a 511 Network Authentication Required result.
- networkAuthenticationRequired(File, FileMimeTypes) - Static method in class play.mvc.Results
-
Generates a 511 Network Authentication Required result.
- networkAuthenticationRequired(InputStream) - Static method in class play.mvc.Results
-
Generates a 511 Network Authentication Required result.
- networkAuthenticationRequired(InputStream, long) - Static method in class play.mvc.Results
-
Generates a 511 Network Authentication Required result.
- networkAuthenticationRequired(String) - Static method in class play.mvc.Results
-
Generates a 511 Network Authentication Required result.
- networkAuthenticationRequired(String, String) - Static method in class play.mvc.Results
-
Generates a 511 Network Authentication Required result.
- networkAuthenticationRequired(Path) - Static method in class play.mvc.Results
-
Generates a 511 Network Authentication Required result.
- networkAuthenticationRequired(Path, boolean) - Static method in class play.mvc.Results
-
Generates a 511 Network Authentication Required result.
- networkAuthenticationRequired(Path, boolean, Optional<String>) - Static method in class play.mvc.Results
-
Generates a 511 Network Authentication Required result.
- networkAuthenticationRequired(Path, boolean, Optional<String>, FileMimeTypes) - Static method in class play.mvc.Results
-
Generates a 511 Network Authentication Required result.
- networkAuthenticationRequired(Path, boolean, FileMimeTypes) - Static method in class play.mvc.Results
-
Generates a 511 Network Authentication Required result.
- networkAuthenticationRequired(Path, Optional<String>) - Static method in class play.mvc.Results
-
Generates a 511 Network Authentication Required result.
- networkAuthenticationRequired(Path, Optional<String>, FileMimeTypes) - Static method in class play.mvc.Results
-
Generates a 511 Network Authentication Required result.
- networkAuthenticationRequired(Path, FileMimeTypes) - Static method in class play.mvc.Results
-
Generates a 511 Network Authentication Required result.
- networkAuthenticationRequired(Content) - Static method in class play.mvc.Results
-
Generates a 511 Network Authentication Required result.
- networkAuthenticationRequired(Content, String) - Static method in class play.mvc.Results
-
Generates a 511 Network Authentication Required result.
- newArray() - Static method in class play.libs.Json
-
Creates a new empty ArrayNode.
- newBuilder(Delegate) - Method in class play.inject.guice.GuiceBuilder
- newBuilder(GuiceApplicationBuilder) - Method in class play.inject.guice.GuiceApplicationBuilder
-
Implementation of Self creation for GuiceBuilder.
- newBuilder(GuiceInjectorBuilder) - Method in class play.inject.guice.GuiceInjectorBuilder
- newClient(int) - Static method in class play.test.WSTestClient
-
Create a new WSClient for use in testing.
- newDefaultFileMimeTypes() - Static method in class play.mvc.StaticFileMimeTypes
- newDefaultMapper() - Static method in class play.libs.Json
-
Deprecated.Deprecated as of 2.8.0. Inject an
ObjectMapper
instead. - newObject() - Static method in class play.libs.Json
-
Creates a new empty ObjectNode.
- NO_CONTENT - Static variable in interface play.mvc.Http.Status
- NO_ENTITY - Static variable in class play.http.HttpEntity
-
No entity.
- NO_SPEC - Static variable in class play.libs.Time.CronExpression
- NO_SPEC_INT - Static variable in class play.libs.Time.CronExpression
- noContent() - Static method in class play.mvc.Results
-
Generates a 204 No Content result.
- NoHttpFiltersComponents - Interface in play.filters.components
-
Java component to mix in when no default filters should be mixed in to
BuiltInComponents
. - noMatch() - Static method in class play.libs.Scala
-
Throw this exception to indicate that a partial function doesn't match.
- NON_AUTHORITATIVE_INFORMATION - Static variable in interface play.mvc.Http.Status
- None() - Static method in class play.libs.Scala
- NONE - play.mvc.Http.Cookie.SameSite
- NOT_ACCEPTABLE - Static variable in interface play.mvc.Http.Status
- NOT_FOUND - Static variable in interface play.mvc.Http.Status
- NOT_IMPLEMENTED - Static variable in interface play.mvc.Http.Status
- NOT_MODIFIED - Static variable in interface play.mvc.Http.Status
- notAcceptable() - Static method in class play.mvc.Results
-
Generates a 406 Not Acceptable result.
- notAcceptable(byte[]) - Static method in class play.mvc.Results
-
Generates a 406 Not Acceptable result.
- notAcceptable(JsonNode) - Static method in class play.mvc.Results
-
Generates a 406 Not Acceptable result.
- notAcceptable(JsonNode, JsonEncoding) - Static method in class play.mvc.Results
-
Generates a 406 Not Acceptable result.
- notAcceptable(File) - Static method in class play.mvc.Results
-
Generates a 406 Not Acceptable result.
- notAcceptable(File, boolean) - Static method in class play.mvc.Results
-
Generates a 406 Not Acceptable result.
- notAcceptable(File, boolean, Optional<String>) - Static method in class play.mvc.Results
-
Generates a 406 Not Acceptable result.
- notAcceptable(File, boolean, Optional<String>, FileMimeTypes) - Static method in class play.mvc.Results
-
Generates a 406 Not Acceptable result.
- notAcceptable(File, boolean, FileMimeTypes) - Static method in class play.mvc.Results
-
Generates a 406 Not Acceptable result.
- notAcceptable(File, String) - Static method in class play.mvc.Results
-
Deprecated.Deprecated as of 2.8.0. Use to
Results.notAcceptable(File, Optional)
. - notAcceptable(File, String, FileMimeTypes) - Static method in class play.mvc.Results
-
Deprecated.Deprecated as of 2.8.0. Use to
Results.notAcceptable(File, Optional, FileMimeTypes)
. - notAcceptable(File, Optional<String>) - Static method in class play.mvc.Results
-
Generates a 406 Not Acceptable result.
- notAcceptable(File, Optional<String>, FileMimeTypes) - Static method in class play.mvc.Results
-
Generates a 406 Not Acceptable result.
- notAcceptable(File, FileMimeTypes) - Static method in class play.mvc.Results
-
Generates a 406 Not Acceptable result.
- notAcceptable(InputStream) - Static method in class play.mvc.Results
-
Generates a 406 Not Acceptable result.
- notAcceptable(InputStream, long) - Static method in class play.mvc.Results
-
Generates a 406 Not Acceptable result.
- notAcceptable(String) - Static method in class play.mvc.Results
-
Generates a 406 Not Acceptable result.
- notAcceptable(String, String) - Static method in class play.mvc.Results
-
Generates a 406 Not Acceptable result.
- notAcceptable(Path) - Static method in class play.mvc.Results
-
Generates a 406 Not Acceptable result.
- notAcceptable(Path, boolean) - Static method in class play.mvc.Results
-
Generates a 406 Not Acceptable result.
- notAcceptable(Path, boolean, Optional<String>) - Static method in class play.mvc.Results
-
Generates a 406 Not Acceptable result.
- notAcceptable(Path, boolean, Optional<String>, FileMimeTypes) - Static method in class play.mvc.Results
-
Generates a 406 Not Acceptable result.
- notAcceptable(Path, boolean, FileMimeTypes) - Static method in class play.mvc.Results
-
Generates a 406 Not Acceptable result.
- notAcceptable(Path, Optional<String>) - Static method in class play.mvc.Results
-
Generates a 406 Not Acceptable result.
- notAcceptable(Path, Optional<String>, FileMimeTypes) - Static method in class play.mvc.Results
-
Generates a 406 Not Acceptable result.
- notAcceptable(Path, FileMimeTypes) - Static method in class play.mvc.Results
-
Generates a 406 Not Acceptable result.
- notAcceptable(Content) - Static method in class play.mvc.Results
-
Generates a 406 Not Acceptable result.
- notAcceptable(Content, String) - Static method in class play.mvc.Results
-
Generates a 406 Not Acceptable result.
- notFound() - Static method in class play.mvc.Results
-
Generates a 404 Not Found result.
- notFound(byte[]) - Static method in class play.mvc.Results
-
Generates a 404 Not Found result.
- notFound(JsonNode) - Static method in class play.mvc.Results
-
Generates a 404 Not Found result.
- notFound(JsonNode, JsonEncoding) - Static method in class play.mvc.Results
-
Generates a 404 Not Found result.
- notFound(File) - Static method in class play.mvc.Results
-
Generates a 404 Not Found result.
- notFound(File, boolean) - Static method in class play.mvc.Results
-
Generates a 404 Not Found result.
- notFound(File, boolean, Optional<String>) - Static method in class play.mvc.Results
-
Generates a 404 Not Found result.
- notFound(File, boolean, Optional<String>, FileMimeTypes) - Static method in class play.mvc.Results
-
Generates a 404 Not Found result.
- notFound(File, boolean, FileMimeTypes) - Static method in class play.mvc.Results
-
Generates a 404 Not Found result.
- notFound(File, String) - Static method in class play.mvc.Results
-
Deprecated.Deprecated as of 2.8.0. Use to
Results.notFound(File, Optional)
. - notFound(File, String, FileMimeTypes) - Static method in class play.mvc.Results
-
Deprecated.Deprecated as of 2.8.0. Use to
Results.notFound(File, Optional, FileMimeTypes)
. - notFound(File, Optional<String>) - Static method in class play.mvc.Results
-
Generates a 404 Not Found result.
- notFound(File, Optional<String>, FileMimeTypes) - Static method in class play.mvc.Results
-
Generates a 404 Not Found result.
- notFound(File, FileMimeTypes) - Static method in class play.mvc.Results
-
Generates a 404 Not Found result.
- notFound(InputStream) - Static method in class play.mvc.Results
-
Generates a 404 Not Found result.
- notFound(InputStream, long) - Static method in class play.mvc.Results
-
Generates a 404 Not Found result.
- notFound(String) - Static method in class play.mvc.Results
-
Generates a 404 Not Found result.
- notFound(String, String) - Static method in class play.mvc.Results
-
Generates a 404 Not Found result.
- notFound(Path) - Static method in class play.mvc.Results
-
Generates a 404 Not Found result.
- notFound(Path, boolean) - Static method in class play.mvc.Results
-
Generates a 404 Not Found result.
- notFound(Path, boolean, Optional<String>) - Static method in class play.mvc.Results
-
Generates a 404 Not Found result.
- notFound(Path, boolean, Optional<String>, FileMimeTypes) - Static method in class play.mvc.Results
-
Generates a 404 Not Found result.
- notFound(Path, boolean, FileMimeTypes) - Static method in class play.mvc.Results
-
Generates a 404 Not Found result.
- notFound(Path, Optional<String>) - Static method in class play.mvc.Results
-
Generates a 404 Not Found result.
- notFound(Path, Optional<String>, FileMimeTypes) - Static method in class play.mvc.Results
-
Generates a 404 Not Found result.
- notFound(Path, FileMimeTypes) - Static method in class play.mvc.Results
-
Generates a 404 Not Found result.
- notFound(Content) - Static method in class play.mvc.Results
-
Generates a 404 Not Found result.
- notFound(Content, String) - Static method in class play.mvc.Results
-
Generates a 404 Not Found result.
- nthdayOfWeek - Variable in class play.libs.Time.CronExpression
O
- of(Class<?>) - Static method in class play.Logger
-
Obtain a logger instance.
- of(String) - Static method in class play.Logger
-
Obtain a logger instance.
- of(String, String) - Static method in class play.db.jpa.DefaultJPAConfig
-
Create a default JPA configuration with the given name and unit name.
- of(String, String, String, String) - Static method in class play.db.jpa.DefaultJPAConfig
-
Create a default JPA configuration with the given names and unit names.
- of(String, String, String, String, String, String) - Static method in class play.db.jpa.DefaultJPAConfig
-
Create a default JPA configuration with the given names and unit names.
- of(Function<Http.RequestHeader, Accumulator<ByteString, Result>>) - Static method in class play.mvc.EssentialAction
- ofFile(Http.Request, File) - Static method in class play.mvc.RangeResults
-
Returns the file as a result considering "Range" header.
- ofFile(Http.Request, File, String) - Static method in class play.mvc.RangeResults
-
Returns the file as a result considering "Range" header.
- ofFile(Http.Request, File, String, FileMimeTypes) - Static method in class play.mvc.RangeResults
-
Returns the file as a result considering "Range" header.
- ofFile(Http.Request, File, FileMimeTypes) - Static method in class play.mvc.RangeResults
-
Returns the file as a result considering "Range" header.
- ofPath(Http.Request, Path) - Static method in class play.mvc.RangeResults
-
Returns the path as a result considering "Range" header.
- ofPath(Http.Request, Path, String) - Static method in class play.mvc.RangeResults
-
Returns the path as a result considering "Range" header.
- ofPath(Http.Request, Path, String, FileMimeTypes) - Static method in class play.mvc.RangeResults
-
Returns the path as a result considering "Range" header.
- ofPath(Http.Request, Path, FileMimeTypes) - Static method in class play.mvc.RangeResults
-
Returns the path as a result considering "Range" header.
- ofSource(Http.Request, Long, Source<ByteString, ?>, String, String) - Static method in class play.mvc.RangeResults
-
Returns the stream as a result considering "Range" header.
- ofSource(Http.Request, Long, RangeResults.SourceFunction, String, String) - Static method in class play.mvc.RangeResults
- ofStream(Http.Request, InputStream) - Static method in class play.mvc.RangeResults
-
Returns the stream as a result considering "Range" header.
- ofStream(Http.Request, InputStream, long) - Static method in class play.mvc.RangeResults
-
Returns the stream as a result considering "Range" header.
- ofStream(Http.Request, InputStream, long, String) - Static method in class play.mvc.RangeResults
-
Returns the stream as a result considering "Range" header.
- ofStream(Http.Request, InputStream, long, String, String) - Static method in class play.mvc.RangeResults
-
Returns the stream as a result considering "Range" header.
- ok() - Static method in class play.mvc.Results
-
Generates a 200 OK result.
- ok(byte[]) - Static method in class play.mvc.Results
-
Generates a 200 OK result.
- ok(JsonNode) - Static method in class play.mvc.Results
-
Generates a 200 OK result.
- ok(JsonNode, JsonEncoding) - Static method in class play.mvc.Results
-
Generates a 200 OK result.
- ok(File) - Static method in class play.mvc.Results
-
Generates a 200 OK result.
- ok(File, boolean) - Static method in class play.mvc.Results
-
Generates a 200 OK result.
- ok(File, boolean, Optional<String>) - Static method in class play.mvc.Results
-
Generates a 200 OK result.
- ok(File, boolean, Optional<String>, FileMimeTypes) - Static method in class play.mvc.Results
-
Generates a 200 OK result.
- ok(File, boolean, FileMimeTypes) - Static method in class play.mvc.Results
-
Generates a 200 OK result.
- ok(File, String) - Static method in class play.mvc.Results
-
Deprecated.Deprecated as of 2.8.0. Use to
Results.ok(File, Optional)
. - ok(File, String, FileMimeTypes) - Static method in class play.mvc.Results
-
Deprecated.Deprecated as of 2.8.0. Use to
Results.ok(File, Optional, FileMimeTypes)
. - ok(File, Optional<String>) - Static method in class play.mvc.Results
-
Generates a 200 OK result.
- ok(File, Optional<String>, FileMimeTypes) - Static method in class play.mvc.Results
-
Generates a 200 OK result.
- ok(File, FileMimeTypes) - Static method in class play.mvc.Results
-
Generates a 200 OK result.
- ok(InputStream) - Static method in class play.mvc.Results
-
Generates a 200 OK result.
- ok(InputStream, long) - Static method in class play.mvc.Results
-
Generates a 200 OK result.
- ok(String) - Static method in class play.mvc.Results
-
Generates a 200 OK result.
- ok(String, String) - Static method in class play.mvc.Results
-
Generates a 200 OK result.
- ok(Path) - Static method in class play.mvc.Results
-
Generates a 200 OK result.
- ok(Path, boolean) - Static method in class play.mvc.Results
-
Generates a 200 OK result.
- ok(Path, boolean, Optional<String>) - Static method in class play.mvc.Results
-
Generates a 200 OK result.
- ok(Path, boolean, Optional<String>, FileMimeTypes) - Static method in class play.mvc.Results
-
Generates a 200 OK result.
- ok(Path, boolean, FileMimeTypes) - Static method in class play.mvc.Results
-
Generates a 200 OK result.
- ok(Path, Optional<String>) - Static method in class play.mvc.Results
-
Generates a 200 OK result.
- ok(Path, Optional<String>, FileMimeTypes) - Static method in class play.mvc.Results
-
Generates a 200 OK result.
- ok(Path, FileMimeTypes) - Static method in class play.mvc.Results
-
Generates a 200 OK result.
- ok(Content) - Static method in class play.mvc.Results
-
Generates a 200 OK result.
- ok(Content, String) - Static method in class play.mvc.Results
-
Generates a 200 OK result.
- OK - Static variable in interface play.mvc.Http.Status
- onBadRequest(Http.RequestHeader, String) - Method in class play.http.DefaultHttpErrorHandler
-
Invoked when a client makes a bad request.
- onClientError(Http.RequestHeader, int, String) - Method in class play.http.DefaultHttpErrorHandler
-
Invoked when a client error occurs, that is, an error in the 4xx series.
- onClientError(Http.RequestHeader, int, String) - Method in interface play.http.HttpErrorHandler
-
Invoked when a client error occurs, that is, an error in the 4xx series.
- onClientError(Http.RequestHeader, int, String) - Method in class play.http.JsonHttpErrorHandler
- onClientError(Http.RequestHeader, int, String) - Method in class play.http.PreferredMediaTypeHttpErrorHandler
- onDevServerError(Http.RequestHeader, UsefulException) - Method in class play.http.DefaultHttpErrorHandler
-
Invoked in dev mode when a server error occurs.
- onForbidden(Http.RequestHeader, String) - Method in class play.http.DefaultHttpErrorHandler
-
Invoked when a client makes a request that was forbidden.
- onNotFound(Http.RequestHeader, String) - Method in class play.http.DefaultHttpErrorHandler
-
Invoked when a handler or resource is not found.
- onOtherClientError(Http.RequestHeader, int, String) - Method in class play.http.DefaultHttpErrorHandler
-
Invoked when a client error occurs, that is, an error in the 4xx series, which is not handled by any of the other methods in this class already.
- onProdServerError(Http.RequestHeader, UsefulException) - Method in class play.http.DefaultHttpErrorHandler
-
Invoked in prod mode when a server error occurs.
- onServerError(Http.RequestHeader, Throwable) - Method in class play.http.DefaultHttpErrorHandler
-
Invoked when a server error occurs.
- onServerError(Http.RequestHeader, Throwable) - Method in interface play.http.HttpErrorHandler
-
Invoked when a server error occurs.
- onServerError(Http.RequestHeader, Throwable) - Method in class play.http.JsonHttpErrorHandler
- onServerError(Http.RequestHeader, Throwable) - Method in class play.http.PreferredMediaTypeHttpErrorHandler
- onUnauthorized(Http.Request) - Method in class play.mvc.Security.Authenticator
-
Generates an alternative result if the user is not authenticated; the default a simple '401 Not Authorized' page.
- openIdClient() - Method in interface play.libs.openid.OpenIdComponents
- OpenIdClient - Interface in play.libs.openid
-
A client for performing OpenID authentication.
- OpenIdComponents - Interface in play.libs.openid
-
OpenID Java components.
- openIdDiscovery() - Method in interface play.libs.openid.OpenIdComponents
- OpenIdModule - Class in play.libs.openid
- OpenIdModule() - Constructor for class play.libs.openid.OpenIdModule
- Option(T) - Static method in class play.libs.Scala
-
Wrap a value into a Scala Option.
- options() - Method in class play.libs.ws.ahc.AhcWSRequest
- options() - Method in interface play.libs.ws.WSRequest
-
Perform an OPTIONS on the request asynchronously.
- OPTIONS - Static variable in interface play.mvc.Http.HttpVerbs
- OPTIONS(String) - Method in class play.routing.RoutingDsl
-
Create a OPTIONS route for the given path pattern.
- orElse(Router) - Method in interface play.routing.Router
- orElse(Option<T>, T) - Static method in class play.libs.Scala
-
Wraps a Scala Option, handling None by returning a defaultValue
- org.jdbcdslog - package org.jdbcdslog
- origin() - Method in class play.http.HttpErrorInfo
-
The origin of where the error handler was initially called.
Play currently adds following values:server-backend
- The error handler was called in either the Netty or Pekko-HTTP server backend. - ORIGIN - Static variable in interface play.mvc.Http.HeaderNames
- orNull(Option<T>) - Static method in class play.libs.Scala
-
Wraps a Scala Option, handling None as null.
- overrides(Module...) - Method in class play.inject.guice.GuiceBuilder
-
Override bindings using Guice modules.
- overrides(Binding<?>...) - Method in class play.inject.guice.GuiceBuilder
-
Override bindings using Play bindings.
- overrides(GuiceableModule...) - Method in class play.inject.guice.GuiceBuilder
-
Override bindings using guiceable modules.
- overrides(Module...) - Method in class play.inject.guice.GuiceBuilder
-
Override bindings using Play modules.
- overrides(ApplicationLoader.Context) - Method in class play.inject.guice.GuiceApplicationLoader
-
Identify some bindings that should be used as overrides when loading an application using this context.
P
- parameterTypes() - Method in class play.routing.HandlerDef
- parse(byte[]) - Static method in class play.libs.Json
-
Parses a byte array representing a json, and return it as a JsonNode.
- parse(A, String, Locale) - Method in class play.data.format.Formatters.AnnotationFormatter
-
Binds the field - constructs a concrete value from submitted data.
- parse(InputStream) - Static method in class play.libs.Json
-
Parses a InputStream representing a json, and return it as a JsonNode.
- parse(Field, String) - Method in class play.data.format.Formatters
-
Parses this string as instance of a specific field
- parse(String) - Static method in class play.libs.Json
-
Parses a String representing a json, and return it as a JsonNode.
- parse(String) - Static method in enum play.mvc.Http.Cookie.SameSite
- parse(String, Class<T>) - Method in class play.data.format.Formatters
-
Parses this string as instance of the given class.
- parse(String, Locale) - Method in class play.data.format.Formats.DateFormatter
-
Binds the field - constructs a concrete value from submitted data.
- parse(String, Locale) - Method in class play.data.format.Formatters.SimpleFormatter
-
Binds the field - constructs a concrete value from submitted data.
- parse(Formats.DateTime, String, Locale) - Method in class play.data.format.Formats.AnnotationDateFormatter
-
Binds the field - constructs a concrete value from submitted data.
- parse(Formats.NonEmpty, String, Locale) - Method in class play.data.format.Formats.AnnotationNonEmptyFormatter
-
Binds the field - constructs a concrete value from submitted data.
- parse(Http.RequestHeader, ByteString) - Method in class play.mvc.BodyParser.BufferingBodyParser
-
Parse the body.
- parse(Http.RequestHeader, ByteString) - Method in class play.mvc.BodyParser.Bytes
- parse(Http.RequestHeader, ByteString) - Method in class play.mvc.BodyParser.FormUrlEncoded
- parse(Http.RequestHeader, ByteString) - Method in class play.mvc.BodyParser.Text
- parse(Http.RequestHeader, ByteString) - Method in class play.mvc.BodyParser.TolerantJson
- parse(Http.RequestHeader, ByteString) - Method in class play.mvc.BodyParser.TolerantText
- parse(Http.RequestHeader, ByteString) - Method in class play.mvc.BodyParser.TolerantXml
- parseCRONExpression(String) - Static method in class play.libs.Time
-
Parses a CRON expression.
- parseDuration(String) - Static method in class play.libs.Time
-
Parses a duration.
- parseJson(Class<A>) - Method in class play.mvc.Http.RequestBody
-
Converts a JSON request to a given class.
- PARTIAL_CONTENT - Static variable in interface play.mvc.Http.Status
- partialFunction(Function<A, B>) - Static method in class play.libs.Scala
-
Create a Scala PartialFunction from a function.
- patch(JsonNode) - Method in class play.libs.ws.ahc.AhcWSRequest
- patch(JsonNode) - Method in interface play.libs.ws.WSRequest
-
Perform a PATCH on the request asynchronously.
- patch(File) - Method in class play.libs.ws.ahc.AhcWSRequest
- patch(File) - Method in interface play.libs.ws.WSRequest
-
Perform a PATCH on the request asynchronously.
- patch(InputStream) - Method in class play.libs.ws.ahc.AhcWSRequest
-
Deprecated.
- patch(InputStream) - Method in interface play.libs.ws.WSRequest
-
Deprecated.Deprecated as of 2.7.0. Use
WSRequest.patch(BodyWritable)
instead. - patch(String) - Method in class play.libs.ws.ahc.AhcWSRequest
- patch(String) - Method in interface play.libs.ws.WSRequest
-
Perform a PATCH on the request asynchronously.
- patch(Source<? super Http.MultipartFormData.Part<Source<ByteString, ?>>, ?>) - Method in class play.libs.ws.ahc.AhcWSRequest
- patch(Source<? super Http.MultipartFormData.Part<Source<ByteString, ?>>, ?>) - Method in interface play.libs.ws.WSRequest
-
Perform a PATCH on the request asynchronously.
- patch(Document) - Method in class play.libs.ws.ahc.AhcWSRequest
- patch(Document) - Method in interface play.libs.ws.WSRequest
-
Perform a PATCH on the request asynchronously.
- patch(BodyWritable) - Method in class play.libs.ws.ahc.AhcWSRequest
- patch(BodyWritable) - Method in interface play.libs.ws.WSRequest
-
Perform a PATCH on the request asynchronously.
- PATCH - Static variable in interface play.mvc.Http.HttpVerbs
- PATCH(String) - Method in class play.routing.RoutingDsl
-
Create a PATCH route for the given path pattern.
- path() - Method in interface play.Application
-
Get the application path.
- path() - Method in interface play.core.cookie.encoding.Cookie
-
Returns the path of this
Cookie
. - path() - Method in class play.core.cookie.encoding.DefaultCookie
- path() - Method in class play.libs.Files.DelegateTemporaryFile
- path() - Method in interface play.libs.Files.TemporaryFile
- path() - Method in class play.mvc.Call
- path() - Method in class play.mvc.Http.Cookie
- path() - Method in class play.mvc.Http.RequestBuilder
- path() - Method in interface play.mvc.Http.RequestHeader
- path() - Method in class play.routing.HandlerDef
- path(String) - Method in class play.mvc.Http.RequestBuilder
-
This method sets the path of the uri.
- PathBindable<T extends PathBindable<T>> - Interface in play.mvc
-
Binder for path parameters.
- PathPatternMatcher(String, String) - Constructor for class play.routing.RoutingDsl.PathPatternMatcher
- Paths - Class in play.core
-
Implementations to work with URL paths.
- pattern() - Method in annotation type play.data.format.Formats.DateTime
-
Date pattern, as specified for
SimpleDateFormat
. - pattern(String) - Static method in class play.data.validation.Constraints
-
Constructs a 'pattern' validator.
- PatternValidator() - Constructor for class play.data.validation.Constraints.PatternValidator
- PatternValidator(String) - Constructor for class play.data.validation.Constraints.PatternValidator
- payload() - Method in annotation type play.data.validation.Constraints.Email
- payload() - Method in annotation type play.data.validation.Constraints.Max
- payload() - Method in annotation type play.data.validation.Constraints.MaxLength
- payload() - Method in annotation type play.data.validation.Constraints.Min
- payload() - Method in annotation type play.data.validation.Constraints.MinLength
- payload() - Method in annotation type play.data.validation.Constraints.Pattern
- payload() - Method in annotation type play.data.validation.Constraints.Required
- payload() - Method in annotation type play.data.validation.Constraints.Validate
- payload() - Method in annotation type play.data.validation.Constraints.ValidatePayloadWith
- payload() - Method in annotation type play.data.validation.Constraints.ValidateWith
- payload() - Method in annotation type play.data.validation.Constraints.ValidateWithPayload
- PAYMENT_REQUIRED - Static variable in interface play.mvc.Http.Status
- paymentRequired() - Static method in class play.mvc.Results
-
Generates a 402 Payment Required result.
- paymentRequired(byte[]) - Static method in class play.mvc.Results
-
Generates a 402 Payment Required result.
- paymentRequired(JsonNode) - Static method in class play.mvc.Results
-
Generates a 402 Payment Required result.
- paymentRequired(JsonNode, JsonEncoding) - Static method in class play.mvc.Results
-
Generates a 402 Payment Required result.
- paymentRequired(File) - Static method in class play.mvc.Results
-
Generates a 402 Payment Required result.
- paymentRequired(File, boolean) - Static method in class play.mvc.Results
-
Generates a 402 Payment Required result.
- paymentRequired(File, boolean, Optional<String>) - Static method in class play.mvc.Results
-
Generates a 402 Payment Required result.
- paymentRequired(File, boolean, Optional<String>, FileMimeTypes) - Static method in class play.mvc.Results
-
Generates a 402 Payment Required result.
- paymentRequired(File, boolean, FileMimeTypes) - Static method in class play.mvc.Results
-
Generates a 402 Payment Required result.
- paymentRequired(File, String) - Static method in class play.mvc.Results
-
Deprecated.Deprecated as of 2.8.0. Use to
Results.paymentRequired(File, Optional)
. - paymentRequired(File, String, FileMimeTypes) - Static method in class play.mvc.Results
-
Deprecated.Deprecated as of 2.8.0. Use to
Results.paymentRequired(File, Optional, FileMimeTypes)
. - paymentRequired(File, Optional<String>) - Static method in class play.mvc.Results
-
Generates a 402 Payment Required result.
- paymentRequired(File, Optional<String>, FileMimeTypes) - Static method in class play.mvc.Results
-
Generates a 402 Payment Required result.
- paymentRequired(File, FileMimeTypes) - Static method in class play.mvc.Results
-
Generates a 402 Payment Required result.
- paymentRequired(InputStream) - Static method in class play.mvc.Results
-
Generates a 402 Payment Required result.
- paymentRequired(InputStream, long) - Static method in class play.mvc.Results
-
Generates a 402 Payment Required result.
- paymentRequired(String) - Static method in class play.mvc.Results
-
Generates a 402 Payment Required result.
- paymentRequired(String, String) - Static method in class play.mvc.Results
-
Generates a 402 Payment Required result.
- paymentRequired(Path) - Static method in class play.mvc.Results
-
Generates a 402 Payment Required result.
- paymentRequired(Path, boolean) - Static method in class play.mvc.Results
-
Generates a 402 Payment Required result.
- paymentRequired(Path, boolean, Optional<String>) - Static method in class play.mvc.Results
-
Generates a 402 Payment Required result.
- paymentRequired(Path, boolean, Optional<String>, FileMimeTypes) - Static method in class play.mvc.Results
-
Generates a 402 Payment Required result.
- paymentRequired(Path, boolean, FileMimeTypes) - Static method in class play.mvc.Results
-
Generates a 402 Payment Required result.
- paymentRequired(Path, Optional<String>) - Static method in class play.mvc.Results
-
Generates a 402 Payment Required result.
- paymentRequired(Path, Optional<String>, FileMimeTypes) - Static method in class play.mvc.Results
-
Generates a 402 Payment Required result.
- paymentRequired(Path, FileMimeTypes) - Static method in class play.mvc.Results
-
Generates a 402 Payment Required result.
- paymentRequired(Content) - Static method in class play.mvc.Results
-
Generates a 402 Payment Required result.
- paymentRequired(Content, String) - Static method in class play.mvc.Results
-
Generates a 402 Payment Required result.
- Pekko - Class in play.libs
-
Helper to access the application defined Pekko Actor system.
- Pekko() - Constructor for class play.libs.Pekko
- PekkoComponents - Interface in play.components
-
Pekko and Pekko Streams components.
- PekkoGuiceSupport - Interface in play.libs.pekko
-
Support for binding actors with Guice.
- PekkoStreams - Class in play.libs.streams
-
Pekko streams utilities.
- PekkoStreams() - Constructor for class play.libs.streams.PekkoStreams
- PekkoTypedComponents - Interface in play.components
-
Pekko Typed components.
- PERMANENT_REDIRECT - Static variable in interface play.mvc.Http.Status
- permanentRedirect(String) - Static method in class play.mvc.Results
-
Generates a 308 Permanent Redirect result.
- permanentRedirect(Call) - Static method in class play.mvc.Results
-
Generates a 308 Permanent Redirect result.
- PersistenceUnit(String, String) - Constructor for class play.db.jpa.JPAConfig.PersistenceUnit
- persistenceUnits() - Method in class play.db.jpa.DefaultJPAConfig
- persistenceUnits() - Method in interface play.db.jpa.JPAConfig
- Ping(ByteString) - Constructor for class play.http.websocket.Message.Ping
- play - package play
-
Provides the Play framework's publicly accessible Java API.
- play.cache - package play.cache
-
Provides the Cache API.
- play.cache.caffeine - package play.cache.caffeine
- play.cache.ehcache - package play.cache.ehcache
- play.cluster.sharding.typed - package play.cluster.sharding.typed
- play.components - package play.components
- play.controllers - package play.controllers
- play.core - package play.core
- play.core.cookie.encoding - package play.core.cookie.encoding
-
This package contains Cookie related classes.
- play.core.j - package play.core.j
- play.data - package play.data
-
Provides data manipulation helpers, mainly for HTTP form handling.
- play.data.format - package play.data.format
-
Provides the formatting API used by
Form
classes. - play.data.validation - package play.data.validation
-
Provides the JSR 303 validation constraints.
- play.db - package play.db
-
Provides the JDBC database access API.
- play.db.evolutions - package play.db.evolutions
- play.db.jpa - package play.db.jpa
-
Provides JPA ORM integration.
- play.filters.components - package play.filters.components
- play.filters.csp - package play.filters.csp
- play.filters.csrf - package play.filters.csrf
- play.http - package play.http
-
Core Java HTTP API.
- play.http.websocket - package play.http.websocket
- play.i18n - package play.i18n
-
Provides the i18n API.
- play.inject - package play.inject
-
Provides dependency injection utilities for Play lifecycle.
- play.inject.guice - package play.inject.guice
- play.libs - package play.libs
-
Provides various APIs that are useful for developing web applications.
- play.libs.concurrent - package play.libs.concurrent
-
Concurrency utilities for handling CompletionStage and ExecutionContexts.
- play.libs.crypto - package play.libs.crypto
- play.libs.exception - package play.libs.exception
- play.libs.jcache - package play.libs.jcache
- play.libs.openid - package play.libs.openid
-
Provides an OpenID client.
- play.libs.pekko - package play.libs.pekko
-
Utility methods for working with Pekko.
- play.libs.reflect - package play.libs.reflect
- play.libs.streams - package play.libs.streams
-
Utility methods for working with Pekko Streams.
- play.libs.typedmap - package play.libs.typedmap
- play.libs.ws - package play.libs.ws
- play.libs.ws.ahc - package play.libs.ws.ahc
- play.mvc - package play.mvc
-
Provides the Controller/Action/Result API for handling HTTP requests.
- play.routing - package play.routing
- play.server - package play.server
- play.test - package play.test
-
Contains test helpers.
- plusSkippedClasses(Class...) - Method in class play.inject.SourceProvider
-
Returns a new instance that also skips
moreClassesToSkip
. - Pong(ByteString) - Constructor for class play.http.websocket.Message.Pong
- port - Variable in class play.test.WithServer
- post(JsonNode) - Method in class play.libs.ws.ahc.AhcWSRequest
- post(JsonNode) - Method in interface play.libs.ws.WSRequest
-
Perform a POST on the request asynchronously.
- post(File) - Method in class play.libs.ws.ahc.AhcWSRequest
- post(File) - Method in interface play.libs.ws.WSRequest
-
Perform a POST on the request asynchronously.
- post(InputStream) - Method in class play.libs.ws.ahc.AhcWSRequest
-
Deprecated.
- post(InputStream) - Method in interface play.libs.ws.WSRequest
-
Deprecated.Deprecated as of 2.6.0. Use
WSRequest.post(BodyWritable)
instead. - post(String) - Method in class play.libs.ws.ahc.AhcWSRequest
- post(String) - Method in interface play.libs.ws.WSRequest
-
Perform a POST on the request asynchronously.
- post(Source<? super Http.MultipartFormData.Part<Source<ByteString, ?>>, ?>) - Method in class play.libs.ws.ahc.AhcWSRequest
- post(Source<? super Http.MultipartFormData.Part<Source<ByteString, ?>>, ?>) - Method in interface play.libs.ws.WSRequest
-
Perform a POST on the request asynchronously.
- post(Document) - Method in class play.libs.ws.ahc.AhcWSRequest
- post(Document) - Method in interface play.libs.ws.WSRequest
-
Perform a POST on the request asynchronously.
- post(BodyWritable) - Method in class play.libs.ws.ahc.AhcWSRequest
- post(BodyWritable) - Method in interface play.libs.ws.WSRequest
-
Perform a POST on the request asynchronously.
- POST - Static variable in interface play.mvc.Http.HttpVerbs
- POST - Static variable in class play.test.Helpers
- POST(String) - Method in class play.routing.RoutingDsl
-
Create a POST route for the given path pattern.
- PRAGMA - Static variable in interface play.mvc.Http.HeaderNames
- PRECONDITION_FAILED - Static variable in interface play.mvc.Http.Status
- PRECONDITION_REQUIRED - Static variable in interface play.mvc.Http.Status
- preconditionRequired() - Static method in class play.mvc.Results
-
Generates a 428 Precondition Required result.
- preconditionRequired(byte[]) - Static method in class play.mvc.Results
-
Generates a 428 Precondition Required result.
- preconditionRequired(JsonNode) - Static method in class play.mvc.Results
-
Generates a 428 Precondition Required result.
- preconditionRequired(JsonNode, JsonEncoding) - Static method in class play.mvc.Results
-
Generates a 428 Precondition Required result.
- preconditionRequired(File) - Static method in class play.mvc.Results
-
Generates a 428 Precondition Required result.
- preconditionRequired(File, boolean) - Static method in class play.mvc.Results
-
Generates a 428 Precondition Required result.
- preconditionRequired(File, boolean, Optional<String>) - Static method in class play.mvc.Results
-
Generates a 428 Precondition Required result.
- preconditionRequired(File, boolean, Optional<String>, FileMimeTypes) - Static method in class play.mvc.Results
-
Generates a 428 Precondition Required result.
- preconditionRequired(File, boolean, FileMimeTypes) - Static method in class play.mvc.Results
-
Generates a 428 Precondition Required result.
- preconditionRequired(File, String) - Static method in class play.mvc.Results
-
Deprecated.Deprecated as of 2.8.0. Use to
Results.preconditionRequired(File, Optional)
. - preconditionRequired(File, String, FileMimeTypes) - Static method in class play.mvc.Results
-
Deprecated.Deprecated as of 2.8.0. Use to
Results.preconditionRequired(File, Optional, FileMimeTypes)
. - preconditionRequired(File, Optional<String>) - Static method in class play.mvc.Results
-
Generates a 428 Precondition Required result.
- preconditionRequired(File, Optional<String>, FileMimeTypes) - Static method in class play.mvc.Results
-
Generates a 428 Precondition Required result.
- preconditionRequired(File, FileMimeTypes) - Static method in class play.mvc.Results
-
Generates a 428 Precondition Required result.
- preconditionRequired(InputStream) - Static method in class play.mvc.Results
-
Generates a 428 Precondition Required result.
- preconditionRequired(InputStream, long) - Static method in class play.mvc.Results
-
Generates a 428 Precondition Required result.
- preconditionRequired(String) - Static method in class play.mvc.Results
-
Generates a 428 Precondition Required result.
- preconditionRequired(String, String) - Static method in class play.mvc.Results
-
Generates a 428 Precondition Required result.
- preconditionRequired(Path) - Static method in class play.mvc.Results
-
Generates a 428 Precondition Required result.
- preconditionRequired(Path, boolean) - Static method in class play.mvc.Results
-
Generates a 428 Precondition Required result.
- preconditionRequired(Path, boolean, Optional<String>) - Static method in class play.mvc.Results
-
Generates a 428 Precondition Required result.
- preconditionRequired(Path, boolean, Optional<String>, FileMimeTypes) - Static method in class play.mvc.Results
-
Generates a 428 Precondition Required result.
- preconditionRequired(Path, boolean, FileMimeTypes) - Static method in class play.mvc.Results
-
Generates a 428 Precondition Required result.
- preconditionRequired(Path, Optional<String>) - Static method in class play.mvc.Results
-
Generates a 428 Precondition Required result.
- preconditionRequired(Path, Optional<String>, FileMimeTypes) - Static method in class play.mvc.Results
-
Generates a 428 Precondition Required result.
- preconditionRequired(Path, FileMimeTypes) - Static method in class play.mvc.Results
-
Generates a 428 Precondition Required result.
- preconditionRequired(Content) - Static method in class play.mvc.Results
-
Generates a 428 Precondition Required result.
- preconditionRequired(Content, String) - Static method in class play.mvc.Results
-
Generates a 428 Precondition Required result.
- precursor - Variable in class play.mvc.Action
-
The precursor action.
- preferred(Collection<Lang>) - Method in class play.i18n.Langs
-
Select a preferred language, given the list of candidates.
- preferred(Collection<Lang>) - Method in class play.i18n.MessagesApi
-
Get a messages context appropriate for the given candidates.
- preferred(Application, List<Lang>) - Static method in class play.i18n.Lang
-
Guess the preferred lang in the langs set passed as argument.
- preferred(Http.RequestHeader) - Method in class play.http.PreferredMediaTypeHttpErrorHandler
- preferred(Http.RequestHeader) - Method in class play.i18n.MessagesApi
-
Get a messages context appropriate for the given request.
- PreferredMediaTypeHttpErrorHandler - Class in play.http
-
An `HttpErrorHandler` that delegates to one of several `HttpErrorHandlers` depending on the client's media type preference.
- PreferredMediaTypeHttpErrorHandler(LinkedHashMap<String, HttpErrorHandler>) - Constructor for class play.http.PreferredMediaTypeHttpErrorHandler
- prepare() - Method in class play.libs.concurrent.CustomExecutionContext
- prettyPrint(JsonNode) - Static method in class play.libs.Json
-
Converts a JsonNode to its string representation.
- print(A, T, Locale) - Method in class play.data.format.Formatters.AnnotationFormatter
-
Unbind this field (ie.
- print(Field, T) - Method in class play.data.format.Formatters
-
Computes the display string for any value, for a specific field.
- print(Date, Locale) - Method in class play.data.format.Formats.DateFormatter
-
Unbinds this fields - converts a concrete value to a plain string.
- print(TypeDescriptor, T) - Method in class play.data.format.Formatters
-
Computes the display string for any value, for a specific type.
- print(Formats.DateTime, Date, Locale) - Method in class play.data.format.Formats.AnnotationDateFormatter
-
Unbinds this field - converts a concrete value to plain string
- print(Formats.NonEmpty, String, Locale) - Method in class play.data.format.Formats.AnnotationNonEmptyFormatter
-
Unbinds this field - converts a concrete value to plain string
- print(T) - Method in class play.data.format.Formatters
-
Computes the display string for any value.
- print(T, Locale) - Method in class play.data.format.Formatters.SimpleFormatter
-
Unbinds this field - transforms a concrete value to plain string.
- processor() - Method in class play.filters.csp.AbstractCSPAction
- processor() - Method in class play.filters.csp.CSPAction
- PROD - play.Mode
- prodServerError(Http.RequestHeader, UsefulException) - Method in class play.http.JsonHttpErrorHandler
-
Invoked in prod mode when a server error occurs.
- PromiseTimeoutException(String) - Constructor for exception play.libs.F.PromiseTimeoutException
- PromiseTimeoutException(String, Throwable) - Constructor for exception play.libs.F.PromiseTimeoutException
- provideApplication() - Method in class play.test.WithApplication
-
Override this method to setup the application to use.
- provideApplication() - Method in class play.test.WithServer
-
Override this method to setup the application to use.
- provideBrowser(int) - Method in class play.test.WithBrowser
-
Override this if you want to use a different browser
- providePort() - Method in class play.test.WithServer
-
Override this method to setup the port to use.
- ProviderConstructionTarget<T> - Class in play.inject
-
A binding target that is provided by a provider class.
- ProviderConstructionTarget(Class<? extends Provider<? extends T>>) - Constructor for class play.inject.ProviderConstructionTarget
- ProviderConstructionTarget(ProviderConstructionTarget<T>) - Constructor for class play.inject.ProviderConstructionTarget
- providerOf(Class<T>, String) - Static method in class play.libs.Pekko
-
Create a provider for an actor implemented by the given class, with the given name.
- providerOf(Class<T>, String, Function<Props, Props>) - Static method in class play.libs.Pekko
-
Create a provider for an actor implemented by the given class, with the given name.
- ProviderTarget<T> - Class in play.inject
-
A binding target that is provided by a provider instance.
- ProviderTarget(Provider<? extends T>) - Constructor for class play.inject.ProviderTarget
- ProviderTarget(ProviderTarget<T>) - Constructor for class play.inject.ProviderTarget
- PROXY_AUTHENTICATE - Static variable in interface play.mvc.Http.HeaderNames
- PROXY_AUTHENTICATION_REQUIRED - Static variable in interface play.mvc.Http.Status
- PROXY_AUTHORIZATION - Static variable in interface play.mvc.Http.HeaderNames
- put(JsonNode) - Method in class play.libs.ws.ahc.AhcWSRequest
- put(JsonNode) - Method in interface play.libs.ws.WSRequest
-
Perform a PUT on the request asynchronously.
- put(File) - Method in class play.libs.ws.ahc.AhcWSRequest
- put(File) - Method in interface play.libs.ws.WSRequest
-
Perform a PUT on the request asynchronously.
- put(InputStream) - Method in class play.libs.ws.ahc.AhcWSRequest
-
Deprecated.
- put(InputStream) - Method in interface play.libs.ws.WSRequest
-
Deprecated.Deprecated as of 2.7.0. Use
WSRequest.put(BodyWritable)
instead. - put(String) - Method in class play.libs.ws.ahc.AhcWSRequest
- put(String) - Method in interface play.libs.ws.WSRequest
-
Perform a PUT on the request asynchronously.
- put(K, CompletableFuture<? extends V>) - Method in class play.cache.caffeine.NamedCaffeineCache
- put(Source<? super Http.MultipartFormData.Part<Source<ByteString, ?>>, ?>) - Method in class play.libs.ws.ahc.AhcWSRequest
- put(Source<? super Http.MultipartFormData.Part<Source<ByteString, ?>>, ?>) - Method in interface play.libs.ws.WSRequest
-
Perform a PUT on the request asynchronously.
- put(Document) - Method in class play.libs.ws.ahc.AhcWSRequest
- put(Document) - Method in interface play.libs.ws.WSRequest
-
Perform a PUT on the request asynchronously.
- put(TypedKey<A>, A) - Method in class play.libs.typedmap.TypedMap
-
Update the map with the given key and value, returning a new instance of the map.
- put(BodyWritable) - Method in class play.libs.ws.ahc.AhcWSRequest
- put(BodyWritable) - Method in interface play.libs.ws.WSRequest
-
Perform a PUT on the request asynchronously.
- PUT - Static variable in interface play.mvc.Http.HttpVerbs
- PUT - Static variable in class play.test.Helpers
- PUT(String) - Method in class play.routing.RoutingDsl
-
Create a PUT route for the given path pattern.
- putAll(List<TypedEntry<?>>) - Method in class play.libs.typedmap.TypedMap
-
Update the map with several entries, returning a new instance of the map.
- putAll(TypedEntry<?>) - Method in class play.libs.typedmap.TypedMap
-
Update the map with one entry, returning a new instance of the map.
- putAll(TypedEntry<?>...) - Method in class play.libs.typedmap.TypedMap
-
Update the map with several entries, returning a new instance of the map.
- putAll(TypedEntry<?>, TypedEntry<?>) - Method in class play.libs.typedmap.TypedMap
-
Update the map with two entries, returning a new instance of the map.
- putAll(TypedEntry<?>, TypedEntry<?>, TypedEntry<?>) - Method in class play.libs.typedmap.TypedMap
-
Update the map with three entries, returning a new instance of the map.
Q
- qualifiedWith(A) - Method in class play.inject.BindingKey
-
Qualify this binding key with the given instance of an annotation.
- qualifiedWith(Class<A>) - Method in class play.inject.BindingKey
-
Qualify this binding key with the given annotation.
- qualifiedWith(String) - Method in class play.inject.BindingKey
-
Qualify this binding key with the given name.
- QualifierAnnotation - Class in play.inject
-
A qualifier annotation.
- QualifierClass<T extends Annotation> - Class in play.inject
-
A qualifier annotation instance.
- QualifierClass(Class<T>) - Constructor for class play.inject.QualifierClass
- QualifierClass(QualifierClass<T>) - Constructor for class play.inject.QualifierClass
- QualifierInstance<T extends Annotation> - Class in play.inject
-
A qualifier annotation instance.
- QualifierInstance(QualifierInstance<T>) - Constructor for class play.inject.QualifierInstance
- QualifierInstance(T) - Constructor for class play.inject.QualifierInstance
- queryString() - Method in interface play.mvc.Http.RequestHeader
-
The query string content.
- queryString(String) - Method in interface play.mvc.Http.RequestHeader
-
Helper method to access a queryString parameter.
- QueryStringBindable<T extends QueryStringBindable<T>> - Interface in play.mvc
-
Binder for query string parameters.
- quitBrowser() - Method in class play.test.WithBrowser
R
- randomBoundary() - Static method in class play.mvc.MultipartFormatter
- RANGE - Static variable in interface play.mvc.Http.HeaderNames
- RangeResults - Class in play.mvc
-
Java API for Range results.
- RangeResults() - Constructor for class play.mvc.RangeResults
- RangeResults.SourceAndOffset - Class in play.mvc
- RangeResults.SourceFunction - Interface in play.mvc
- Raw(PlayBodyParsers) - Constructor for class play.mvc.BodyParser.Raw
- Raw(PlayBodyParsers, long, long) - Constructor for class play.mvc.BodyParser.Raw
- rawBodyParser() - Method in interface play.components.BodyParserComponents
- RawBuffer() - Constructor for class play.mvc.Http.RawBuffer
- rawData() - Method in class play.data.DynamicForm
- rawData() - Method in class play.data.Form
- ReadCommitted - play.db.TransactionIsolationLevel
- ReadUncommitted - play.db.TransactionIsolationLevel
- reason() - Method in class play.http.websocket.Message.Close
- reasonPhrase() - Method in class play.mvc.ResponseHeader
- reasonPhrase() - Method in class play.mvc.Result
-
Get the reason phrase, if it was set.
- recover(Function<? super Throwable, ? extends A>, Executor) - Method in class play.libs.streams.Accumulator
-
Recover from any errors encountered by the accumulator.
- recoverWith(Function<? super Throwable, ? extends CompletionStage<A>>, Executor) - Method in class play.libs.streams.Accumulator
-
Recover from any errors encountered by the accumulator.
- redirect(String) - Static method in class play.mvc.Results
-
Generates a 303 See Other result.
- redirect(String, Map<String, List<String>>) - Static method in class play.mvc.Results
-
Generates a 303 See Other result.
- redirect(Call) - Static method in class play.mvc.Results
-
Generates a 303 See Other result.
- RedirectHttpsComponents - Interface in play.filters.components
-
The Redirect to HTTPS filter components for compile time dependency injection.
- redirectHttpsConfiguration() - Method in interface play.filters.components.RedirectHttpsComponents
- redirectHttpsFilter() - Method in interface play.filters.components.RedirectHttpsComponents
- redirectLocation() - Method in class play.mvc.Result
-
Extracts the Location header of this Result value if this Result is a Redirect.
- redirectURL(String, String) - Method in class play.libs.openid.DefaultOpenIdClient
- redirectURL(String, String) - Method in interface play.libs.openid.OpenIdClient
-
Retrieve the URL where the user should be redirected to start the OpenID authentication process.
- redirectURL(String, String, Map<String, String>) - Method in class play.libs.openid.DefaultOpenIdClient
- redirectURL(String, String, Map<String, String>) - Method in interface play.libs.openid.OpenIdClient
-
Retrieve the URL where the user should be redirected to start the OpenID authentication process
- redirectURL(String, String, Map<String, String>, Map<String, String>) - Method in class play.libs.openid.DefaultOpenIdClient
- redirectURL(String, String, Map<String, String>, Map<String, String>) - Method in interface play.libs.openid.OpenIdClient
-
Retrieve the URL where the user should be redirected to start the OpenID authentication process.
- redirectURL(String, String, Map<String, String>, Map<String, String>, String) - Method in class play.libs.openid.DefaultOpenIdClient
- redirectURL(String, String, Map<String, String>, Map<String, String>, String) - Method in interface play.libs.openid.OpenIdClient
-
Retrieve the URL where the user should be redirected to start the OpenID authentication process.
- REFERER - Static variable in interface play.mvc.Http.HeaderNames
- REFERRER_POLICY - Static variable in interface play.mvc.Http.HeaderNames
- register(Class<T>, Formatters.AnnotationFormatter<A, T>) - Method in class play.data.format.Formatters
-
Registers an annotation-based formatter.
- register(Class<T>, Formatters.SimpleFormatter<T>) - Method in class play.data.format.Formatters
-
Registers a simple formatter.
- relative(String, String) - Static method in class play.core.Paths
-
Create a path to targetPath that's relative to the given startPath.
- relativeTo(String) - Method in class play.mvc.Call
-
Transform this call to a relative path.
- relativeTo(Http.RequestHeader) - Method in class play.mvc.Call
-
Transform this call to a relative path.
- releaseInstance(ConstraintValidator<?, ?>) - Method in class play.data.validation.DefaultConstraintValidatorFactory
- releaseInstance(ConstraintValidator<?, ?>) - Method in class play.data.validation.MappedConstraintValidatorFactory
- remoteAddress() - Method in class play.mvc.Http.RequestBuilder
- remoteAddress() - Method in interface play.mvc.Http.RequestHeader
-
The client IP address.
- remoteAddress(String) - Method in class play.mvc.Http.RequestBuilder
- remove(String) - Method in interface play.cache.AsyncCacheApi
-
Removes a value from the cache.
- remove(String) - Method in class play.cache.DefaultAsyncCacheApi
- remove(String) - Method in class play.cache.DefaultSyncCacheApi
- remove(String) - Method in interface play.cache.SyncCacheApi
-
Removes a value from the cache.
- remove(String) - Method in class play.cache.SyncCacheApiAdapter
- remove(String) - Method in class play.mvc.Http.Headers
-
Deprecated.Deprecated as of 2.8.0. Use
Http.Headers.removing(String)
instead. - remove(TypedKey<?>) - Method in class play.libs.typedmap.TypedMap
-
Removes a key from the map, returning a new instance of the map.
- remove(TypedKey<?>...) - Method in class play.libs.typedmap.TypedMap
-
Removes keys from the map, returning a new instance of the map.
- remove(TypedKey<?>, TypedKey<?>) - Method in class play.libs.typedmap.TypedMap
-
Removes two keys from the map, returning a new instance of the map.
- remove(TypedKey<?>, TypedKey<?>, TypedKey<?>) - Method in class play.libs.typedmap.TypedMap
-
Removes three keys from the map, returning a new instance of the map.
- removeAll() - Method in interface play.cache.AsyncCacheApi
-
Removes all values from the cache.
- removeAll() - Method in class play.cache.DefaultAsyncCacheApi
- removeAttr(TypedKey<?>) - Method in interface play.mvc.Http.Request
- removeAttr(TypedKey<?>) - Method in interface play.mvc.Http.RequestHeader
-
Create a new versions of this object with the given attribute removed.
- removeAttr(TypedKey<?>) - Method in class play.mvc.Result
-
Create a new versions of this object with the given attribute removed.
- removing(String) - Method in class play.mvc.Http.Headers
-
Remove a header.
- removing(String...) - Method in class play.mvc.Http.Flash
-
Returns a new flash with the given keys removed.
- removing(String...) - Method in class play.mvc.Http.Session
-
Returns a new session with the given keys removed.
- removingFromFlash(String...) - Method in class play.mvc.Result
-
Removes values from the flash.
- removingFromSession(Http.Request, String...) - Method in class play.mvc.Result
-
Removes values from the session.
- RepeatedRead - play.db.TransactionIsolationLevel
- reportFailure(Throwable) - Method in class play.libs.concurrent.CustomExecutionContext
- reportValidationStatus(Object, ConstraintValidatorContext) - Method in interface play.data.validation.Constraints.PlayConstraintValidator
- req - Variable in class play.mvc.Http.RequestBuilder
- REQUEST_ENTITY_TOO_LARGE - Static variable in interface play.mvc.Http.Status
- REQUEST_HEADER_FIELDS_TOO_LARGE - Static variable in interface play.mvc.Http.Status
- REQUEST_TIMEOUT - Static variable in interface play.mvc.Http.Status
- REQUEST_URI_TOO_LONG - Static variable in interface play.mvc.Http.Status
- RequestBody(Object) - Constructor for class play.mvc.Http.RequestBody
- RequestBuilder() - Constructor for class play.mvc.Http.RequestBuilder
-
Returns a simple request builder.
- RequestBuilder(RequestFactory) - Constructor for class play.mvc.Http.RequestBuilder
-
Returns a simple request builder.
- RequestBuilder(Http.RequestBuilder) - Constructor for class play.mvc.Http.RequestBuilder
-
Returns a request builder as copy of the passed request builder.
- requestData(Http.Request) - Method in class play.data.Form
- REQUESTED_RANGE_NOT_SATISFIABLE - Static variable in interface play.mvc.Http.Status
- requestFileData(Http.Request) - Method in class play.data.Form
- RequestFunctions - Class in play.routing
-
Define functions to be used with
RoutingDsl
. - RequestFunctions() - Constructor for class play.routing.RequestFunctions
- RequestFunctions.Params0<R> - Interface in play.routing
-
A function that receives a
Http.Request
, no parameters, and return a result type. - RequestFunctions.Params1<P,R> - Interface in play.routing
-
A function that receives a
Http.Request
, a single parameter, and return a result type. - RequestFunctions.Params2<P1,P2,R> - Interface in play.routing
-
A function that receives a
Http.Request
, two parameters, and return a result type. - RequestFunctions.Params3<P1,P2,P3,R> - Interface in play.routing
-
A function that receives a
Http.Request
, three parameters, and return a result type. - RequestFunctions.RequestFunction - Interface in play.routing
-
This is used to "tag" the functions which requires a request to execute.
- requestHeaderFieldsTooLarge() - Static method in class play.mvc.Results
-
Generates a 431 Request Header Fields Too Large result.
- requestHeaderFieldsTooLarge(byte[]) - Static method in class play.mvc.Results
-
Generates a 431 Request Header Fields Too Large result.
- requestHeaderFieldsTooLarge(JsonNode) - Static method in class play.mvc.Results
-
Generates a 431 Request Header Fields Too Large result.
- requestHeaderFieldsTooLarge(JsonNode, JsonEncoding) - Static method in class play.mvc.Results
-
Generates a 431 Request Header Fields Too Large result.
- requestHeaderFieldsTooLarge(File) - Static method in class play.mvc.Results
-
Generates a 431 Request Header Fields Too Large result.
- requestHeaderFieldsTooLarge(File, boolean) - Static method in class play.mvc.Results
-
Generates a 431 Request Header Fields Too Large result.
- requestHeaderFieldsTooLarge(File, boolean, Optional<String>) - Static method in class play.mvc.Results
-
Generates a 431 Request Header Fields Too Large result.
- requestHeaderFieldsTooLarge(File, boolean, Optional<String>, FileMimeTypes) - Static method in class play.mvc.Results
-
Generates a 431 Request Header Fields Too Large result.
- requestHeaderFieldsTooLarge(File, boolean, FileMimeTypes) - Static method in class play.mvc.Results
-
Generates a 431 Request Header Fields Too Large result.
- requestHeaderFieldsTooLarge(File, String) - Static method in class play.mvc.Results
-
Deprecated.Deprecated as of 2.8.0. Use to
Results.requestHeaderFieldsTooLarge(File, Optional)
. - requestHeaderFieldsTooLarge(File, String, FileMimeTypes) - Static method in class play.mvc.Results
-
Deprecated.Deprecated as of 2.8.0. Use to
Results.requestHeaderFieldsTooLarge(File, Optional, FileMimeTypes)
. - requestHeaderFieldsTooLarge(File, Optional<String>) - Static method in class play.mvc.Results
-
Generates a 431 Request Header Fields Too Large result.
- requestHeaderFieldsTooLarge(File, Optional<String>, FileMimeTypes) - Static method in class play.mvc.Results
-
Generates a 431 Request Header Fields Too Large result.
- requestHeaderFieldsTooLarge(File, FileMimeTypes) - Static method in class play.mvc.Results
-
Generates a 431 Request Header Fields Too Large result.
- requestHeaderFieldsTooLarge(InputStream) - Static method in class play.mvc.Results
-
Generates a 431 Request Header Fields Too Large result.
- requestHeaderFieldsTooLarge(InputStream, long) - Static method in class play.mvc.Results
-
Generates a 431 Request Header Fields Too Large result.
- requestHeaderFieldsTooLarge(String) - Static method in class play.mvc.Results
-
Generates a 431 Request Header Fields Too Large result.
- requestHeaderFieldsTooLarge(String, String) - Static method in class play.mvc.Results
-
Generates a 431 Request Header Fields Too Large result.
- requestHeaderFieldsTooLarge(Path) - Static method in class play.mvc.Results
-
Generates a 431 Request Header Fields Too Large result.
- requestHeaderFieldsTooLarge(Path, boolean) - Static method in class play.mvc.Results
-
Generates a 431 Request Header Fields Too Large result.
- requestHeaderFieldsTooLarge(Path, boolean, Optional<String>) - Static method in class play.mvc.Results
-
Generates a 431 Request Header Fields Too Large result.
- requestHeaderFieldsTooLarge(Path, boolean, Optional<String>, FileMimeTypes) - Static method in class play.mvc.Results
-
Generates a 431 Request Header Fields Too Large result.
- requestHeaderFieldsTooLarge(Path, boolean, FileMimeTypes) - Static method in class play.mvc.Results
-
Generates a 431 Request Header Fields Too Large result.
- requestHeaderFieldsTooLarge(Path, Optional<String>) - Static method in class play.mvc.Results
-
Generates a 431 Request Header Fields Too Large result.
- requestHeaderFieldsTooLarge(Path, Optional<String>, FileMimeTypes) - Static method in class play.mvc.Results
-
Generates a 431 Request Header Fields Too Large result.
- requestHeaderFieldsTooLarge(Path, FileMimeTypes) - Static method in class play.mvc.Results
-
Generates a 431 Request Header Fields Too Large result.
- requestHeaderFieldsTooLarge(Content) - Static method in class play.mvc.Results
-
Generates a 431 Request Header Fields Too Large result.
- requestHeaderFieldsTooLarge(Content, String) - Static method in class play.mvc.Results
-
Generates a 431 Request Header Fields Too Large result.
- RequestImpl(Request<Http.RequestBody>) - Constructor for class play.mvc.Http.RequestImpl
-
Constructor with a
Http.RequestBody
. - RequireCSRFCheck - Annotation Type in play.filters.csrf
-
This action requires a CSRF check.
- requireCSRFCheckAction() - Method in interface play.filters.components.CSRFComponents
- RequireCSRFCheckAction - Class in play.filters.csrf
- RequireCSRFCheckAction(CSRFConfig, SessionConfiguration, CSRF.TokenProvider, CSRFTokenSigner, Function<RequireCSRFCheck, CSRFErrorHandler>) - Constructor for class play.filters.csrf.RequireCSRFCheckAction
- RequireCSRFCheckAction(CSRFConfig, SessionConfiguration, CSRF.TokenProvider, CSRFTokenSigner, CSRFErrorHandler) - Constructor for class play.filters.csrf.RequireCSRFCheckAction
- RequireCSRFCheckAction(CSRFConfig, SessionConfiguration, CSRF.TokenProvider, CSRFTokenSigner, Injector) - Constructor for class play.filters.csrf.RequireCSRFCheckAction
- required() - Static method in class play.data.validation.Constraints
-
Constructs a 'required' validator.
- RequiredValidator() - Constructor for class play.data.validation.Constraints.RequiredValidator
- RESET_CONTENT - Static variable in interface play.mvc.Http.Status
- resolveDuplicateFilePartKeys(List<Http.MultipartFormData.FilePart<A>>) - Method in class play.data.Form
- resource(String) - Method in class play.Environment
-
Retrieves a resource from the classpath.
- resourceAsStream(String) - Method in class play.Environment
-
Retrieves a resource stream from the classpath.
- Resources - Class in play.libs
-
Provides utility functions to work with resources.
- Resources() - Constructor for class play.libs.Resources
- ResponseHeader - Class in play.mvc
-
A simple HTTP response header, used for standard responses.
- ResponseHeader(int, Map<String, String>) - Constructor for class play.mvc.ResponseHeader
- ResponseHeader(int, Map<String, String>, String) - Constructor for class play.mvc.ResponseHeader
- Result - Class in play.mvc
-
Any action result.
- Result(int) - Constructor for class play.mvc.Result
-
Create a result with no entity.
- Result(int, String, Map<String, String>, HttpEntity) - Constructor for class play.mvc.Result
-
Create a result.
- Result(int, Map<String, String>) - Constructor for class play.mvc.Result
-
Create a result with no body.
- Result(int, Map<String, String>, HttpEntity) - Constructor for class play.mvc.Result
-
Create a result.
- Result(int, HttpEntity) - Constructor for class play.mvc.Result
-
Create a result.
- Result(ResponseHeader, HttpEntity) - Constructor for class play.mvc.Result
-
Create a result from a Scala ResponseHeader and a body.
- Result(ResponseHeader, HttpEntity, Http.Session, Http.Flash, List<Http.Cookie>) - Constructor for class play.mvc.Result
-
Create a result from a Scala ResponseHeader and a body.
- Result(ResponseHeader, HttpEntity, Http.Session, Http.Flash, List<Http.Cookie>, TypedMap) - Constructor for class play.mvc.Result
-
Create a result from a Scala ResponseHeader and a body.
- Results - Class in play.mvc
-
Common results.
- Results() - Constructor for class play.mvc.Results
- RETRY_AFTER - Static variable in interface play.mvc.Http.HeaderNames
- right - Variable in class play.libs.F.Either
-
The right value.
- Right(R) - Static method in class play.libs.F.Either
-
Constructs a right side of the disjoint union, as opposed to the Left side.
- rootPath() - Method in class play.Environment
-
The root path that the application is deployed at.
- route(Application, Call) - Static method in class play.test.Helpers
-
Route a call using the given application.
- route(Application, Call, long) - Static method in class play.test.Helpers
-
Route a call using the given application and timeout.
- route(Application, Http.RequestBuilder) - Static method in class play.test.Helpers
-
Route a request.
- route(Application, Http.RequestBuilder, long) - Static method in class play.test.Helpers
-
Route the request considering the given timeout.
- route(Http.RequestHeader) - Method in interface play.routing.Router
- routeAndCall(Application, Router, Http.RequestBuilder) - Static method in class play.test.Helpers
-
Route and call the request.
- routeAndCall(Application, Router, Http.RequestBuilder, long) - Static method in class play.test.Helpers
-
Route and call the request, respecting the given timeout.
- RouteDocumentation(String, String, String) - Constructor for class play.routing.Router.RouteDocumentation
- router() - Method in interface play.components.BaseComponents
- Router - Interface in play.routing
-
The Java Router API
- Router.Attrs - Class in play.routing
-
Request attributes used by the router.
- Router.RouteDocumentation - Class in play.routing
- routerPackage() - Method in class play.routing.HandlerDef
- routingAsync(RequestFunctions.Params0<? extends CompletionStage<Result>>) - Method in class play.routing.RoutingDsl.PathPatternMatcher
-
Route async with the request and no parameters.
- routingAsync(RequestFunctions.Params1<P1, ? extends CompletionStage<Result>>) - Method in class play.routing.RoutingDsl.PathPatternMatcher
-
Route async with request and a single parameter.
- routingAsync(RequestFunctions.Params2<P1, P2, ? extends CompletionStage<Result>>) - Method in class play.routing.RoutingDsl.PathPatternMatcher
-
Route async with request and two parameters.
- routingAsync(RequestFunctions.Params3<A1, A2, A3, ? extends CompletionStage<Result>>) - Method in class play.routing.RoutingDsl.PathPatternMatcher
-
Route async with request and three parameters.
- routingDsl() - Method in interface play.routing.RoutingDslComponents
- RoutingDsl - Class in play.routing
-
A DSL for building a router.
- RoutingDsl(BodyParser.Default) - Constructor for class play.routing.RoutingDsl
- RoutingDsl(BodyParser.Default, JavaContextComponents) - Constructor for class play.routing.RoutingDsl
-
Deprecated.Deprecated as of 2.8.0. Use constructor without JavaContextComponents
- RoutingDsl.PathPatternMatcher - Class in play.routing
-
A matcher for routes.
- RoutingDslComponents - Interface in play.routing
-
Java Components for RoutingDsl.
- RoutingDslComponentsFromContext - Class in play.routing
-
RoutingDsl components from the built in components.
- RoutingDslComponentsFromContext(ApplicationLoader.Context) - Constructor for class play.routing.RoutingDslComponentsFromContext
- routingTo(RequestFunctions.Params0<Result>) - Method in class play.routing.RoutingDsl.PathPatternMatcher
-
Route with the request and no parameters.
- routingTo(RequestFunctions.Params1<P1, Result>) - Method in class play.routing.RoutingDsl.PathPatternMatcher
-
Route with the request and a single parameter.
- routingTo(RequestFunctions.Params2<P1, P2, Result>) - Method in class play.routing.RoutingDsl.PathPatternMatcher
-
Route with the request and two parameter.
- routingTo(RequestFunctions.Params3<P1, P2, P3, Result>) - Method in class play.routing.RoutingDsl.PathPatternMatcher
-
Route with the request and three parameter.
- run(E, Materializer) - Method in class play.libs.streams.Accumulator
-
Run the accumulator with a single element.
- run(Connection) - Method in interface play.db.ConnectionRunnable
- run(Source<E, ?>, Materializer) - Method in class play.libs.streams.Accumulator
-
Run the accumulator with the given source.
- run(Materializer) - Method in class play.libs.streams.Accumulator
-
Run the accumulator with an empty source.
- running(Application, Runnable) - Static method in class play.test.Helpers
-
Executes a block of code in a running application.
- running(TestServer, Class<? extends WebDriver>, Consumer<TestBrowser>) - Static method in class play.test.Helpers
-
Executes a block of code in a running server, with a test browser.
- running(TestServer, Runnable) - Static method in class play.test.Helpers
-
Executes a block of code in a running server.
- running(TestServer, WebDriver, Consumer<TestBrowser>) - Static method in class play.test.Helpers
-
Executes a block of code in a running server, with a test browser.
S
- sameSite() - Method in interface play.core.cookie.encoding.Cookie
-
Returns the SameSite attribute of this cookie as a String
- sameSite() - Method in class play.core.cookie.encoding.DefaultCookie
- sameSite() - Method in class play.mvc.Http.Cookie
- SAX_FEATURE_PREFIX - Static variable in class play.libs.XML.Constants
- Scala - Class in play.libs
-
Class that contains useful java <-> scala conversion helpers.
- Scala() - Constructor for class play.libs.Scala
- scalaBodyParsers() - Method in interface play.components.BodyParserComponents
- scalaHttpErrorHandler() - Method in interface play.components.HttpErrorHandlerComponents
- scheduler() - Method in interface play.components.PekkoTypedComponents
- script() - Method in class play.i18n.Lang
-
The script tag for this Lang
- SECOND - Static variable in class play.libs.Time.CronExpression
- seconds - Variable in class play.libs.Time.CronExpression
- secure() - Method in class play.mvc.Http.Cookie
- secure() - Method in class play.mvc.Http.RequestBuilder
- secure() - Method in interface play.mvc.Http.RequestHeader
- secure(boolean) - Method in class play.mvc.Http.RequestBuilder
- Security - Class in play.mvc
-
Defines several security helpers.
- Security() - Constructor for class play.mvc.Security
- Security.Authenticated - Annotation Type in play.mvc
-
Wraps the annotated action in an
Security.AuthenticatedAction
. - Security.AuthenticatedAction - Class in play.mvc
-
Wraps another action, allowing only authenticated HTTP requests.
- Security.Authenticator - Class in play.mvc
-
Handles authentication.
- SecurityHeadersComponents - Interface in play.filters.components
-
The security headers Java components.
- securityHeadersConfig() - Method in interface play.filters.components.SecurityHeadersComponents
- securityHeadersFilter() - Method in interface play.filters.components.SecurityHeadersComponents
- SEE_OTHER - Static variable in interface play.mvc.Http.Status
- seeOther(String) - Static method in class play.mvc.Results
-
Generates a 303 See Other result.
- seeOther(Call) - Static method in class play.mvc.Results
-
Generates a 303 See Other result.
- selectNode(String, Object) - Static method in class play.libs.XPath
- selectNode(String, Object, Map<String, String>) - Static method in class play.libs.XPath
- selectNodes(String, Object) - Static method in class play.libs.XPath
-
Select all nodes that are selected by this XPath expression.
- selectNodes(String, Object, Map<String, String>) - Static method in class play.libs.XPath
-
Select all nodes that are selected by this XPath expression.
- selectText(String, Object) - Static method in class play.libs.XPath
- selectText(String, Object, Map<String, String>) - Static method in class play.libs.XPath
- sendBytes(byte[]) - Method in class play.mvc.StatusHeader
-
Send the given bytes.
- sendBytes(byte[], boolean, Optional<String>) - Method in class play.mvc.StatusHeader
-
Send the given bytes.
- sendBytes(byte[], boolean, Optional<String>, FileMimeTypes) - Method in class play.mvc.StatusHeader
-
Send the given bytes.
- sendBytes(byte[], Optional<String>) - Method in class play.mvc.StatusHeader
-
Send the given bytes.
- sendByteString(ByteString) - Method in class play.mvc.StatusHeader
-
Send the given ByteString.
- sendByteString(ByteString, boolean, Optional<String>) - Method in class play.mvc.StatusHeader
-
Send the given ByteString.
- sendByteString(ByteString, boolean, Optional<String>, FileMimeTypes) - Method in class play.mvc.StatusHeader
-
Send the given ByteString.
- sendByteString(ByteString, Optional<String>) - Method in class play.mvc.StatusHeader
-
Send the given ByteString.
- sendEntity(HttpEntity) - Method in class play.mvc.StatusHeader
-
Send an HTTP entity.
- sendEntity(HttpEntity, boolean, Optional<String>) - Method in class play.mvc.StatusHeader
-
Send an HTTP entity.
- sendEntity(HttpEntity, boolean, Optional<String>, FileMimeTypes) - Method in class play.mvc.StatusHeader
-
Send an HTTP entity.
- sendFile(File) - Method in class play.mvc.StatusHeader
-
Sends the given file using the default inline mode.
- sendFile(File, boolean) - Method in class play.mvc.StatusHeader
-
Sends the given file.
- sendFile(File, boolean, Runnable, Executor) - Method in class play.mvc.StatusHeader
-
Sends the given file.
- sendFile(File, boolean, String) - Method in class play.mvc.StatusHeader
-
Deprecated.Deprecated as of 2.8.0. Use to
StatusHeader.sendFile(File, boolean, Optional)
. - sendFile(File, boolean, String, FileMimeTypes) - Method in class play.mvc.StatusHeader
-
Deprecated.Deprecated as of 2.8.0. Use to
StatusHeader.sendFile(File, boolean, Optional, FileMimeTypes)
. - sendFile(File, boolean, Optional<String>) - Method in class play.mvc.StatusHeader
-
Send the given file.
- sendFile(File, boolean, Optional<String>, Runnable, Executor) - Method in class play.mvc.StatusHeader
-
Send the given file.
- sendFile(File, boolean, Optional<String>, FileMimeTypes) - Method in class play.mvc.StatusHeader
-
Send the given file.
- sendFile(File, boolean, Optional<String>, FileMimeTypes, Runnable, Executor) - Method in class play.mvc.StatusHeader
-
Send the given file.
- sendFile(File, boolean, FileMimeTypes) - Method in class play.mvc.StatusHeader
-
Sends the given file.
- sendFile(File, boolean, FileMimeTypes, Runnable, Executor) - Method in class play.mvc.StatusHeader
-
Sends the given file.
- sendFile(File, Runnable, Executor) - Method in class play.mvc.StatusHeader
-
Sends the given file using the default inline mode.
- sendFile(File, String) - Method in class play.mvc.StatusHeader
-
Deprecated.Deprecated as of 2.8.0. Use to
StatusHeader.sendFile(File, Optional)
. - sendFile(File, String, FileMimeTypes) - Method in class play.mvc.StatusHeader
-
Deprecated.Deprecated as of 2.8.0. Use to
StatusHeader.sendFile(File, Optional, FileMimeTypes)
. - sendFile(File, Optional<String>) - Method in class play.mvc.StatusHeader
-
Send the given file.
- sendFile(File, Optional<String>, Runnable, Executor) - Method in class play.mvc.StatusHeader
-
Send the given file.
- sendFile(File, Optional<String>, FileMimeTypes) - Method in class play.mvc.StatusHeader
-
Send the given file.
- sendFile(File, Optional<String>, FileMimeTypes, Runnable, Executor) - Method in class play.mvc.StatusHeader
-
Send the given file.
- sendFile(File, FileMimeTypes) - Method in class play.mvc.StatusHeader
-
Sends the given file using the default inline mode.
- sendFile(File, FileMimeTypes, Runnable, Executor) - Method in class play.mvc.StatusHeader
-
Sends the given file using the default inline mode.
- sendInputStream(InputStream) - Method in class play.mvc.StatusHeader
-
Send the given input stream.
- sendInputStream(InputStream, long) - Method in class play.mvc.StatusHeader
-
Send the given input stream.
- sendInputStream(InputStream, long, Runnable, Executor) - Method in class play.mvc.StatusHeader
-
Send the given input stream.
- sendInputStream(InputStream, long, Optional<String>) - Method in class play.mvc.StatusHeader
-
Send the given input stream.
- sendInputStream(InputStream, long, Optional<String>, Runnable, Executor) - Method in class play.mvc.StatusHeader
-
Send the given input stream.
- sendInputStream(InputStream, Runnable, Executor) - Method in class play.mvc.StatusHeader
-
Send the given input stream.
- sendInputStream(InputStream, Optional<String>) - Method in class play.mvc.StatusHeader
-
Send the given input stream.
- sendInputStream(InputStream, Optional<String>, Runnable, Executor) - Method in class play.mvc.StatusHeader
-
Send the given input stream.
- sendJson(JsonNode) - Method in class play.mvc.StatusHeader
-
Send a json result.
- sendJson(JsonNode, boolean, Optional<String>) - Method in class play.mvc.StatusHeader
-
Send a json result.
- sendJson(JsonNode, JsonEncoding) - Method in class play.mvc.StatusHeader
-
Send a json result.
- sendJson(JsonNode, JsonEncoding, boolean, Optional<String>) - Method in class play.mvc.StatusHeader
-
Send a json result.
- sendPath(Path) - Method in class play.mvc.StatusHeader
-
Sends the given path if it is a valid file.
- sendPath(Path, boolean) - Method in class play.mvc.StatusHeader
-
Sends the given path if it is a valid file.
- sendPath(Path, boolean, Runnable, Executor) - Method in class play.mvc.StatusHeader
-
Sends the given path if it is a valid file.
- sendPath(Path, boolean, String) - Method in class play.mvc.StatusHeader
-
Deprecated.Deprecated as of 2.8.0. Use to
StatusHeader.sendPath(Path, boolean, Optional)
. - sendPath(Path, boolean, String, FileMimeTypes) - Method in class play.mvc.StatusHeader
-
Deprecated.Deprecated as of 2.8.0. Use to
StatusHeader.sendPath(Path, boolean, Optional, FileMimeTypes)
. - sendPath(Path, boolean, Optional<String>) - Method in class play.mvc.StatusHeader
-
Sends the given path if it is a valid file.
- sendPath(Path, boolean, Optional<String>, Runnable, Executor) - Method in class play.mvc.StatusHeader
-
Sends the given path if it is a valid file.
- sendPath(Path, boolean, Optional<String>, FileMimeTypes) - Method in class play.mvc.StatusHeader
-
Sends the given path if it is a valid file.
- sendPath(Path, boolean, Optional<String>, FileMimeTypes, Runnable, Executor) - Method in class play.mvc.StatusHeader
-
Sends the given path if it is a valid file.
- sendPath(Path, boolean, FileMimeTypes) - Method in class play.mvc.StatusHeader
-
Sends the given path if it is a valid file.
- sendPath(Path, boolean, FileMimeTypes, Runnable, Executor) - Method in class play.mvc.StatusHeader
-
Sends the given path if it is a valid file.
- sendPath(Path, Runnable, Executor) - Method in class play.mvc.StatusHeader
-
Sends the given path if it is a valid file.
- sendPath(Path, String) - Method in class play.mvc.StatusHeader
-
Deprecated.Deprecated as of 2.8.0. Use to
StatusHeader.sendPath(Path, Optional)
. - sendPath(Path, String, FileMimeTypes) - Method in class play.mvc.StatusHeader
-
Deprecated.Deprecated as of 2.8.0. Use to
StatusHeader.sendPath(Path, Optional, FileMimeTypes)
. - sendPath(Path, Optional<String>) - Method in class play.mvc.StatusHeader
-
Sends the given path if it is a valid file.
- sendPath(Path, Optional<String>, Runnable, Executor) - Method in class play.mvc.StatusHeader
-
Sends the given path if it is a valid file.
- sendPath(Path, Optional<String>, FileMimeTypes) - Method in class play.mvc.StatusHeader
-
Sends the given path if it is a valid file.
- sendPath(Path, Optional<String>, FileMimeTypes, Runnable, Executor) - Method in class play.mvc.StatusHeader
-
Sends the given path if it is a valid file.
- sendPath(Path, FileMimeTypes) - Method in class play.mvc.StatusHeader
-
Sends the given path if it is a valid file.
- sendPath(Path, FileMimeTypes, Runnable, Executor) - Method in class play.mvc.StatusHeader
-
Sends the given path if it is a valid file.
- sendResource(String) - Method in class play.mvc.StatusHeader
-
Send the given resource.
- sendResource(String, boolean) - Method in class play.mvc.StatusHeader
-
Send the given resource.
- sendResource(String, boolean, Runnable, Executor) - Method in class play.mvc.StatusHeader
-
Send the given resource.
- sendResource(String, boolean, String) - Method in class play.mvc.StatusHeader
-
Deprecated.Deprecated as of 2.8.0. Use
StatusHeader.sendResource(String,boolean,Optional)
. - sendResource(String, boolean, String, FileMimeTypes) - Method in class play.mvc.StatusHeader
-
Deprecated.Deprecated as of 2.8.0. Use to
StatusHeader.sendResource(String, boolean, Optional, FileMimeTypes)
. - sendResource(String, boolean, Optional<String>) - Method in class play.mvc.StatusHeader
-
Send the given resource.
- sendResource(String, boolean, Optional<String>, Runnable, Executor) - Method in class play.mvc.StatusHeader
-
Send the given resource.
- sendResource(String, boolean, Optional<String>, FileMimeTypes) - Method in class play.mvc.StatusHeader
-
Send the given resource.
- sendResource(String, boolean, Optional<String>, FileMimeTypes, Runnable, Executor) - Method in class play.mvc.StatusHeader
-
Send the given resource.
- sendResource(String, boolean, FileMimeTypes) - Method in class play.mvc.StatusHeader
-
Send the given resource.
- sendResource(String, boolean, FileMimeTypes, Runnable, Executor) - Method in class play.mvc.StatusHeader
-
Send the given resource.
- sendResource(String, ClassLoader) - Method in class play.mvc.StatusHeader
-
Send the given resource from the given classloader.
- sendResource(String, ClassLoader, boolean) - Method in class play.mvc.StatusHeader
-
Send the given resource from the given classloader.
- sendResource(String, ClassLoader, boolean, Runnable, Executor) - Method in class play.mvc.StatusHeader
-
Send the given resource from the given classloader.
- sendResource(String, ClassLoader, boolean, String) - Method in class play.mvc.StatusHeader
-
Deprecated.Deprecated as of 2.8.0. Use to
StatusHeader.sendResource(String, ClassLoader, boolean, Optional)
. - sendResource(String, ClassLoader, boolean, String, FileMimeTypes) - Method in class play.mvc.StatusHeader
-
Deprecated.Deprecated as of 2.8.0. Use to
StatusHeader.sendResource(String, ClassLoader, boolean, Optional, FileMimeTypes)
. - sendResource(String, ClassLoader, boolean, Optional<String>) - Method in class play.mvc.StatusHeader
-
Send the given resource from the given classloader.
- sendResource(String, ClassLoader, boolean, Optional<String>, Runnable, Executor) - Method in class play.mvc.StatusHeader
-
Send the given resource from the given classloader.
- sendResource(String, ClassLoader, boolean, Optional<String>, FileMimeTypes) - Method in class play.mvc.StatusHeader
-
Send the given resource from the given classloader.
- sendResource(String, ClassLoader, boolean, Optional<String>, FileMimeTypes, Runnable, Executor) - Method in class play.mvc.StatusHeader
-
Send the given resource from the given classloader.
- sendResource(String, ClassLoader, boolean, FileMimeTypes) - Method in class play.mvc.StatusHeader
-
Send the given resource from the given classloader.
- sendResource(String, ClassLoader, boolean, FileMimeTypes, Runnable, Executor) - Method in class play.mvc.StatusHeader
-
Send the given resource from the given classloader.
- sendResource(String, ClassLoader, Runnable, Executor) - Method in class play.mvc.StatusHeader
-
Send the given resource from the given classloader.
- sendResource(String, ClassLoader, Optional<String>) - Method in class play.mvc.StatusHeader
-
Send the given resource from the given classloader.
- sendResource(String, ClassLoader, Optional<String>, Runnable, Executor) - Method in class play.mvc.StatusHeader
-
Send the given resource from the given classloader.
- sendResource(String, ClassLoader, Optional<String>, FileMimeTypes) - Method in class play.mvc.StatusHeader
-
Send the given resource from the given classloader.
- sendResource(String, ClassLoader, Optional<String>, FileMimeTypes, Runnable, Executor) - Method in class play.mvc.StatusHeader
-
Send the given resource from the given classloader.
- sendResource(String, ClassLoader, FileMimeTypes) - Method in class play.mvc.StatusHeader
-
Send the given resource from the given classloader.
- sendResource(String, ClassLoader, FileMimeTypes, Runnable, Executor) - Method in class play.mvc.StatusHeader
-
Send the given resource from the given classloader.
- sendResource(String, Runnable, Executor) - Method in class play.mvc.StatusHeader
-
Send the given resource.
- sendResource(String, Optional<String>) - Method in class play.mvc.StatusHeader
-
Send the given resource.
- sendResource(String, Optional<String>, Runnable, Executor) - Method in class play.mvc.StatusHeader
-
Send the given resource.
- sendResource(String, Optional<String>, FileMimeTypes) - Method in class play.mvc.StatusHeader
-
Send the given resource.
- sendResource(String, Optional<String>, FileMimeTypes, Runnable, Executor) - Method in class play.mvc.StatusHeader
-
Send the given resource.
- sendResource(String, FileMimeTypes) - Method in class play.mvc.StatusHeader
-
Send the given resource.
- sendResource(String, FileMimeTypes, Runnable, Executor) - Method in class play.mvc.StatusHeader
-
Send the given resource.
- sequence(Iterable<? extends CompletionStage<A>>) - Static method in interface play.libs.concurrent.Futures
-
Combine the given CompletionStages into a single
CompletionStage
for the list of results. - sequence(CompletionStage<A>...) - Static method in interface play.libs.concurrent.Futures
-
Combine the given CompletionStages into a single CompletionStage for the list of results.
- Serializable - play.db.TransactionIsolationLevel
- Server - Class in play.server
-
A Play server.
- Server(Server) - Constructor for class play.server.Server
- SERVER - Static variable in interface play.mvc.Http.HeaderNames
- Server.Builder - Class in play.server
-
Configures and builds an embedded server.
- Server.Protocol - Enum in play.server
-
Specifies the protocols supported by the server.
- ServerCookieDecoder - Class in play.core.cookie.encoding
-
A RFC6265 compliant cookie decoder to be used server side.
- ServerCookieEncoder - Class in play.core.cookie.encoding
-
A RFC6265 compliant cookie encoder to be used server side, so some fields are sent (Version is typically ignored).
- SERVICE_UNAVAILABLE - Static variable in interface play.mvc.Http.Status
- session() - Method in class play.mvc.Http.RequestBuilder
- session() - Method in interface play.mvc.Http.RequestHeader
-
Parses the Session cookie and returns the Session data.
- session() - Method in class play.mvc.Result
-
Extracts the Session of this Result value.
- session(String, String) - Method in class play.mvc.Http.RequestBuilder
-
Sets a session.
- session(Map<String, String>) - Method in class play.mvc.Http.RequestBuilder
-
Sets all parameters for the session.
- session(Http.Request) - Method in class play.mvc.Result
- Session() - Constructor for class play.mvc.Http.Session
- Session(Map<String, String>) - Constructor for class play.mvc.Http.Session
- Session(Session) - Constructor for class play.mvc.Http.Session
- sessionConfiguration() - Method in interface play.components.HttpConfigurationComponents
- set(String, Object) - Method in interface play.cache.AsyncCacheApi
-
Sets a value without expiration.
- set(String, Object) - Method in class play.cache.DefaultAsyncCacheApi
- set(String, Object) - Method in class play.cache.DefaultSyncCacheApi
- set(String, Object) - Method in interface play.cache.SyncCacheApi
-
Sets a value without expiration.
- set(String, Object) - Method in class play.cache.SyncCacheApiAdapter
- set(String, Object, int) - Method in interface play.cache.AsyncCacheApi
-
Sets a value with expiration.
- set(String, Object, int) - Method in class play.cache.DefaultAsyncCacheApi
- set(String, Object, int) - Method in class play.cache.DefaultSyncCacheApi
- set(String, Object, int) - Method in interface play.cache.SyncCacheApi
-
Sets a value with expiration.
- set(String, Object, int) - Method in class play.cache.SyncCacheApiAdapter
- SET_COOKIE - Static variable in interface play.mvc.Http.HeaderNames
- SET_COOKIE2 - Static variable in interface play.mvc.Http.HeaderNames
- setAuth(String) - Method in class play.libs.ws.ahc.AhcWSRequest
- setAuth(String) - Method in interface play.libs.ws.WSRequest
-
Sets the authentication header for the current request using BASIC authentication.
- setAuth(String, String) - Method in class play.libs.ws.ahc.AhcWSRequest
- setAuth(String, String) - Method in interface play.libs.ws.WSRequest
-
Sets the authentication header for the current request using BASIC authentication.
- setAuth(String, String, WSAuthScheme) - Method in class play.libs.ws.ahc.AhcWSRequest
- setAuth(String, String, WSAuthScheme) - Method in interface play.libs.ws.WSRequest
-
Sets the authentication header for the current request.
- setAuth(WSAuthInfo) - Method in class play.libs.ws.ahc.AhcWSRequest
- setBody(JsonNode) - Method in class play.libs.ws.ahc.AhcWSRequest
- setBody(JsonNode) - Method in interface play.libs.ws.WSRequest
-
Set the body this request should use.
- setBody(File) - Method in class play.libs.ws.ahc.AhcWSRequest
- setBody(File) - Method in interface play.libs.ws.WSRequest
-
Set the body this request should use.
- setBody(InputStream) - Method in class play.libs.ws.ahc.AhcWSRequest
-
Deprecated.
- setBody(InputStream) - Method in interface play.libs.ws.WSRequest
-
Deprecated.Deprecated as of 2.6.0. Use
WSRequest.setBody(BodyWritable)
instead. - setBody(String) - Method in class play.libs.ws.ahc.AhcWSRequest
- setBody(String) - Method in interface play.libs.ws.WSRequest
-
Set the body this request should use.
- setBody(Source<ByteString, U>) - Method in class play.libs.ws.ahc.AhcWSRequest
- setBody(Source<ByteString, U>) - Method in interface play.libs.ws.WSRequest
-
Set the body this request should use.
- setBody(BodyWritable) - Method in class play.libs.ws.ahc.AhcWSRequest
- setBody(BodyWritable) - Method in interface play.libs.ws.WSRequest
-
Set the body this request should use.
- setCalendarHour(Calendar, int) - Method in class play.libs.Time.CronExpression
-
Advance the calendar to the particular hour paying particular attention to daylight saving problems.
- setContentType(String) - Method in class play.libs.ws.ahc.AhcWSRequest
- setContentType(String) - Method in interface play.libs.ws.WSRequest
-
Set the content type.
- setContextComponents(JavaContextComponents) - Method in class play.mvc.Action
-
Deprecated.Deprecated as of 2.8.0. Method does nothing.
- setCookies(List<WSCookie>) - Method in class play.libs.ws.ahc.AhcWSRequest
- setCookies(List<WSCookie>) - Method in interface play.libs.ws.WSRequest
-
Sets all the cookies on the request.
- setData(Map<String, Object>) - Method in class play.data.DynamicForm.Dynamic
-
Sets the new data.
- setDisableUrlEncoding(boolean) - Method in class play.libs.ws.ahc.AhcWSRequest
- setDomain(String) - Method in interface play.core.cookie.encoding.Cookie
-
Sets the domain of this
Cookie
. - setDomain(String) - Method in class play.core.cookie.encoding.DefaultCookie
- setFileMimeTypes(FileMimeTypes) - Static method in class play.mvc.StaticFileMimeTypes
- setFollowRedirects(boolean) - Method in class play.libs.ws.ahc.AhcWSRequest
- setFollowRedirects(boolean) - Method in interface play.libs.ws.WSRequest
-
Sets whether redirects (301, 302) should be followed automatically.
- setHeader(String, String) - Method in class play.libs.ws.ahc.AhcWSRequest
-
Deprecated.use addHeader(name, value)
- setHeader(String, String) - Method in interface play.libs.ws.WSRequest
-
Deprecated.
- setHeaders(Map<String, List<String>>) - Method in class play.libs.ws.ahc.AhcWSRequest
- setHeaders(Map<String, List<String>>) - Method in interface play.libs.ws.WSRequest
-
Sets all of the headers on the request.
- setHttpOnly(boolean) - Method in interface play.core.cookie.encoding.Cookie
-
Determines if this
Cookie
is HTTP only. - setHttpOnly(boolean) - Method in class play.core.cookie.encoding.DefaultCookie
- setLang(Result, Lang) - Method in class play.i18n.MessagesApi
-
Given a Result and a Lang, return a new Result with the lang cookie set to the given Lang.
- setMaxAge(int) - Method in interface play.core.cookie.encoding.Cookie
-
Sets the maximum age of this
Cookie
in seconds. - setMaxAge(int) - Method in class play.core.cookie.encoding.DefaultCookie
- setMethod(String) - Method in class play.libs.ws.ahc.AhcWSRequest
- setMethod(String) - Method in interface play.libs.ws.WSRequest
-
Sets the HTTP method this request should use, where the no args execute() method is invoked.
- setObjectMapper(ObjectMapper) - Static method in class play.libs.Json
-
Inject the object mapper to use.
- setPath(String) - Method in interface play.core.cookie.encoding.Cookie
-
Sets the path of this
Cookie
. - setPath(String) - Method in class play.core.cookie.encoding.DefaultCookie
- setQueryParameter(String, String) - Method in class play.libs.ws.ahc.AhcWSRequest
-
Deprecated.Use addQueryParameter
- setQueryParameter(String, String) - Method in interface play.libs.ws.WSRequest
-
Deprecated.
- setQueryString(String) - Method in class play.libs.ws.ahc.AhcWSRequest
- setQueryString(String) - Method in interface play.libs.ws.WSRequest
-
Sets the query string to query.
- setQueryString(Map<String, List<String>>) - Method in class play.libs.ws.ahc.AhcWSRequest
- setQueryString(Map<String, List<String>>) - Method in interface play.libs.ws.WSRequest
-
Sets the query string to query.
- setRequestFilter(WSRequestFilter) - Method in class play.libs.ws.ahc.AhcWSRequest
- setRequestFilter(WSRequestFilter) - Method in interface play.libs.ws.WSRequest
-
Adds a request filter.
- setRequestTimeout(long) - Method in class play.libs.ws.ahc.AhcWSRequest
-
Deprecated.
- setRequestTimeout(long) - Method in interface play.libs.ws.WSRequest
-
Deprecated.
- setRequestTimeout(Duration) - Method in class play.libs.ws.ahc.AhcWSRequest
- setRequestTimeout(Duration) - Method in interface play.libs.ws.WSRequest
-
Sets the request timeout in milliseconds.
- setSameSite(String) - Method in class play.core.cookie.encoding.DefaultCookie
- setSecure(boolean) - Method in interface play.core.cookie.encoding.Cookie
-
Sets the security getStatus of this
Cookie
- setSecure(boolean) - Method in class play.core.cookie.encoding.DefaultCookie
- setTimeZone(TimeZone) - Method in class play.libs.Time.CronExpression
-
Sets the time zone for which this
CronExpression
will be resolved. - setUrl(String) - Method in class play.libs.ws.ahc.AhcWSRequest
- setValue(String) - Method in interface play.core.cookie.encoding.Cookie
-
Sets the value of this
Cookie
. - setValue(String) - Method in class play.core.cookie.encoding.DefaultCookie
- setVirtualHost(String) - Method in class play.libs.ws.ahc.AhcWSRequest
- setVirtualHost(String) - Method in interface play.libs.ws.WSRequest
-
Sets the virtual host as a "hostname:port" string.
- setWrap(boolean) - Method in interface play.core.cookie.encoding.Cookie
-
Sets true if the value of this
Cookie
is to be wrapped with double quotes. - setWrap(boolean) - Method in class play.core.cookie.encoding.DefaultCookie
- shutdown() - Method in interface play.db.Database
-
Shutdown this database, closing the underlying data source.
- shutdown() - Method in interface play.db.DBApi
-
Shutdown all databases, releasing resources.
- shutdown() - Method in class play.db.DefaultDatabase
- shutdown() - Method in class play.db.DefaultDBApi
- shutdown() - Method in class play.db.jpa.DefaultJPAApi
-
Close all entity manager factories.
- shutdown() - Method in interface play.db.jpa.JPAApi
-
Close all entity manager factories.
- shutdown() - Method in interface play.LoggerConfigurator
-
Shutdown the logger infrastructure.
- sign(String) - Method in interface play.libs.crypto.CookieSigner
-
Signs the given String using the application's secret key.
- sign(String) - Method in class play.libs.crypto.DefaultCookieSigner
-
Signs the given String using the application's secret key.
- sign(String, byte[]) - Method in interface play.libs.crypto.CookieSigner
-
Signs the given String using the given key.
- sign(String, byte[]) - Method in class play.libs.crypto.DefaultCookieSigner
-
Signs the given String using the given key.
- sign(WSSignatureCalculator) - Method in class play.libs.ws.ahc.AhcWSRequest
- sign(WSSignatureCalculator) - Method in interface play.libs.ws.WSRequest
-
Sets an (OAuth) signature calculator.
- signToken(String) - Method in interface play.libs.crypto.CSRFTokenSigner
-
Sign a token.
- signToken(String) - Method in class play.libs.crypto.DefaultCSRFTokenSigner
- simple() - Static method in class play.Environment
-
A simple environment.
- Simple() - Constructor for class play.mvc.Action.Simple
- SimpleEvolutionsReader - Class in play.db.evolutions
-
A simple evolutions reader that uses a map to store evolutions
- SimpleEvolutionsReader(Map<String, List<Evolution>>) - Constructor for class play.db.evolutions.SimpleEvolutionsReader
- SimpleFormatter() - Constructor for class play.data.format.Formatters.SimpleFormatter
- singletonTemporaryFileCreator() - Static method in class play.libs.Files
- SingletonTemporaryFileCreator() - Constructor for class play.libs.Files.SingletonTemporaryFileCreator
- size() - Method in class play.mvc.Http.RawBuffer
- skipWhiteSpace(int, String) - Method in class play.libs.Time.CronExpression
- source() - Static method in class play.libs.streams.Accumulator
-
Create an accumulator that forwards the stream fed into it to the source it produces.
- SourceAndOffset(long, Source<ByteString, ?>) - Constructor for class play.mvc.RangeResults.SourceAndOffset
- sourceMapper() - Method in class play.ApplicationLoader.Context
-
Deprecated.Deprecated as of 2.7.0. Access it using
ApplicationLoader.Context.devContext()
. - sourceMapper() - Method in interface play.components.BaseComponents
- sourceMapper() - Method in class play.ContextBasedBuiltInComponents
- SourceProvider - Class in play.inject
-
Provides access to the calling line of code.
- sslContext() - Method in interface play.server.SSLEngineProvider
-
The
SSLContext
used to create the SSLEngine. - SSLEngineProvider - Interface in play.server
-
To configure the SSLEngine used by Play as a server, extend this class.
- standaloneWSClient() - Method in interface play.libs.ws.ahc.AhcWSComponents
- StandaloneWSClientProvider(AsyncHttpClient, Materializer) - Constructor for class play.libs.ws.ahc.AhcWSModule.StandaloneWSClientProvider
- start() - Method in class play.db.jpa.DefaultJPAApi
-
Initialise JPA entity manager factories.
- start() - Method in interface play.db.jpa.JPAApi
-
Initialise JPA entity manager factories.
- start(Application) - Static method in class play.test.Helpers
-
Starts a new application.
- start(TestServer) - Static method in class play.test.Helpers
-
Starts a Test server.
- startPlay() - Method in class play.test.WithApplication
- startServer() - Method in class play.test.WithServer
- StaticFileMimeTypes - Class in play.mvc
- StaticFileMimeTypes() - Constructor for class play.mvc.StaticFileMimeTypes
- status() - Method in class play.mvc.ResponseHeader
- status() - Method in class play.mvc.Result
-
Get the status.
- status(int) - Static method in class play.mvc.Results
-
Generates a simple result.
- status(int, byte[]) - Static method in class play.mvc.Results
-
Generates a simple result with byte-array content.
- status(int, JsonNode) - Static method in class play.mvc.Results
-
Generates a simple result with json content and UTF8 encoding.
- status(int, JsonNode, JsonEncoding) - Static method in class play.mvc.Results
-
Generates a simple result with json content.
- status(int, File) - Static method in class play.mvc.Results
-
Generates a result with file contents.
- status(int, File, boolean) - Static method in class play.mvc.Results
-
Generates a result with file content.
- status(int, File, boolean, Optional<String>) - Static method in class play.mvc.Results
-
Generates a result.
- status(int, File, boolean, Optional<String>, FileMimeTypes) - Static method in class play.mvc.Results
-
Generates a result.
- status(int, File, boolean, FileMimeTypes) - Static method in class play.mvc.Results
-
Generates a result with file content.
- status(int, File, String) - Static method in class play.mvc.Results
-
Deprecated.Deprecated as of 2.8.0. Use to
Results.status(int, File, Optional)
. - status(int, File, String, FileMimeTypes) - Static method in class play.mvc.Results
-
Deprecated.Deprecated as of 2.8.0. Use to
Results.status(int, File, Optional, FileMimeTypes)
. - status(int, File, Optional<String>) - Static method in class play.mvc.Results
-
Generates a result.
- status(int, File, Optional<String>, FileMimeTypes) - Static method in class play.mvc.Results
-
Generates a result.
- status(int, File, FileMimeTypes) - Static method in class play.mvc.Results
-
Generates a result with file contents.
- status(int, InputStream) - Static method in class play.mvc.Results
-
Generates a chunked result.
- status(int, InputStream, long) - Static method in class play.mvc.Results
-
Generates a chunked result.
- status(int, String) - Static method in class play.mvc.Results
-
Generates a simple result.
- status(int, String, String) - Static method in class play.mvc.Results
-
Generates a simple result.
- status(int, Path) - Static method in class play.mvc.Results
-
Generates a result with path contents.
- status(int, Path, boolean) - Static method in class play.mvc.Results
-
Generates a result with path content.
- status(int, Path, boolean, Optional<String>) - Static method in class play.mvc.Results
-
Generates a result.
- status(int, Path, boolean, Optional<String>, FileMimeTypes) - Static method in class play.mvc.Results
-
Generates a result.
- status(int, Path, boolean, FileMimeTypes) - Static method in class play.mvc.Results
-
Generates a result with path content.
- status(int, Path, Optional<String>) - Static method in class play.mvc.Results
-
Generates a result.
- status(int, Path, Optional<String>, FileMimeTypes) - Static method in class play.mvc.Results
-
Generates a result.
- status(int, Path, FileMimeTypes) - Static method in class play.mvc.Results
-
Generates a result with path contents.
- status(int, ByteString) - Static method in class play.mvc.Results
-
Generates a simple result.
- status(int, Content) - Static method in class play.mvc.Results
-
Generates a simple result.
- status(int, Content, String) - Static method in class play.mvc.Results
-
Generates a simple result.
- StatusHeader - Class in play.mvc
-
A status with no body
- StatusHeader(int) - Constructor for class play.mvc.StatusHeader
- stop() - Method in class play.server.Server
-
Stop the server.
- stop(Application) - Static method in class play.test.Helpers
-
Stops an application.
- stop(TestServer) - Static method in class play.test.Helpers
-
Stops a Test server.
- stopPlay() - Method in class play.test.WithApplication
- stopServer() - Method in class play.test.WithServer
- storeExpressionVals(int, String, int) - Method in class play.libs.Time.CronExpression
- stream() - Method in class play.libs.ws.ahc.AhcWSRequest
- stream() - Method in interface play.libs.ws.WSRequest
-
Execute this request and stream the response body.
- streamed(Source<ByteString, ?>, Optional<Long>) - Method in class play.mvc.StatusHeader
-
Send a streamed response with the given source.
- streamed(Source<ByteString, ?>, Optional<Long>, boolean, Optional<String>) - Method in class play.mvc.StatusHeader
-
Send a streamed response with the given source.
- streamed(Source<ByteString, ?>, Optional<Long>, boolean, Optional<String>, FileMimeTypes) - Method in class play.mvc.StatusHeader
-
Send a streamed response with the given source.
- streamed(Source<ByteString, ?>, Optional<Long>, Optional<String>) - Method in class play.mvc.StatusHeader
-
Send a streamed response with the given source.
- Streamed(Source<ByteString, ?>, Optional<Long>, Optional<String>) - Constructor for class play.http.HttpEntity.Streamed
- strict(Function<Optional<E>, CompletionStage<A>>, Sink<E, CompletionStage<A>>) - Static method in class play.libs.streams.Accumulator
-
Create a done accumulator with the given future.
- Strict(ByteString, Optional<String>) - Constructor for class play.http.HttpEntity.Strict
- STRICT - play.mvc.Http.Cookie.SameSite
- STRICT - Static variable in class play.core.cookie.encoding.ClientCookieDecoder
-
Strict encoder that validates that name and value chars are in the valid scope defined in RFC6265
- STRICT - Static variable in class play.core.cookie.encoding.ClientCookieEncoder
-
Strict encoder that validates that name and value chars are in the valid scope defined in RFC6265
- STRICT - Static variable in class play.core.cookie.encoding.ServerCookieDecoder
-
Strict encoder that validates that name and value chars are in the valid scope defined in RFC6265
- STRICT - Static variable in class play.core.cookie.encoding.ServerCookieEncoder
-
Strict encoder that validates that name and value chars are in the valid scope defined in RFC6265
- STRICT_TRANSPORT_SECURITY - Static variable in interface play.mvc.Http.HeaderNames
- string(String) - Static method in class play.libs.Comet
-
Produces a Flow of escaped ByteString from a series of String elements.
- string(String, String) - Static method in class play.libs.Comet
-
Produces a Flow of escaped ByteString from a series of String elements.
- stringify(JsonNode) - Static method in class play.libs.Json
-
Converts a JsonNode to its string representation.
- stubMessagesApi() - Static method in class play.test.Helpers
-
Constructs an empty messagesApi instance.
- stubMessagesApi(Map<String, Map<String, String>>, Langs) - Static method in class play.test.Helpers
-
Constructs a MessagesApi instance containing the given keys and values.
- sub(String) - Method in class play.data.Form.Field
-
Get a sub-field, with a key relative to the current field.
- sub(String, Lang) - Method in class play.data.Form.Field
-
Get a sub-field, with a key relative to the current field.
- SWITCHING_PROTOCOLS - Static variable in interface play.mvc.Http.Status
- sync() - Method in interface play.cache.AsyncCacheApi
- sync() - Method in class play.cache.DefaultAsyncCacheApi
- SyncCacheApi - Interface in play.cache
-
A synchronous API to access a Cache.
- SyncCacheApiAdapter - Class in play.cache
-
Adapts a Scala SyncCacheApi to a Java SyncCacheApi
- SyncCacheApiAdapter(SyncCacheApi) - Constructor for class play.cache.SyncCacheApiAdapter
- synchronous() - Method in class play.cache.caffeine.NamedCaffeineCache
T
- TE - Static variable in interface play.mvc.Http.HeaderNames
- tempFileCreator() - Method in interface play.components.TemporaryFileComponents
- tempFileCreator() - Method in class play.ContextBasedBuiltInComponents
- TEMPORARY_REDIRECT - Static variable in interface play.mvc.Http.Status
- TemporaryFile(long, Files.TemporaryFileCreator, HttpErrorHandler, Materializer) - Constructor for class play.mvc.BodyParser.TemporaryFile
- TemporaryFile(HttpConfiguration, Files.TemporaryFileCreator, HttpErrorHandler, Materializer) - Constructor for class play.mvc.BodyParser.TemporaryFile
- TemporaryFileComponents - Interface in play.components
-
Components related to temporary file handle.
- temporaryFileCreator() - Method in class play.libs.Files.DelegateTemporaryFile
- temporaryFileCreator() - Method in interface play.libs.Files.TemporaryFile
- temporaryRedirect(String) - Static method in class play.mvc.Results
-
Generates a 307 Temporary Redirect result.
- temporaryRedirect(Call) - Static method in class play.mvc.Results
-
Generates a 307 Temporary Redirect result.
- TEST - play.Mode
- testBrowser() - Static method in class play.test.Helpers
-
Creates a Test Browser.
- testBrowser(int) - Static method in class play.test.Helpers
-
Creates a Test Browser.
- testBrowser(Class<? extends WebDriver>) - Static method in class play.test.Helpers
-
Creates a Test Browser.
- testBrowser(Class<? extends WebDriver>, int) - Static method in class play.test.Helpers
-
Creates a Test Browser.
- testBrowser(WebDriver) - Static method in class play.test.Helpers
-
Creates a Test Browser.
- testBrowser(WebDriver, int) - Static method in class play.test.Helpers
-
Creates a Test Browser.
- TestBrowser - Class in play.test
-
A test browser (Using Selenium WebDriver) with the FluentLenium API (https://github.com/Fluentlenium/FluentLenium).
- TestBrowser(Class<? extends WebDriver>, String) - Constructor for class play.test.TestBrowser
-
A test browser (Using Selenium WebDriver) with the FluentLenium API (https://github.com/Fluentlenium/FluentLenium).
- TestBrowser(WebDriver, String) - Constructor for class play.test.TestBrowser
-
A test browser (Using Selenium WebDriver) with the FluentLenium API (https://github.com/Fluentlenium/FluentLenium).
- testServer - Variable in class play.test.WithServer
- testServer() - Static method in class play.test.Helpers
-
Creates a new Test server listening on port defined by configuration setting "testserver.port" (defaults to a random port).