|
|
|
|
|
|
|
XXX no answer for arch-what
Question (arch-overall): Describe the overall architecture. Answer:The Gradle Project API provides some miscellaneous friend APIs and SPIs relating to Gradle projects.
API/SPI to be used by modules wanting to enhance the Gradle project's integration in the IDE.
Question (arch-time): What are the time estimates of the work? Answer:XXX no answer for arch-time
Question (arch-quality): How will the quality of your code be tested and how are future regressions going to be prevented? Answer:XXX no answer for arch-quality
Question (arch-where): Where one can find sources for your module? Answer:
The sources for the module are in the Apache Git repositories or in the GitHub repositories.
These modules are required in project.xml:
XXX no answer for dep-non-nb
Question (dep-platform): On which platforms does your module run? Does it run in the same way on each? Answer:XXX no answer for dep-platform
Question (dep-jre): Which version of JRE do you need (1.2, 1.3, 1.4, etc.)? Answer:XXX no answer for dep-jre
Question (dep-jrejdk): Do you require the JDK or is the JRE enough? Answer:XXX no answer for dep-jrejdk
XXX no answer for deploy-jar
Question (deploy-nbm): Can you deploy an NBM via the Update Center? Answer:XXX no answer for deploy-nbm
Question (deploy-shared): Do you need to be installed in the shared location only, or in the user directory only, or can your module be installed anywhere? Answer:XXX no answer for deploy-shared
Question (deploy-packages): Are packages of your module made inaccessible by not declaring them public? Answer:XXX no answer for deploy-packages
Question (deploy-dependencies): What do other modules need to do to declare a dependency on this one, in addition to or instead of the normal module dependency declaration (e.g. tokens to require)? Answer:XXX no answer for deploy-dependencies
XXX no answer for compat-i18n
Question (compat-standards): Does the module implement or define any standards? Is the implementation exact or does it deviate somehow? Answer:XXX no answer for compat-standards
Question (compat-version): Can your module coexist with earlier and future versions of itself? Can you correctly read all old settings? Will future versions be able to read your current settings? Can you read or politely ignore settings stored by a future version? Answer:XXX no answer for compat-version
Question (compat-deprecation): How the introduction of your project influences functionality provided by previous version of the product? Answer:XXX no answer for compat-deprecation
java.io.File
directly?
Answer:
NetBeans Gradle support recognizes special file(s) that can be placed
next to a build.gradle
. These files contain description of
bindings between NetBeans UI actions (compile, run, debug, etc.) and
the actual Gradle goals to execute.
<!DOCTYPE actions SYSTEM "action-mapping.dtd"> <actions> <action name="clean"> <args>clean</args> </action> <action name="download.javadoc"> <!-- We do not really execute any tasks here, rather just reload the project allowing it to go online and fetch some dependencies. So in this case the action is forcing a project reload with some argiments. --> <reload rule="ALWAYS_ONLINE"> <args>-PdownloadJavadoc=${requestedComponent}</args> </reload> </action> <action name="download.sources"> <reload rule="ALWAYS_ONLINE"> <args>-PdownloadSources=${requestedComponent}</args> </reload> </action> <action name="download.sourcesanddoc"> <reload rule="ALWAYS_ONLINE"> <args>-PdownloadSources=${requestedComponent} -PdownloadJavadoc=${requestedComponent}</args> </reload> </action> <!-- The following section is used and preferred when the 'virtual plugin' named 'root' is present in the project plugin list marking that project is a root project. --> <apply-for plugins="root"> <action name="clean"> <args>clean</args> </action> <action name="build"> <args>assemble</args> </action> <action name="rebuild"> <args>clean assemble</args> </action> </apply-for> <!-- The following section is used and preferred when the plugin named 'java' is present in the project plugin list. --> <apply-for plugins="java"> <action name="test.single"> <args>--rerun-tasks test --tests ${selectedMethod}</args> </action> <action name="run.single.method"> <args>--rerun-tasks test --tests ${selectedMethod}</args> </action> <action name="debug.single.method"> <args>--rerun-tasks test --debug-jvm --tests ${selectedMethod}</args> </action> <action name="debug.test.single"> <args>--rerun-tasks test --debug-jvm --tests ${selectedMethod}</args> </action> <action name="javadoc"> <args>javadoc</args> </action> <!-- The debug.fix action is not repeatable. So it cannot be repeated in the Output Tab UI. --> <action name="debug.fix" repeatable="false"> <args>--offline --no-rebuild ${affectedBuildTasks}</args> <reload rule="NEVER"/> </action> </apply-for> <!-- Custom actions are present under the "Run Gradle' popup on the project node. They shall be named with a prefix 'custom-' and an project unique number. They can have a displayName which is used to present the action in the UI. --> <action name="custom-1" displayName="Publish Plugin"> <!-- Using 'input:' token provider will request user input when invoking the action. I this case it request a value displayed as 'Version', and fills up the default as '0.4.x'. The default value part is optional. --> <args>-Pversion=${input:Version,0.4.x} clean publishPlugins</args> </actions>nb-actions-config.xml -
An extension of nb-actions.config is a per-Configuration action mapping. It can be placed in nb-actions-configurationID.xml with the same format and will apply only if that specific Project Configuration is in effect.
Question (resources-layer): Does your module provide own layer? Does it create any files or folders in it? What it is trying to communicate by that and with which components? Answer:XXX no answer for resources-layer
Question (resources-read): Does your module read any resources from layers? For what purpose? Answer: GradleProjectCustomizer -
"Projects/org-netbeans-modules-gradle/Customizer" folder's content is used to construct the project's customizer.
It's content is expected to be ProjectCustomizer.CompositeCategoryProvider
instances.
The lookup passed to the panels contains an instance of Project
.
"Projects/org-netbeans-modules-gradle/Nodes" folder's content is used to construct the project's child nodes.
It's content is expected to be NodeFactory
instances.
"Projects/org-netbeans-modules-gradle/Lookup" folder's content is used to construct the project's additional lookup.
It's content is expected to be LookupProvider
instances. Gradle project provides LookupMerger
s
for Sources
, PrivilegedTemplates
, RecommendedTemplates
and other classes.
Implementations added by 3rd parties will be merged into a single instance in the project's lookup.
"Projects/org-netbeans-modules-gradle/Plugins/<plugin-name>/Lookup" folder content is also used to contribute into the project lookup, based on the Gradle plugin ids, like "java-base".
GradleActions -
"Projects/org-netbeans-modules-gradle/Actions" folder'' content is used to
add item's to the main project node popup.
It's content is expected to be Action
instances.
XXX no answer for resources-mask
Question (resources-preferences): Does your module uses preferences via Preferences API? Does your module use NbPreferences or or regular JDK Preferences ? Does it read, write or both ? Does it share preferences with other modules ? If so, then why ? Answer:XXX no answer for resources-preferences
org.openide.util.Lookup
or any similar technology to find any components to communicate with? Which ones?
Answer:
When calling
ActionProvider.invokeAction(name, lookup)
an instance of AfterBuildActionHook
can be placed into lookup
. It is then notified when the
execution of the action is finished. Useful when writing tests.
org-netbeans-modules-gradle/Plugins/<plugin-id>
.
Question (lookup-register):
Do you register anything into lookup for other code to find?
Answer:
XXX no answer for lookup-register
Question (lookup-remove): Do you remove entries of other modules from lookup? Answer:XXX no answer for lookup-remove
System.getProperty
) property?
On a similar note, is there something interesting that you
pass to java.util.logging.Logger
? Or do you observe
what others log?
Answer:
org.netbeans.modules.gradle.api.execute.NetworkProxySettings.allowOverride
-
Brand the org.netbeans.modules.gradle.api.execute.NetworkProxySettings.allowOverride
key in a
org.netbeans.modules.gradle.api.execute.Bundle
file
with one of the values true
or false
to specify whether to offer override of proxies
when running Gradle daemon. With false
, the user is only given an option to upgrade gradle's configuration files.
Since
org.netbeans.modules.gradle.spi.DEFAULT_REUSE_OUTPUT
-
Brand the DEFAULT_REUSE_OUTPUT
key in a
org.netbeans.modules.gradle.spi.Bundle
file
with one of the values true
or false
to specify the default behavior of reusing output by your application.
Use never
value, if the reuse shall never be done,
regardless of the settings value.
org.netbeans.modules.gradle.api.execute.TrustProjectOption
-
Brand the org.netbeans.modules.gradle.api.execute.TrustProjectOption.*
keys in org.netbeans.modules.gradle.api.execution
to enable/disable/reorder options in 'trust project' confirmation dialog.
For more details, see RunUtils.isProjectTrusted.
netbeans.debug.gradle.info.action
-
Starting NetBeans with netbeans.debug.gradle.info.action=true
would make the Gradle project information loading into a debugabble JVM
where the debugging port is 5006
. A new debugger session
can be attached to that port, make the netbeans-gradle-tooling
project debuggable in action.
runJvmArgs
-
NetBeans Tooling plugin recognizes runJvmArgs
project property, and injects
specified JVM arguments into JavaExec executing the user code. Use -PrunJvmArgs=...
.
If passing more arguments, the whole -P must be properly quoted. Arguments that contain spaces must
also use quoting or escapes.
runWorkingDir
-
NetBeans Tooling plugin recognizes runWorkingDir
project property, and injects
specified working directory into JavaExec executing the user code. Use -PrunWorkingDir=...
.
If the working directory contain spaces, it must also use quoting or escapes.
runEnvironment
-
NetBeans Tooling plugin recognizes runEnvironment
project property, and injects
specified environmental variables into JavaExec executing the user code. Use -PrunEnvironment=...
.
The value consists of expressions of VAR_NAME=VAR_VALUE
, or !VAR_NAME
.
The VAR_NAME=VAR_VALUE
sets environment variable VAR_NAME
to value VAR_VALUE
and !VAR_NAME
removes variable VAR_NAME
from the set of environment variables.
If passing more arguments, the whole -P must be properly quoted. Variables whose values contain spaces must
also use quoting or escapes.
Question (exec-component):
Is execution of your code influenced by any (string) property
of any of your components?
Answer:
XXX no answer for exec-component
Question (exec-ant-tasks): Do you define or register any ant tasks that other can use? Answer:XXX no answer for exec-ant-tasks
Question (exec-classloader): Does your code create its own class loader(s)? Answer:XXX no answer for exec-classloader
Question (exec-reflection): Does your code use Java Reflection to execute other code? Answer:XXX no answer for exec-reflection
Question (exec-privateaccess): Are you aware of any other parts of the system calling some of your methods by reflection? Answer:XXX no answer for exec-privateaccess
Question (exec-process): Do you execute an external process from your module? How do you ensure that the result is the same on different platforms? Do you parse output? Do you depend on result code? Answer:XXX no answer for exec-process
Question (exec-introspection): Does your module use any kind of runtime type information (instanceof
,
work with java.lang.Class
, etc.)?
Answer:
XXX no answer for exec-introspection
Question (exec-threading): What threading models, if any, does your module adhere to? How the project behaves with respect to threading? Answer:XXX no answer for exec-threading
Question (security-policy): Does your functionality require modifications to the standard policy file? Answer:XXX no answer for security-policy
Question (security-grant): Does your code grant additional rights to some other code? Answer:XXX no answer for security-grant
XXX no answer for format-types
Question (format-dnd): Which protocols (if any) does your code understand during Drag & Drop? Answer:XXX no answer for format-dnd
Question (format-clipboard): Which data flavors (if any) does your code read from or insert to the clipboard (by access to clipboard on means calling methods onjava.awt.datatransfer.Transferable
?
Answer:
XXX no answer for format-clipboard
XXX no answer for perf-startup
Question (perf-exit): Does your module run any code on exit? Answer:XXX no answer for perf-exit
Question (perf-scale): Which external criteria influence the performance of your program (size of file in editor, number of files in menu, in source directory, etc.) and how well your code scales? Answer:XXX no answer for perf-scale
Question (perf-limit): Are there any hard-coded or practical limits in the number or size of elements your code can handle? Answer:XXX no answer for perf-limit
Question (perf-mem): How much memory does your component consume? Estimate with a relation to the number of windows, etc. Answer:XXX no answer for perf-mem
Question (perf-wakeup): Does any piece of your code wake up periodically and do something even when the system is otherwise idle (no user interaction)? Answer:XXX no answer for perf-wakeup
Question (perf-progress): Does your module execute any long-running tasks? Answer:XXX no answer for perf-progress
Question (perf-huge_dialogs): Does your module contain any dialogs or wizards with a large number of GUI controls such as combo boxes, lists, trees, or text areas? Answer:XXX no answer for perf-huge_dialogs
Question (perf-menus): Does your module use dynamically updated context menus, or context-sensitive actions with complicated and slow enablement logic? Answer:XXX no answer for perf-menus
Question (perf-spi): How the performance of the plugged in code will be enforced? Answer:XXX no answer for perf-spi