| Quellcodebibliothek Statistik Leitseite products/Sources/formale Sprachen/Java/Netbeans/ide/project.ant/ (Apache JAVA IDE Version 28©) Datei vom 3.10.2025 mit Größe 32 kB |
|
Quelle arch.xml Sprache: XML |
|||||||||
|
<?xml version="1.0" encoding="UTF-8"?>
<!-- Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. --> <!DOCTYPE api-answers PUBLIC "-//NetBeans//DTD Arch Answers//EN" "../nbbuild/antsrc/o <!ENTITY api-questions SYSTEM "../nbbuild/antsrc/org/netbeans/nbbuild/Arch-api-quest ]> <api-answers question-version="1.24" author="jglick@netbeans.org" > &api-questions; <!-- <question id="arch-overall" when="init"> Describe the overall architecture. <hint> What will be API for <a href="http://openide.netbeans.org/tutorial/api-design.html#design.apiandspi"> clients and what support API</a>? What parts will be pluggable? How will plug-ins be registered? Please use <code><api type="export"/></code> to describe your general APIs. If possible please provide simple diagrams. </hint> </question> --> <answer id="arch-overall"> <api group="java" name="AntProjectAPI" type="export" category="official"> <p> Mostly an SPI for creating project types centered around the Ant build tool. Permits Ant-based project types to be registered and supplies various support implementations to help satisfy the contract of <code>Project</code> and various optional interfaces. </p> </api> </answer> <answer id="arch-where"> <defaultanswer generate='here' /> </answer> <!-- <question id="arch-quality" when="init"> How the <a href="http://www.netbeans.org/community/guidelines/q-evangelism.html">qual of your code will be tested and how future regressions are going to be prevented? <hint> What kind of testing you want to use? What/how much area of functionality should be covered by the tests? </hint> </question> --> <answer id="arch-quality"> <p> Should be covered by unit tests. </p> </answer> <!-- <question id="arch-time" when="init"> What are the time estimates of the work? <hint> Please express your estimates of how long the design, implementation, stabilization are likely to last. How many people will be needed to implement this and what is the expected milestone the work should be ready. </hint> </question> --> <answer id="arch-time"> <p> Mostly complete; see Issuezilla for remaining items. </p> </answer> <!-- <question id="arch-usecases" when="init"> Describe the main <a href="http://openide.netbeans.org/tutorial/api-design.html#useca use cases</a> of the new API. Who will use it at what circumstances and what will be the typical code to write to use the module. </question> --> <answer id="arch-usecases"> <p> Mostly an SPI for use by project type providers to create the project type. Also includes a small API/SPI for other projects to find what Ant build steps are necessary to create a certain build product, for use in inter-project dependencies. </p> <b>Ant project support faq:</b> <usecase id="support-for-storing-project-properties" name="How to use support for s <em><b>Q:</b> I'm creating a customizer (properties dialog) for my project type. I wan't to use t for simple data types. What do I need to do?</em> <p> You basicaly need to do two things. First create the representation of the project properties w can be used in the GUI. Second at some time convert the objects back to the ANT properties form and store them into the project. </p> <ul> <li><b>Creating the object representation.</b> <ol> <li>Create new instance of StoreGroup for each group of properties you want to store later e.g. project and prvate. Sometimes it might be useful to create temporary source group which will only be used for creating the models without being used for storing. E.g. for properties which need special handling.</li> <li>Call the factory methods e.g. createBooleanButtonModel, createStringDocument, etc. whi will create the swing models for you.</li> <li>Use the models in your Swing controls by calling setModel() or setDocument()</li> </ol> </li> <li><b>Storing the models back to the proprties of project.</b> <ol> <li>Get the EditableProperties you want to store the model in e.g. private or project properties</li> <li>Call the store method on given SourceGroup with the EditableProperties as parameter</li> <li>Manually store models which need some special handling.</li> </ol> </li> </ul> </usecase> </answer> <!-- <question id="arch-what" when="init"> What is this project good for? <hint> Please provide here a few lines describing the project, what problem it should solve, provide links to documentation, specifications, etc. </hint> </question> --> <answer id="arch-what"> <p> Provides the basic infrastructure by which Ant-based projects can be created, read and write configuration parameters and properties from/to disk, satisfy common queries and interfaces, etc. See Javadoc and build system design document. </p> </answer> <!-- <question id="compat-i18n" when="impl"> Is your module correctly internationalized? <hint> Correct internationalization means that it obeys instructions at <a href="http://www.netbeans.org/download/dev/javadoc/org-openide-modules/org/op NetBeans I18N pages</a>. </hint> </question> --> <answer id="compat-i18n"> <p> Supports localized project display names. Does not support I18N of Ant build scripts, though I18N of build output is possible (not yet implemented) via <code>AntLogger</code> in the Ant Module API. </p> </answer> <!-- <question id="compat-standards" when="init"> Does the module implement or define any standards? Is the implementation exact or does it deviate somehow? </question> --> <answer id="compat-standards"> <p> There are no known generally accepted standards for project metadata, so no. </p> </answer> <!-- <question id="compat-version" when="impl"> 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? <hint> Very helpful for reading settings is to store version number there, so future versions can decide whether how to read/convert the settings and older versions can ignore the new ones. </hint> </question> --> <answer id="compat-version"> <p> Projects are stored using namespaced XML so the schemas are versioned. Possible for project type providers to upgrade old projects. </p> </answer> <!-- <question id="dep-jre" when="final"> Which version of JRE do you need (1.2, 1.3, 1.4, etc.)? <hint> It is expected that if your module runs on 1.x that it will run on 1.x+1 if no, state that please. Also describe here cases where you run different code on different versions of JRE and why. </hint> </question> --> <answer id="dep-jre"> <p> 1.4+. </p> </answer> <!-- <question id="dep-jrejdk" when="final"> Do you require the JDK or is the JRE enough? </question> --> <answer id="dep-jrejdk"> <p> JRE, though many Ant tasks likely to be used by the project do require the JDK. </p> </answer> <!-- <question id="dep-nb" when="init"> What other NetBeans projects and modules does this one depend on? <hint> If you want, describe such projects as imported API using the <code><api name="identification" type="import or export" category="stable" url="where i </hint> </question> --> <answer id="dep-nb"> <p> <!-- XXX define using <api> --> Filesystems, Datasystems (limited use and only internally), Project API, General Queries API, Utilities (e.g. <code>Mutex</code>). </p> </answer> <!-- <question id="dep-non-nb" when="init"> What other projects outside NetBeans does this one depend on? <hint> Some non-NetBeans projects are packaged as NetBeans modules (see <a href="http://libs.netbeans.org/">libraries</a>) and it is preferred to use this approach when more modules may depend on such third-party library. </hint> </question> --> <answer id="dep-non-nb"> <p> None. </p> </answer> <!-- <question id="dep-platform" when="init"> On which platforms does your module run? Does it run in the same way on each? <hint> If your module is using JNI or deals with special differences of OSes like filesystems, etc. please describe here what they are. </hint> </question> --> <answer id="dep-platform"> <p> Any. </p> </answer> <answer id="deploy-dependencies"> Nothing. </answer> <!-- <question id="deploy-jar" when="impl"> Do you deploy just module JAR file(s) or other files as well? <hint> If your module consists of just one module JAR file, just confirm that. If it uses more than one JAR, describe where they are located, how they refer to each other. If it consist of module JAR(s) and other files, please describe what is their purpose, why other files are necessary. Please make sure that installation/uninstallation leaves the system in state as it was before installation. </hint> </question> --> <answer id="deploy-jar"> <p> Just a JAR. </p> </answer> <!-- <question id="deploy-nbm" when="impl"> Can you deploy an NBM via the Update Center? <hint> If not why? </hint> </question> --> <answer id="deploy-nbm"> <p> Yes. </p> </answer> <!-- <question id="deploy-packages" when="init"> Are packages of your module made inaccessible by not declaring them public? <hint> NetBeans module system allows restriction of access rights to public classes of your module from other modules. This prevents unwanted dependencies of others on your code and should be used whenever possible (<a href="http://www.netbeans.org/download/javadoc/OpenAPIs/org/op public packages </a>). If you do not restrict access to your classes you are making it too easy for other people to misuse your implementation details, that is why you should have good reason for not restricting package access. </hint> </question> --> <answer id="deploy-packages"> <p> Yes, only API and SPI packages are exported. </p> </answer> <!-- <question id="deploy-shared" when="final"> Do you need to be installed in the shared location only, or in the user directory only, or can your module be installed anywhere? <hint> Installation location shall not matter, if it does explain why. Consider also whether <code>InstalledFileLocator</code> can help. </hint> </question> --> <answer id="deploy-shared"> <p> Anywhere. </p> </answer> <!-- <question id="exec-classloader" when="impl"> Does your code create its own class loader(s)? <hint> A bit unusual. Please explain why and what for. </hint> </question> --> <answer id="exec-classloader"> <p> No. </p> </answer> <!-- <question id="exec-component" when="impl"> Is execution of your code influenced by any (string) property of any of your components? <hint> Often <code>JComponent.getClientProperty</code>, <code>Action.getValue</code> or <code>PropertyDescriptor.getValue</code>, etc. are used to influence a behavior of some code. This of course forms an interface that should be documented. Also if one depends on some interface that an object implements (<code>component instanceof Runnable</code>) that forms an API as well. </hint> </question> --> <answer id="exec-component"> <p> No. </p> </answer> <!-- <question id="exec-introspection" when="impl"> Does your module use any kind of runtime type information (<code>instanceof</code>, work with <code>java.lang.Class</code>, etc.)? <hint> Check for cases when you have an object of type A and you also expect it to (possibly) be of type B and do some special action. That should be documented. The same applies on operations in meta-level (Class.isInstance(...), Class.isAssignableFrom(...), etc.). </hint> </question> --> <answer id="exec-introspection"> <p> A check for buggy Xalan is performed during startup. The test tries to lookup org.apache.xalan.Version class. If the class is not found, the buggy Xalan is not on the classpath. If the class can be resolved, other checks (not using Java reflection) are performed. </p> </answer> <!-- <question id="exec-privateaccess" when="final"> Are you aware of any other parts of the system calling some of your methods by reflection? <hint> If so, describe the "contract" as an API. Likely private or friend one, but still API and consider rewrite of it. </hint> </question> --> <answer id="exec-privateaccess"> <p> No. </p> </answer> <!-- <question id="exec-process" when="impl"> 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? <hint> If you feed an input, parse the output please declare that as an API. </hint> </question> --> <answer id="exec-process"> <p> No. (The Ant module does run Ant, though in-VM.) </p> </answer> <!-- <question id="exec-property" when="impl"> Is execution of your code influenced by any environment or Java system (<code>System.getProperty</code>) property? <hint> If there is a property that can change the behavior of your code, somebody will likely use it. You should describe what it does and the <a href="http://openide.netbeans.org/tutorial/api-design.html#life">stability of this API. You may use <pre> <api type="export" group="property" name="id" category="private" url="http://..."> description of the property, where it is used, what it influence, etc. </api> </pre> </hint> </question> --> <answer id="exec-property"> <p> Standard property evaluators mirror system properties, as does Ant. </p> <p> <api type="export" group="systemproperty" name="netbeans.do.not.check.xalan" category The "netbeans.do.not.check.xalan" property switches off the startup check for buggy Xalan. See issue #70130 for more information. </api> </p> </answer> <!-- <question id="exec-reflection" when="impl"> Does your code use Java Reflection to execute other code? <hint> This usually indicates a missing or insufficient API in the other part of the system. If the other side is not aware of your dependency this contract can be easily broken. </hint> </question> --> <answer id="exec-reflection"> <p> No. </p> </answer> <!-- <question id="exec-threading" when="impl"> What threading models, if any, does your module adhere to? <hint> If your module calls foreign APIs which have a specific threading model, indicate how you comply with the requirements for multithreaded access (synchronization, mutexes, etc.) applicable to those APIs. If your module defines any APIs, or has complex internal structures that might be used from multiple threads, declare how you protect data against concurrent access, race conditions, deadlocks, etc., and whether such rules are enforced by runtime warnings, errors, assertions, etc. Examples: a class might be non-thread-safe (like Java Collections); might be fully thread-safe (internal locking); might require access through a mutex (and may or may not automatically acquire that mutex on behalf of a client method); might be able to run only in the event queue; etc. Also describe when any events are fired: synchronously, asynchronously, etc. Ideas: <a href="http://core.netbeans.org/proposals/threading/index.html#recommendat </hint> </question> --> <answer id="exec-threading"> <p> Uses the Project API's read-write lock for most purposes. Some classes, such as the file built query implementation, use ad-hoc synchronization. </p> </answer> <!-- <question id="format-clipboard" when="impl"> Which data flavors (if any) does your code read from or insert to the clipboard (by access to clipboard on means calling methods on <code>java.awt.datatransfer <hint> Often Node's deal with clipboard by usage of <code>Node.clipboardCopy, Node.clipboardCut and Check your code for overriding these methods. </hint> </question> --> <answer id="format-clipboard"> <p> None. </p> </answer> <!-- <question id="format-dnd" when="impl"> Which protocols (if any) does your code understand during Drag & Drop? <hint> Often Node's deal with clipboard by usage of <code>Node.drag, Node.getDropType</code>. Check your code for overriding these methods. Btw. if they are not overridden, they by default delegate to <code>Node.clipboardCopy, Node.clipboardCut and Node.pasteTypes</co </hint> </question> --> <answer id="format-dnd"> <p> None. </p> </answer> <!-- <question id="format-types" when="impl"> Which protocols and file formats (if any) does your module read or write on disk, or transmit or receive over the network? </question> --> <answer id="format-types"> <p> Reads and writes project metadata as XML and as Java Properties files. XML files are controlled by namespaced schemas with a generic wrapper and extensible segments used by the project type and perhaps other modules. Writes Ant build scripts upon request. </p> </answer> <!-- <question id="lookup-lookup" when="init"> Does your module use <code>org.openide.util.Lookup</code> or any similar technology to find any components to communicate with? Which ones? <hint> Please describe the interfaces you are searching for, where are defined, whether you are searching for just one or more of them, if the order is important, etc. Also classify the stability of such API contract. </hint> </question> --> <answer id="lookup-lookup"> <p> Ant-based project type providers are searched for in lookup. <code>AntArtifactQuery</code> looks for implementations in lookup. </p> </answer> <!-- <question id="lookup-register" when="final"> Do you register anything into lookup for other code to find? <hint> Do you register using layer file or using <code>META-INF/services</code>? Who is supposed to find your component? </hint> </question> --> <answer id="lookup-register"> <p> The delegating singleton project factory is registered for the Project API to find. There is a delegating implementation of <code>AntArtifactQueryImplementation</code>. </p> </answer> <!-- <question id="lookup-remove" when="final"> Do you remove entries of other modules from lookup? <hint> Why? Of course, that is possible, but it can be dangerous. Is the module your are masking resource from aware of what you are doing? </hint> </question> --> <answer id="lookup-remove"> <p> No. </p> </answer> <!-- <question id="perf-exit" when="final"> Does your module run any code on exit? </question> --> <answer id="perf-exit"> <p> No. Project types would commonly save any outstanding changes on exit however. </p> </answer> <!-- <question id="perf-huge_dialogs" when="final"> Does your module contain any dialogs or wizards with a large number of GUI controls such as combo boxes, lists, trees, or text areas? </question> --> <answer id="perf-huge_dialogs"> <p> No GUI. </p> </answer> <!-- <question id="perf-limit" when="init"> Are there any hard-coded or practical limits in the number or size of elements your code can handle? </question> --> <answer id="perf-limit"> <p> None known. </p> </answer> <!-- <question id="perf-mem" when="final"> How much memory does your component consume? Estimate with a relation to the number of windows, etc. </question> --> <answer id="perf-mem"> <p> Probably little for the project itself. <code>GlobFileBuiltQuery</code> consumes a modest amount of memory per file. </p> </answer> <!-- <question id="perf-menus" when="final"> Does your module use dynamically updated context menus, or context-sensitive actions with complicated enablement logic? </question> --> <answer id="perf-menus"> <p> No. </p> </answer> <!-- <question id="perf-progress" when="final"> Does your module execute any long-running tasks? <hint>Long running tasks should never block AWT thread as it badly hurts the UI <a href="http://performance.netbeans.org/responsiveness/issues.html"> responsiveness</a>. Tasks like connecting over network, computing huge amount of data, compilation be done asynchronously (for example using <code>RequestProcessor</code>), definitively it should not block AWT thread. </hint> </question> --> <answer id="perf-progress"> <p> No. (Ant builds run by the Ant module are run in the Execution Engine.) </p> </answer> <!-- <question id="perf-scale" when="init"> 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? <hint> Please include some estimates, there are other more detailed questions to answer in later phases of implementation. </hint> </question> --> <answer id="perf-scale"> <p> Size of project metadata, perhaps, though typically this would be small. Number of files in the case of <code>GlobFileBuiltQuery</code>. </p> </answer> <!-- <question id="perf-spi" when="init"> How the performance of the plugged in code will be enforced? <hint> If you allow foreign code to be plugged into your own module, how do you enforce, that it will behave correctly and fast and will not negatively influence the performance of your own module? </hint> </question> --> <answer id="perf-spi"> <p> No special provisions. </p> </answer> <!-- <question id="perf-startup" when="final"> Does your module run any code on startup? </question> --> <answer id="perf-startup"> <p> No. Project types may however (re-)generate any necessary build scripts on startup or opening. </p> <p> Moreover, a check for buggy Xalan is performed on the startup. The test should be very fast if the buggy Xalan is not detected. See issue #70130 for more information. </p> </answer> <!-- <question id="perf-wakeup" when="final"> Does any piece of your code wake up periodically and do something even when the system is otherwise idle (no user interaction)? </question> --> <answer id="perf-wakeup"> <p> No. </p> </answer> <!-- <question id="resources-file" when="final"> Does your module use <code>java.io.File</code> directly? <hint> NetBeans provide a logical wrapper over plain files called <code>org.openide.filesystems.FileObject</code> that provides uniform access to such resources and is the preferred way that should be used. But of course there can be situations when this is not suitable. </hint> </question> --> <answer id="resources-file"> <p> Yes. Since Ant deals only with disk files, many aspects of this module deal directly with <code>File</code>s. Other parts use <code>FileObject</code> where appropriate. </p> </answer> <!-- <question id="resources-layer" when="final"> 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? <hint> NetBeans allows automatic and declarative installation of resources by module layers. Module register files into appropriate places and other components use that information to perform their task (build menu, toolbar, window layout, list of templates, set of options, etc.). </hint> </question> --> <answer id="resources-layer"> <p> No. </p> </answer> <!-- <question id="resources-mask" when="final"> Does your module mask/hide/override any resources provided by other modules in their layers? <hint> If you mask a file provided by another module, you probably depend on that and do not want the other module to (for example) change the file's name. That module shall thus make that file available as an API of some stability category. </hint> </question> --> <answer id="resources-mask"> <p> No. </p> </answer> <!-- <question id="resources-read" when="final"> Does your module read any resources from layers? For what purpose? <hint> As this is some kind of intermodule dependency, it is a kind of API. Please describe it and classify according to <a href="http://openide.netbeans.org/tutorial/api-design.html#categories"> common stability categories</a>. </hint> </question> --> <answer id="resources-read"> <p> XML schemas are read from <code>ProjectXMLCatalog</code>. </p> </answer> <!-- <question id="security-grant" when="final"> Does your code grant addition rights to some code? <hint>Avoid using a classloder that adds some extra permissions to loaded code unless realy necessary. Also note that your API implementation can also expose unneeded permissions to enemy code by AccessController.doPrilileged() calls.</hint> </question> --> <answer id="security-grant"> <p> No. </p> </answer> <!-- <question id="security-policy" when="final"> Does your functionality require standard policy file modification? <hint>Your code may pass control to third party code not coming from trusted domain. It covers code downloaded over network or code coming from libraries that are not bundled with NetBeans. Which permissions it needs to grant to which domain?</hint> </question> --> <answer id="security-policy"> <p> No. </p> </answer> <!-- <question id="compat-deprecation" when="init"> How the introduction of your project influences functionality provided by previous version of the product? <hint> If you are planning to deprecate/remove/change any existing APIs, list them here accompanied with the reason explaining why you are doing so. </hint> </question> --> <answer id="compat-deprecation"> <p> Some individual methods are marked deprecated. </p> </answer> <!-- <question id="exec-ant-tasks" when="impl"> Do you define or register any ant tasks that other can use? <hint> If you provide an ant task that users can use, you need to be very careful about its syntax and behaviour, as it most likely forms an API for end users and as there is a lot of end users, their reaction when such API gets broken can be pretty strong. </hint> </question> --> <answer id="exec-ant-tasks"> <p> No. </p> </answer> <!-- <question id="resources-preferences" when="final"> 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 ? <hint> You may use <api type="export" group="preferences" name="preference node name" category="private"> description of individual keys, where it is used, what it influences, whether the module reads/write it, etc. </api> Due to XML ID restrictions, rather than /org/netbeans/modules/foo give the "name" as org.net Note that if you use NbPreferences this name will then be the same as the code name base of the modu </hint> </question> --> <answer id="resources-preferences"> <p> <api type="export" group="preferences" name="knownValidProjectXmlCRC32s" category="pr <p> A LRU list of CRC-32s of <code>project.xml</code> files known to validate successfully is kept to avoid the need to validate files just to load projects, especially during startup. </p> </api> </p> </answer> </api-answers> ¤ Dauer der Verarbeitung: 0.5 Sekunden (vorverarbeitet) ¤*© Formatika GbR, Deutschland |
|
2026-03-28