<?xml version="1.0" encoding="UTF-8"?>

<!DOCTYPE api-answers PUBLIC "-//NetBeans//DTD Arch Answers//EN" "../../nbbuild/antsrc/org/netbeans/nbbuild/Arch.dtd" [

<!ENTITY api-questions SYSTEM "../../nbbuild/antsrc/org/netbeans/nbbuild/Arch-api-questions.xml">

]>

<api-answers

question-version="1.24"

author="jglick@netbeans.org"

>

&api-questions;

<answer id="arch-overall">

<p>

Provides implementations of the Java platform SPI and the project library SPI.

</p>

<p>

<api category="official" group="java" name="J2SEPlatformCreator" type="export" url="@TOP@/org/netbeans/modules/java/j2seplatform/api/J2SEPlatformCreator.html">

API to register a JDK

</api>

and these

<api category="official" group="java" name="SPI" type="export" url="@TOP@/org/netbeans/modules/java/j2seplatform/spi/package-summary.html">

(service provide interfaces) for JDK sources and JavaDoc

</api>.

</p>

<p>

Defines some formats:

</p>

<ul>

<li>

<api group="dtd" name="platformdefinition.dtd" type="export" category="official" url="http://www.netbeans.org/dtds/java-platformdefinition-1_0.dtd">

<p>

Definition of XML format for J2SE platform type (i.e. a JDK).

</p>

</api>

</li>

<li>

<api group="dtd" name="library-volume-types" type="export" category="official">

<p>

The library type provider defines three volume types:

</p>

<ol>

<li>

<code>classpath</code>

</li>

<li>

<code>src</code>

</li>

<li>

<code>javadoc</code>

</li>

<li>

<code>maven-pom</code> - Added for 6.0 beta1 to allow maven projects to recognize the library content.

</li>

</ol>

<p>

The actual definition of the XML syntax is controlled by the Project

Libraries API.

</p>

</api>

</li>

</ul>

</answer>

<answer id="arch-quality">

<p>

There is some unit test coverage.

</p>

</answer>

<answer id="arch-time">

<p>

Essentially done.

</p>

</answer>

<answer id="arch-usecases">

<p>

The UI specifications describe the module in proper context.

</p>

</answer>

<answer id="arch-what">

<p>

Defines the Java platform type for J2SE (plain JDKs), and the plain Java

library type. UI specifications:

</p>

<ol>

<li>

<p>

J2SE-specific portion of <a

href="https://netbeans.apache.org/projects/buildsys/j2se-project-ui-spec#Dialog_Library_Manager">Java

Platform Manager</a>.

</p>

</li>

<li>

<p>

Class-library-specific portion of <a

href="https://netbeans.apache.org/projects/buildsys/j2se-project-ui-spec#Dialog_Java_Platform_Manager">Library

Manager</a>.

</p>

</li>

</ol>

</answer>

<answer id="compat-i18n">

<p>

Yes.

</p>

</answer>

<answer id="compat-standards">

<p>

No.

</p>

</answer>

<answer id="compat-version">

<p>

The Java platform type uses a versioned XML DTD.

</p>

<p>

There is no versioning information in the class library definition (beyond

what the Project Libraries module provides). However there are only three

defined volume types currently, and if more need to be added, they could be,

or existing volume types could be ignored. The current code would not be able

to ignore volume types added in the future, however.

</p>

</answer>

<answer id="dep-jre">

<p>

1.4+. (But the Java platform definitions could be of any JDK version.)

</p>

</answer>

<answer id="dep-jrejdk">

<p>

JRE. (The Java platform definitions may be of the JDK or JRE.)

</p>

</answer>

<answer id="dep-nb">

<ul>

<li>

<api group="java" name="JavaSupportAPIs" type="import" category="official">

<p>

Used to define classpath, etc.

</p>

</api>

</li>

<li>

<api group="java" name="ProjectLibrariesAPI" type="import" category="devel">

<p>

Implements this SPI.

</p>

</api>

</li>

<li>

<api group="java" name="JavaPlatformAPI" type="import" category="devel">

<p>

Implements this SPI.

</p>

</api>

</li>

<li>

<api group="java" name="AntProjectAPI" type="import" category="devel">

<p>

Used to update <samp>${netbeans.user}/build.properties</samp> with the

current list of libraries and platforms.

</p>

</api>

</li>

<li>

<api group="java" name="ProjectAPI" type="import" category="devel">

<p>

Just used for <code>ProjectManager.mutex()</code>.

</p>

</api>

</li>

<li>

<api group="java" name="Datasystems" type="import" category="official">

<p>

Used for settings storage.

</p>

</api>

</li>

<li>

<api group="java" name="Filesystems" type="import" category="official">

<p>

Used for various purposes.

</p>

</api>

</li>

<li>

<api group="java" name="Wizards" type="import" category="official">

<p>

Implementation of the J2SE platform autodetection wizard.

</p>

</api>

</li>

</ul>

<api name="org.netbeans.modules.java.j2seplatform.api.API_Ask_attachSourcesQuestion" group="branding" type="export" category="stable">

<p>

Controls interaction when <b>sources</b> are about to be attached to a Classpath root, in

<a href="@org-netbeans-api-java@/org/netbeans/spi/java/queries/SourceJavadocAttacherImplementation.html">SourceJavadocAttacherImplementation</a>

provided by this module. By setting <code>API_Ask_attachSourcesQuestion</code> key in

<code>org/netbeans/modules/java/j2seplatform/api/Bundle.properties</code> one can control the function:

</p>

<ul>

<li>

<b>no</b> will disable the attachers. No source/javadoc will be attached, and no user interaction will be started.

</li>

<li>

<b>yes</b> will permit the registered <a href="@org-netbeans-api-java@/org/netbeans/spi/java/queries/SourceJavadocAttacherImplementation.Definer.html">

SourceJavadocAttacherImplementation.Definer</a> to attach an appropriate resource(s). <b>User interaction will be skipped</b>

</li>

<li>

<b>ask</b> (the default) will ask the user to supply the resources.

</li>

</ul>

<p>

The key can be set by a branding file in your application build.

</p>

</api>

<api name="org.netbeans.modules.java.j2seplatform.api.API_Ask_attachJavadocQuestion" group="branding" type="export" category="stable">

<p>

Controls interaction when <b>javadocs</b> are about to be attached to a Classpath root, in

<a href="@org-netbeans-api-java@/org/netbeans/spi/java/queries/SourceJavadocAttacherImplementation.html">SourceJavadocAttacherImplementation</a>

provided by this module. By setting <code>API_Ask_attachJavadocQuestion</code> key in

<code>org/netbeans/modules/java/j2seplatform/api/Bundle.properties</code> one can control the function:

</p>

<ul>

<li>

<b>no</b> will disable the attachers. No source/javadoc will be attached, and no user interaction will be started.

</li>

<li>

<b>yes</b> will permit the registered <a href="@org-netbeans-api-java@/org/netbeans/spi/java/queries/SourceJavadocAttacherImplementation.Definer.html">

SourceJavadocAttacherImplementation.Definer</a> to attach an appropriate resource(s). <b>User interaction will be skipped</b>

</li>

<li>

<b>ask</b> (the default) will ask the user to supply the resources.

</li>

</ul>

<p>

The key can be set by a branding file in your application build.

</p>

</api>

</answer>

<answer id="dep-non-nb">

<p>

None.

</p>

</answer>

<answer id="dep-platform">

<p>

Any. However some heuristics are used to find commands which are part of

target VMs, such as the <code>java</code> launcher, or <code>javac</code>;

normally they are searched for in the <code>bin</code> subdirectory, appending

<code>.exe</code> on Windows, but the search locations are different on Mac OS

X. Support for more exotic platforms would require patches to locate specific

tools; there is no general specification for where to find JDK/JRE commands on

different platforms or using VMs from different vendors.

</p>

</answer>

<answer id="deploy-dependencies">

<p>

N/A

</p>

</answer>

<answer id="deploy-jar">

<p>

Module JAR, plus a &ldquo;probe JAR&rdquo; used to retrieve system properties

from a target JDK.

</p>

</answer>

<answer id="deploy-nbm">

<p>

Yes.

</p>

</answer>

<answer id="deploy-packages">

<p>

Only API and SPI packages are exported.

</p>

</answer>

<answer id="deploy-shared">

<p>

Anywhere.

</p>

</answer>

<answer id="exec-classloader">

<p>

No.

</p>

</answer>

<answer id="exec-component">

<p>

The <code>java.util.Map</code> returned by the <code>J2SEPlatformImpl.getProperties()</code> contains

property <code>platform.ant.name</code> holding the name of the platform used by build scripts.

</p>

</answer>

<answer id="exec-introspection">

<p>

No.

</p>

</answer>

<answer id="exec-privateaccess">

<p>

No.

</p>

</answer>

<answer id="exec-process">

<p>

The J2SE platform wizard runs an autodetect probe to find the version number,

system properties, and other information about a target VM. This is a simple

prebuilt Java program run against the <code>java</code> launcher of the target

VM. No I/O streams are used; the probe writes all information to a named

properties file and exits. (The exit code is checked.)

</p>

</answer>

<answer id="exec-property">

<p>

No, although system properties of a target J2SE VM are recorded.

</p>

</answer>

<answer id="exec-reflection">

<p>

No.

</p>

</answer>

<answer id="exec-threading">

<p>

TBD

</p>

</answer>

<answer id="format-clipboard">

<p>

None.

</p>

</answer>

<answer id="format-dnd">

<p>

None.

</p>

</answer>

<answer id="format-types">

<p>

Platform and library definitions, as mentioned in <a

href="#answer-arch-overall">Overall Architecture</a>.

</p>

</answer>

<answer id="lookup-lookup">

<p>

The J2SE platform customizer lookups <code>java.beans.Customizer</code> instances

registered in the <code>org-netbeans-api-java/platform/j2seplatform/customizers/</code>

folder on the system file system. These instances are added as additional tabs into the

J2SE platform customizer.

</p>

<p>

The J2SE platform consults instances of the <code>J2SEPlatformDefaultJavadoc</code>

registered in the <code>org-netbeans-api-java/platform/j2seplatform/defaultJavadocProviders/</code>

folder to suggest Javadoc roots when there are no Javadoc roots explicitly attached by an user.

</p>

</answer>

<answer id="lookup-register">

<p>

Platform and library type definitions are registered, as are a number of

queries relating to platforms and libraries.

A default classpath provider is registered for Java sources which otherwise

lack any specific classpath information.

</p>

</answer>

<answer id="lookup-remove">

<p>

No.

</p>

</answer>

<answer id="perf-exit">

<p>

No.

</p>

</answer>

<answer id="perf-huge_dialogs">

<p>

Nothing particularly big.

</p>

</answer>

<answer id="perf-limit">

<p>

None known.

</p>

</answer>

<answer id="perf-mem">

<p>

Never measured; probably small.

</p>

</answer>

<answer id="perf-menus">

<p>

No.

</p>

</answer>

<answer id="perf-progress">

<p>

The platform probe can take a couple of seconds; invoked between wizard steps.

</p>

</answer>

<answer id="perf-scale">

<p>

Unknown.

</p>

</answer>

<answer id="perf-spi">

<p>

N/A

</p>

</answer>

<answer id="perf-startup">

<p>

Yes, some information about registered platforms and libraries is mirrored to

<code>${netbeans.user}/build.properties</code> for use from Ant.

</p>

</answer>

<answer id="perf-wakeup">

<p>

No.

</p>

</answer>

<answer id="resources-file">

<p>