@CompileStatic class BuildSettings extends java.lang.Object
Build time settings and configuration
| Modifiers | Name | Description |
|---|---|---|
static java.lang.String |
APP_BASE_DIR |
The base directory of the application |
static java.lang.String |
AUTHENTICATOR |
The authenticator to use when connecting remotely from the CLI |
static java.io.File |
BASE_DIR |
The base directory of the project |
static java.lang.String |
BUILD_CLASSES_PATH |
The path to the build classes directory |
static java.lang.String |
BUILD_RESOURCES_PATH |
The path to the build resources directory, relative to the project: the PROJECT_RESOURCES_DIR system
property, which the Gradle plugin passes, else build/resources/main |
static java.lang.String |
BUILD_SCOPE |
|
static java.lang.String |
BUILD_SCOPE_DESC |
|
static java.io.File |
CLASSES_DIR |
The classes directory of the project, null outside of the development environment |
static java.lang.String |
COMPILER_SOURCE_LEVEL |
The compiler source level to use |
static java.lang.String |
COMPILER_TARGET_LEVEL |
The compiler source level to use |
static java.lang.String |
COMPILE_SCOPE |
|
static java.lang.String |
COMPILE_SCOPE_DESC |
|
static java.lang.String |
COMPILE_STATIC_CONTROLLERS |
A property name that, when set to true, opts every controller into
@GrailsCompileStatic automatically during compilation. |
static java.lang.String |
COMPILE_STATIC_GSP |
A property name that, when set to true, compiles every GSP page statically. |
static java.lang.String |
COMPILE_STATIC_GSP_STRICT |
A property name that, when set to true, holds every page to the names it declares
rather than only the pages that declare a model. |
static java.lang.String |
COMPILE_STATIC_SERVICES |
A property name that, when set to true, opts every service into
@GrailsCompileStatic automatically during compilation. |
static java.lang.String |
COMPILE_STATIC_TAGLIBS |
A property name that, when set to true, opts every tag library into
@GrailsCompileStatic automatically during compilation. |
static java.lang.String |
CONVERT_CLOSURES_KEY |
A property name to enable/disable AST conversion of closures actions&tags to methods |
static java.lang.String |
CORE_WORKING_DIR_NAME |
The name of the working directory for commands that don't belong to a project (like create-app) |
static java.lang.String |
FUNCTIONAL_BASE_URL_PROPERTY |
A system property with this name is populated in the preparation phase of functional testing with the base URL that tests should be run against. |
static java.lang.String |
GENERATED_GSP_VIEW_DIRECTORIES |
A property name whose value lists, separated by the platform's path separator, directories of pages the build generated, to be compiled in the same page compilation as the directory being compiled: each page is named by its path under the directory holding it, as though it were in the directory being compiled, where a page at the same path takes precedence. |
static java.lang.String |
GORM_DEFAULT_ID_TYPE |
A property name that selects the type of the id GORM injects into an entity that
declares none of its own. |
static java.lang.String |
GORM_DEFAULT_ID_TYPE_LONG |
The GORM_DEFAULT_ID_TYPE value that gives every entity a Long id. |
static java.lang.String |
GORM_DEFAULT_ID_TYPE_NATIVE |
The GORM_DEFAULT_ID_TYPE value that defers to the GORM implementation an entity is mapped with. |
static boolean |
GRAILS_APP_DIR_PRESENT |
Whether the application is running inside the development environment or deployed |
static java.util.regex.Pattern |
JAR_PATTERN |
|
static java.lang.String |
MAIN_CLASS_NAME |
Name of the System property that specifies the main class name |
static java.lang.String |
OFFLINE_MODE |
|
static java.lang.String |
OPTIONAL_GSP_PAGES |
A property name whose value lists, separated by the platform's path separator, files that each name pages of a page compilation, one per line, as paths relative to the directory being compiled. |
static java.lang.String |
PROFILE |
The name of the profile being used |
static java.lang.String |
PROFILE_REPOSITORIES |
Specifies the profile repositories to use |
static java.lang.String |
PROJECT_AUTODEPLOY_DIR |
The name of the WAR file of the project |
static java.lang.String |
PROJECT_CLASSES_DIR |
The name of the system property for the project classes directory. |
static java.lang.String |
PROJECT_DOCS_OUTPUT_DIR |
The name of the system property for documentation output directory |
static java.lang.String |
PROJECT_RESOURCES_DIR |
The name of the system property for RESOURCES_DIR and BUILD_RESOURCES_PATH. |
static java.lang.String |
PROJECT_SOURCE_DIR |
The name of the system property for project source directory. |
static java.lang.String |
PROJECT_TARGET_DIR |
The name of the system property for TARGET_DIR, the build directory relative to the project. |
static java.lang.String |
PROJECT_TEST_CLASSES_DIR |
The name of the system property for project test classes directory. |
static java.lang.String |
PROJECT_TEST_REPORTS_DIR |
The name of the system property for test reported directory |
static java.lang.String |
PROJECT_TEST_SOURCE_DIR |
The name of the property specification test locations, must be set of the directory is changed from src/test/groovy |
static java.lang.String |
PROJECT_WAR_FILE |
The name of the WAR file of the project |
static java.lang.String |
PROJECT_WORK_DIR |
The name of the system property for the project work directory |
static java.lang.String |
PROVIDED_SCOPE |
|
static java.lang.String |
PROVIDED_SCOPE_DESC |
|
static java.lang.String |
PROXY_HTTP_PASSWORD |
The http proxy password |
static java.lang.String |
PROXY_HTTP_USER |
The http proxy username |
static java.lang.String |
PROXY_SELECTOR |
The proxy selector object to use when connecting remotely from the CLI |
static java.io.File |
RESOURCES_DIR |
The resources directory of the project, null outside of the development environment |
static java.lang.String |
RUNTIME_SCOPE |
|
static java.lang.String |
RUNTIME_SCOPE_DESC |
|
static java.lang.String |
RUN_EXECUTED |
|
static java.util.Map<java.lang.String, java.lang.String> |
SCOPE_TO_DESC |
|
static java.lang.String |
SERVLET_VERSION |
The version of the servlet API |
static java.io.File |
SHARED_SETTINGS_FILE |
|
static java.io.File |
TARGET_DIR |
The target directory of the project, null outside of the development environment |
static java.lang.String |
TEST_SCOPE |
|
static java.lang.String |
TEST_SCOPE_DESC |
|
static java.lang.String |
WORK_DIR |
The name of the system property for the Grails work directory. |
| Constructor and description |
|---|
BuildSettings() |
| Type Params | Return Type | Name and description |
|---|---|---|
|
static java.lang.String |
getGrailsVersion()
|
|
static boolean |
isDevelopmentGrailsVersion()
|
| Methods inherited from class | Name |
|---|---|
class java.lang.Object |
java.lang.Object#equals(java.lang.Object), java.lang.Object#getClass(), java.lang.Object#hashCode(), java.lang.Object#notify(), java.lang.Object#notifyAll(), java.lang.Object#toString(), java.lang.Object#wait(), java.lang.Object#wait(long), java.lang.Object#wait(long, int) |
The base directory of the application
The authenticator to use when connecting remotely from the CLI
The base directory of the project
The path to the build classes directory
The path to the build resources directory, relative to the project: the PROJECT_RESOURCES_DIR system
property, which the Gradle plugin passes, else build/resources/main
The classes directory of the project, null outside of the development environment
The compiler source level to use
The compiler source level to use
A property name that, when set to true, opts every controller into
@GrailsCompileStatic automatically during compilation.
A property name that, when set to true, compiles every GSP page statically.
Unlike the artefact opt-ins above this is not a name of its own: it is the configuration
setting grails.views.gsp.compileStatic, stated as a system property so that it reaches
both the build's page compiler and the running application, which compiles a page again when it
changes. A page compiled one way by the build and another way while being developed would be
worse than not offering the build option at all.
A property name that, when set to true, holds every page to the names it declares
rather than only the pages that declare a model.
As with COMPILE_STATIC_GSP this is the configuration setting
grails.views.gsp.compileStaticConfig.strict stated as a system property, so that it
reaches both the build's page compiler and the running application.
A property name that, when set to true, opts every service into
@GrailsCompileStatic automatically during compilation.
A property name that, when set to true, opts every tag library into
@GrailsCompileStatic automatically during compilation.
A property name to enable/disable AST conversion of closures actions&tags to methods
The name of the working directory for commands that don't belong to a project (like create-app)
A system property with this name is populated in the preparation phase of functional testing with the base URL that tests should be run against.
A property name whose value lists, separated by the platform's path separator, directories of pages the build generated, to be compiled in the same page compilation as the directory being compiled: each page is named by its path under the directory holding it, as though it were in the directory being compiled, where a page at the same path takes precedence. A compiler that does not know it compiles no generated page, which is then produced when it is first rendered.
A property name that selects the type of the id GORM injects into an entity that
declares none of its own.
GORM_DEFAULT_ID_TYPE_LONG, the default, gives every entity a Long id.
GORM_DEFAULT_ID_TYPE_NATIVE asks the GORM implementation the entity is mapped with for
its own default, so a Mongo entity is given a String id while a Hibernate entity keeps
Long.
The GORM_DEFAULT_ID_TYPE value that gives every entity a Long id.
The GORM_DEFAULT_ID_TYPE value that defers to the GORM implementation an entity is mapped with.
Whether the application is running inside the development environment or deployed
Name of the System property that specifies the main class name
A property name whose value lists, separated by the platform's path separator, files that each name pages of a page compilation, one per line, as paths relative to the directory being compiled. Such a page is optional: if it does not compile it is left out, with a warning, rather than failing the compilation. A page generated from a template a dependency supplies is one - it is an optimisation, and without it the page is produced when it is first rendered, as it would be had nothing been generated. A page the application wrote, or generated from a template of its own, is not.
The name of the profile being used
Specifies the profile repositories to use
The name of the WAR file of the project
The name of the system property for the project classes directory. Must be set if changed from build/main/classes.
The name of the system property for documentation output directory
The name of the system property for RESOURCES_DIR and BUILD_RESOURCES_PATH.
The name of the system property for project source directory. Must be set if changed from src/main/groovy
The name of the system property for TARGET_DIR, the build directory relative to the project. The Grails Gradle plugin passes it, so a changed Gradle build location is followed.
The name of the system property for project test classes directory. Must be set if changed from build/test/classes
The name of the system property for test reported directory
The name of the property specification test locations, must be set of the directory is changed from src/test/groovy
The name of the WAR file of the project
The name of the system property for the project work directory
The http proxy password
The http proxy username
The proxy selector object to use when connecting remotely from the CLI
The resources directory of the project, null outside of the development environment
The version of the servlet API
The target directory of the project, null outside of the development environment
The name of the system property for the Grails work directory.