1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
|
/****************************************************************************
**
** Copyright (C) 2015 The Qt Company Ltd.
** Contact: http://www.qt.io/licensing
**
** This file is part of Qbs.
**
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms and
** conditions see http://www.qt.io/terms-conditions. For further information
** use the contact form at http://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 or version 3 as published by the Free
** Software Foundation and appearing in the file LICENSE.LGPLv21 and
** LICENSE.LGPLv3 included in the packaging of this file. Please review the
** following information to ensure the GNU Lesser General Public License
** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, The Qt Company gives you certain additional
** rights. These rights are described in The Qt Company LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
****************************************************************************/
/*!
\contentspage index.html
\page java-module.html
\ingroup list-of-modules
\title Module java
\since 1.4
\brief Provides Java support.
The \c java module contains the properties and rules for building Java projects.
\section1 Java Properties
\table
\header
\li Property
\li Type
\li Since
\li Default
\li Description
\row
\li additionalClassPaths
\li stringList
\li 1.4
\li undefined
\li Locations beside this product's class output path to consider when compiling.
\row
\li additionalCompilerFlags
\li stringList
\li 1.4
\li undefined
\li Use this to supply compiler flags not covered by any of the properties in this module.
\row
\li additionalJarFlags
\li stringList
\li 1.4
\li undefined
\li Use this to supply archiver flags not covered by any of the properties in this module.
\row
\li bootClassPaths
\li stringList
\li 1.4
\li undefined
\li Use this if you need to specify non-standard bootstrap class files.
\row
\li compilerFilePath
\li string
\li 1.4
\li \c compilerName, prefixed by \c jdkPath if it is defined
\li The command to invoke when compiling Java sources.
\row
\li compilerName
\li string
\li 1.4
\li \c{"javac"}
\li The file name of the Java compiler.
\row
\li enableWarnings
\li bool
\li 1.4
\li \c true
\li Controls whether warnings are emitted when compiling Java sources.
\row
\li interpreterFilePath
\li string
\li 1.4
\li \c interpreterName, prefixed by \c jdkPath if it is defined
\li The command to invoke when executing Java code.
\row
\li interpreterName
\li string
\li 1.4
\li \c{"java"}
\li The file name of the Java interpreter.
\row
\li jarFilePath
\li string
\li 1.4
\li \c jarName, prefixed by \c jdkPath if it is defined
\li The command to run when creating or extracting \c jar files.
\row
\li jarName
\li string
\li 1.4
\li \c{"jar"}
\li The file name of the \c jar tool.
\row
\li jdkIncludePaths
\li pathList
\li 1.4.1
\li determined automatically
\li List of include paths for native header files. Applications using JNI to interface
with native code should add these paths to \c{cpp.includePaths}.
\row
\li jdkPath
\li path
\li 1.4
\li determined automatically
\li The base path of the Java Development Kit (JDK). This is equivalent to the \c JAVA_HOME
environment variable, and by default will be determined automatically from one of the
following:
\list
\li \c JAVA_HOME environment variable (all platforms)
\li Registry (Windows)
\li \c java_home tool (OS X)
\li Known JDK paths (other Unix platforms)
\endlist
\row
\li languageVersion
\li string
\li 1.4
\li undefined
\li The Java language version to interpret source code as. If undefined, the compiler
will use its default.
\row
\li runtimeVersion
\li string
\li 1.4
\li undefined
\li The version of the Java runtime to generate compatible bytecode for. If undefined,
the compiler will use its default.
\row
\li manifest
\li object
\li 1.4.2
\li undefined
\li The properties to add to the manifest file when building a JAR.
The contents of this property will be aggregated with the values from \c{manifestFile}.
If \c{manifest} and \c{manifestFile} contain the same key, the former will take
precedence. If undefined, will not be taken into account.
\row
\li manifestFile
\li path
\li 1.4.2
\li undefined
\li The manifest file to embed when building a JAR.
The contents of this file will be aggregated with the values in \c{manifest}.
If \c{manifestFile} and \c{manifest} contain the same key, the latter will take
precedence. If undefined, will not be taken into account.
\row
\li manifestClassPath
\li stringList
\li 1.4.2
\li undefined
\li The entries to add to the manifest's Class-Path when building a JAR.
\row
\li warningsAsErrors
\li bool
\li 1.4
\li \c false
\li If this property is enabled, the compiler will abort where it would normally emit
a warning.
\endtable
\section1 Relevant File Tags
\table
\header
\li Tag
\li Auto-tagged File Names
\li Since
\li Description
\row
\li \c{"java.class"}
\li -
\li 1.4
\li This tag is attached to the output artifacts of the rule that runs the
\c javac tool.
\row
\li \c{"java.jar"}
\li -
\li 1.4
\li This tag is attached to the output artifacts of the rule that runs the
\c jar tool.
\row
\li \c{"java.java"}
\li \c{*.java}
\li 1.4
\li Source files with this tag serve as inputs to the rule running the \c javac tool.
\endtable
*/
|
