<?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.25"

  module="editor/util"

  author="mmetelka@netbeans.org"

>

  &api-questions;

<!--

        <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">

Editor Utilities module contains useful utility classes and methods used

by other editor related modules.

</answer>

<!--

        <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>&lt;api type="export"/&gt;</code>

            to describe your general APIs.

            If possible please provide 

            simple diagrams. 

            </hint>

        </question>

-->

<answer id="arch-overall">

The module defines <api name="EditorUtilitiesAPI" group="java" type="export" category="friend"/>.

<br/>

The present clients are editor/lib and editor/fold modules.

</answer>

<!--

        <question id="arch-quality" when="init">

            How will the <a href="http://www.netbeans.org/community/guidelines/q-evangelism.html">quality</a>

            of your code be tested and 

            how are future regressions going to be prevented?

            <hint>

            What kind of testing do

            you want to use? How much functionality, in which areas,

            should be covered by the tests? 

            </hint>

        </question>

-->

<answer id="arch-quality">

Unit tests are present to verify proper functionality of the contained classes.

</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 by which the work should be 

            ready?

            </hint>

        </question>

-->

<answer id="arch-time">

The module is continuously developed and improved as necessary.

</answer>

<!--

        <question id="arch-usecases" when="init">

            Describe the main <a href="http://openide.netbeans.org/tutorial/api-design.html#usecase">

            use cases</a> of the new API. Who will use it under

            what circumstances? What kind of code would typically need to be written

            to use the module?

        </question>

-->

<answer id="arch-usecases">

<h3>

GapList

</h3>

<p>

The GapList class is a <code>java.util.List</code> implementation

similar to <code>java.util.ArrayList</code> but containing a gap in its underlying 

array. After a first modification at a particular index

the subsequent modifications around that index are cheap.

<br/>

The class is suitable for storage of any elements related to editing

such as positions, elements, views etc.

</p>

<h3>

PriorityMutex

</h3>

<p>

The PriorityMutex is a simple mutex implementation

allowing to find out that a priority thread (by default Event Dispatch Thread)

is waiting to enter the mutex.

<br/>

It's used e.g. in editor's view hierarchy or in editor fold hierarchy.

</p>

<h3>

GapBranchElement

</h3>

<p>

GapList-based element implementation suitable for line elements

and any other branch element types.

</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/OpenAPIs/org/openide/doc-files/i18n-branding.html">

            NetBeans I18N pages</a>.

            </hint>

        </question>

-->

<answer id="compat-i18n">

Yes.

</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">

Compatible with standards.

</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">

Yes.

</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">

JDK1.4 and higher can be used.

</answer>

<!--

        <question id="dep-jrejdk" when="final">

            Do you require the JDK or is the JRE enough?

        </question>

-->

<answer id="dep-jrejdk">

JRE is sufficient.

</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 APIs using

            the <code>&lt;api name="identification" type="import or export" category="stable" url="where is the description" /&gt;</code>

            </hint>

        </question>

-->

<answer id="dep-nb">

The module does not depend on other NetBeans projects.

</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">

No other projects.

</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">

All platforms.

</answer>

<!--

        <question id="deploy-dependencies" when="final">

            What do other modules need to do to declare a dependency on this one?

            <hint>

                Provide a sample of the actual lines you would add to a module manifest

                to declare a dependency, for example using OpenIDE-Module-Module-Dependencies

                or OpenIDE-Module-Requires. You may use the magic token @SPECIFICATION-VERSION@

                to represent the current specification version of the module.

            </hint>

        </question>

-->

<answer id="deploy-dependencies">

<pre>

OpenIDE-Module-Module-Dependencies: org.netbeans.modules.editor.util/1 > @SPECIFICATION-VERSION@

</pre>

</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">

No additional files.

</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">

Yes.

</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/openide/doc-files/upgrade.html#3.4-public-packages">

            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">

Yes, where appropriate.

</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">

Anywhere.

</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">

No.

</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">

No.

</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">

No.

</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">

No.

</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">

No.

</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 category</a>

            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">

No.

</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">

No.

</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#recommendations">Threading Recommendations</a> (in progress)

            </hint>

        </question>

-->

<answer id="exec-threading">

No special threading models used.

</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.Transferable</code>?

            <hint>

            Often Node's deal with clipboard by usage of <code>Node.clipboardCopy, Node.clipboardCut and Node.pasteTypes</code>.

            Check your code for overriding these methods.

            </hint>

        </question>

-->

<answer id="format-clipboard">

No clipboard support.

</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</code>.

            </hint>

        </question>

-->

<answer id="format-dnd">

No D&D.

</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">

No files read or written to the disk.

</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">

No

</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">

No.

</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">

No.

</answer>

<!--

        <question id="perf-exit" when="final">

            Does your module run any code on exit?

        </question>

-->

<answer id="perf-exit">

No.

</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">

No.

</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">

No practical limits.

</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">

Mostly utility classes and methods. Sizeof() tests created where necessary.

</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">

No.

</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">

No.

</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">

No external criteria.

</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 quickly and will not

            negatively influence the performance of your own module?

            </hint>

        </question>

-->

<answer id="perf-spi">

No plugged code.

</answer>

<!--

        <question id="perf-startup" when="final">

            Does your module run any code on startup?

        </question>

-->

<answer id="perf-startup">

No.

</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">

No.

</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">

No.

</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">

No.

</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">

No.

</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">

No.

</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">

No.

</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">

No.

</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">

No.

</answer>

</api-answers>

  </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.

    <arch answers="arch-editor-util.xml" output="${arch.outputdir}/arch-editor-util.html" />

    <delete file="${arch.outputdir}/arch-editor-util.html" />

<?xml version="1.0" encoding="UTF-8"?><!-- -*- sgml-indent-step: 2 -*- -->

<!--

   -                 Sun Public License Notice

   - 

   - The contents of this file are subject to the Sun Public License

   - Version 1.0 (the "License"). You may not use this file except in

   - compliance with the License. A copy of the License is available at

   - http://www.sun.com/

   - 

   - The Original Code is NetBeans. The Initial Developer of the Original

   - Code is Sun Microsystems, Inc. Portions Copyright 1997-2003 Sun

   - Microsystems, Inc. All Rights Reserved.

  -->

<?xml-stylesheet type="text/xml" href="../../../nbbuild/javadoctools/apichanges.xsl"?>

<!DOCTYPE apichanges PUBLIC "-//NetBeans//DTD API changes list 1.0//EN" "../../../nbbuild/javadoctools/apichanges.dtd">

<!--

INFO FOR PEOPLE ADDING CHANGES:

Check the DTD (apichanges.dtd) for details on the syntax. You do not

need to regenerate the HTML, as this is part of Javadoc generation; just

change the XML. Rough syntax of a change (several parts optional):

<change>

    <api name="compiler"/>

    <summary>Some brief description here, can use <b>XHTML</b></summary>

    <version major="1" minor="99"/>

    <date day="13" month="6" year="2001"/>

    <author login="jrhacker"/>

    <compatibility addition="yes"/>

    <description>

        The main description of the change here.

        Again can use full <b>XHTML</b> as needed.

    </description>

    <class package="org.openide.compiler" name="DoWhatIWantCompiler"/>

    <issue number="14309"/>

</change>

Also permitted elements: <package>, <branch>. <version> is API spec

version, recommended for all new changes. <compatibility> should say

if things were added/modified/deprecated/etc. and give all information

related to upgrading old code. List affected top-level classes and

link to issue numbers if applicable. See the DTD for more details.

Changes need not be in any particular order, they are sorted in various

ways by the stylesheet anyway.

Dates are assumed to mean "on the trunk". If you *also* make the same

change on a stabilization branch, use the <branch> tag to indicate this

and explain why the change was made on a branch in the <description>.

Please only change this file on the trunk! Rather: you can change it

on branches if you want, but these changes will be ignored; only the

trunk version of this file is important.

Deprecations do not count as incompatible, assuming that code using the

deprecated calls continues to see their documented behavior. But do

specify deprecation="yes" in <compatibility>.

This file is not a replacement for Javadoc: it is intended to list changes,

not describe the complete current behavior, for which ordinary documentation

is the proper place.

-->

<apichanges>

  <!-- First, a list of API names you may use: -->

  <apidefs>

    <!-- Probably should not be used much: -->

    <apidef name="util">Editor Utilities API</apidef>

  </apidefs>

<!-- ACTUAL CHANGES BEGIN HERE: -->

  <changes>

     <change>

      <summary>Repackaged to org.netbeans.lib.editor.util package</summary>

        <version major="1" minor="3"/>

        <date day="13" month="3" year="2005"/>

        <author login="jtulach"/>

        <compatibility addition="yes" binary="incompatible" semantic="incompatible" />

        <description>

        <p>

            The present classes were repackaged from org.netbeans.modules.editor.util

            into org.netbeans.lib.editor.util package to fulfil the editor module

            split proposal <a href="http://www.netbeans.org/issues/show_bug.cgi?id=51486">#51486</a>

            according to which the editor classes independent of the NB IDE

            should be placed under org.netbeans.lib package.

        </p>

        </description>

        <issue number="56339"/>

    </change>

  </changes>

  <!-- Now the surrounding HTML text and document structure: -->

  <htmlcontents>

<!--

                            NO NO NO NO NO!

         ==============>    DO NOT EDIT ME!  <======================

          AUTOMATICALLY GENERATED FROM APICHANGES.XML, DO NOT EDIT

                SEE editor/util/api/apichanges.xml

-->

    <head>

      <title>Change History for the Editor Utilities API</title>

      <link rel="stylesheet" href="prose.css" type="text/css"/>

    </head>

    <body>

<p class="overviewlink"><a href="overview-summary.html">Overview</a></p>

<h1>Introduction</h1>

<p>This document lists changes made to the <a href="http://editor.netbeans.org/">Editor Utilities

API</a>. Please ask on the <code>dev@openide.netbeans.org</code> mailing list

if you have any questions about the details of a

change, or are wondering how to convert existing code to be compatible.</p>

<p>Most module authors should start by reading the <a

href="@OPENIDE@org/openide/doc-files/upgrade.html">Upgrade

Guide</a> for the current release.</p>

<!-- The actual lists of changes, as summaries and details: -->

      <hr/><standard-changelists module-code-name="org.netbeans.modules.editor.util"/>

      <hr/><p>@FOOTER@</p>

    </body>

  </htmlcontents>

</apichanges>

javadoc.arch=${basedir}/../arch/arch-editor-util.xml

javadoc.apichanges=${basedir}/api/apichanges.xml

#                 Sun Public License Notice

# 

# The contents of this file are subject to the Sun Public License

# Version 1.0 (the "License"). You may not use this file except in

# compliance with the License. A copy of the License is available at

# http://www.sun.com/

# 

# The Original Code is NetBeans. The Initial Developer of the Original

# Code is Sun Microsystems, Inc. Portions Copyright 1997-2000 Sun

# Microsystems, Inc. All Rights Reserved.

OpenIDE-Module-Name=Editor Utilities

OpenIDE-Module-Display-Category=Editing

OpenIDE-Module-Short-Description=Contains various support classes for editor related modules

OpenIDE-Module-Long-Description=Editor Utilities module contains various utility classes and methods for functionality related to editing

/*

 *                 Sun Public License Notice

 *

 * The contents of this file are subject to the Sun Public License

 * Version 1.0 (the "License"). You may not use this file except in

 * compliance with the License. A copy of the License is available at

 * http://www.sun.com/

 *

 * The Original Code is NetBeans. The Initial Developer of the Original

 * Code is Sun Microsystems, Inc. Portions Copyright 1997-2000 Sun

 * Microsystems, Inc. All Rights Reserved.

 */

package org.netbeans.lib.editor.util;

import java.util.AbstractList;

import java.util.Collection;

import java.util.RandomAccess;

/**

 * List implementation that stores items in an array

 * with a gap.

 *

 * @author Miloslav Metelka

 * @version 1.00

 */

public class GapList extends AbstractList

implements RandomAccess, Cloneable, java.io.Serializable {

    private static final Object[] EMPTY_ELEMENT_ARRAY = new Object[0];

    /**

     * The array buffer into which the elements are stored.

     * <br>

     * The elements are stored in the whole array except

     * the indexes starting at <code>gapStart</code>

     * till <code>gapStart + gapLength - 1</code>.

     */

    private transient Object elementData[];

    /**

     * The start of the gap in the elementData array.

     */

    private int gapStart;

    /**

     * Length of the gap in the elementData array starting at gapStart.

     */

    private int gapLength;

    /**

     * Constructs an empty list with the specified initial capacity.

     *

     * @param   initialCapacity   the initial capacity of the list.

     * @exception IllegalArgumentException if the specified initial capacity

     *            is negative

     */

    public GapList(int initialCapacity) {

        if (initialCapacity < 0) {

            throw new IllegalArgumentException("Illegal Capacity: " // NOI18N

                + initialCapacity);

        }

        this.elementData = new Object[initialCapacity];

        this.gapLength = initialCapacity;

    }

    /**

     * Constructs an empty list.

     */

    public GapList() {

        elementData = EMPTY_ELEMENT_ARRAY;

    }

    /**

     * Constructs a list containing the elements of the specified

     * collection, in the order they are returned by the collection's

     * iterator.  The <tt>GapList</tt> instance has an initial capacity of

     * 110% the size of the specified collection.

     *

     * @param c the collection whose elements are to be placed into this list.

     * @throws NullPointerException if the specified collection is null.

     */

    public GapList(Collection c) {

        int size = c.size();

        // Allow 10% room for growth

        elementData = new Object[

        (int)Math.min((size*110L)/100,Integer.MAX_VALUE)];

        c.toArray(elementData);

        this.gapStart = size;

        this.gapLength = elementData.length - size;

    }

    /**

     * Trims the capacity of this <tt>GapList</tt> instance to be the

     * list's current size.  An application can use this operation to minimize

     * the storage of an <tt>GapList</tt> instance.

     */

    public void trimToSize() {

        modCount++;

        if (gapLength > 0) {

            int newLength = elementData.length - gapLength;

            Object[] newElementData = new Object[newLength];

            copyAllData(newElementData);

            elementData = newElementData;

            // Leave gapStart as is

            gapLength = 0;

        }

    }

    /**

     * Increases the capacity of this <tt>GapList</tt> instance, if

     * necessary, to ensure  that it can hold at least the number of elements

     * specified by the minimum capacity argument.

     *

     * @param   minCapacity   the desired minimum capacity.

     */

    public void ensureCapacity(int minCapacity) {

        modCount++; // expected to always increment modCount - see add() operations

        int oldCapacity = elementData.length;

        if (minCapacity > oldCapacity) {

            int newCapacity = (oldCapacity * 3)/2 + 1;

            if (newCapacity < minCapacity) {

                newCapacity = minCapacity;

            }

            int gapEnd = gapStart + gapLength;

            int afterGapLength = (oldCapacity - gapEnd);

            // Must ensure the gap will not be logically moved

            // (would have to call movedAbove/BeforeGapUpdate() methods)

            int newGapEnd = newCapacity - afterGapLength;

            Object[] newElementData = new Object[newCapacity];

            System.arraycopy(elementData, 0, newElementData, 0, gapStart);

            System.arraycopy(elementData, gapEnd, newElementData, newGapEnd, afterGapLength);

            elementData = newElementData;

            gapLength = newGapEnd - gapStart;

        }

    }

    /**

     * Returns the number of elements in this list.

     *

     * @return  the number of elements in this list.

     */

    public int size() {

        return elementData.length - gapLength;

    }

    /**

     * Tests if this list has no elements.

     *

     * @return  <tt>true</tt> if this list has no elements;

     *          <tt>false</tt> otherwise.

     */

    public boolean isEmpty() {

        return (elementData.length == gapLength);

    }

    /**

     * Returns <tt>true</tt> if this list contains the specified element.

     *

     * @param elem element whose presence in this List is to be tested.

     * @return  <code>true</code> if the specified element is present;

     *		<code>false</code> otherwise.

     */

    public boolean contains(Object elem) {

        return indexOf(elem) >= 0;

    }

    /**

     * Searches for the first occurence of the given argument, testing

     * for equality using the <tt>equals</tt> method.

     *

     * @param   elem   an object.

     * @return  the index of the first occurrence of the argument in this

     *          list; returns <tt>-1</tt> if the object is not found.

     * @see     Object#equals(Object)

     */

    public int indexOf(Object elem) {

        if (elem == null) {

            int i = 0;

            while (i < gapStart) {

                if (elementData[i] == null) {

                    return i;

                }

                i++;

            }

            i += gapLength;

            int elementDataLength = elementData.length;

            while (i < elementDataLength) {

                if (elementData[i] == null) {

                    return i;

                }

                i++;

            }

        } else { // elem not null

            int i = 0;

            while (i < gapStart) {

                if (elem.equals(elementData[i])) {

                    return i;

                }

                i++;

            }

            i += gapLength;

            int elementDataLength = elementData.length;

            while (i < elementDataLength) {

                if (elem.equals(elementData[i])) {

                    return i;

                }

                i++;

            }

        }

        return -1;

    }

    /**

     * Returns the index of the last occurrence of the specified object in

     * this list.

     *

     * @param   elem   the desired element.

     * @return  the index of the last occurrence of the specified object in

     *          this list; returns -1 if the object is not found.

     */

    public int lastIndexOf(Object elem) {

        if (elem == null) {

            int i = elementData.length - 1;

            int gapEnd = gapStart + gapLength;

            while (i >= gapEnd) {

                if (elementData[i] == null) {

                    return i;

                }

                i--;

            }

            i -= gapLength;

            while (i >= 0) {

                if (elementData[i] == null) {

                    return i;

                }

                i--;

            }

        } else { // elem not null

            int i = elementData.length - 1;

            int gapEnd = gapStart + gapLength;

            while (i >= gapEnd) {

                if (elem.equals(elementData[i])) {

                    return i;

                }

                i--;

            }

            i -= gapLength;

            while (i >= 0) {

                if (elem.equals(elementData[i])) {

                    return i;

                }

                i--;

            }

        }

        return -1;

    }

    /**

     * Returns a shallow copy of this <tt>GapList</tt> instance.  (The

     * elements themselves are not copied.)

     *

     * @return  a clone of this <tt>GapList</tt> instance.

     */

    public Object clone() {

        try {

            GapList clonedList = (GapList)super.clone();

            int size = size();

            Object[] clonedElementData = new Object[size];

            copyAllData(clonedElementData);

            clonedList.elementData = clonedElementData;

            // Will retain gapStart - would have to call moved*() otherwise

            clonedList.gapStart = size;

            clonedList.resetModCount();

            return clonedList;

        } catch (CloneNotSupportedException e) {

            // this shouldn't happen, since we are Cloneable

            throw new InternalError();

        }

    }

    public void copyItems(int srcStartIndex, int srcEndIndex,

    Object[] dest, int destIndex) {

        if (srcStartIndex < 0 || srcEndIndex < srcStartIndex || srcEndIndex > size()) {

            throw new IndexOutOfBoundsException("srcStartIndex=" + srcStartIndex // NOI18N

            + ", srcEndIndex=" + srcEndIndex + ", size()=" + size()); // NOI18N

        }

        if (srcEndIndex < gapStart) { // fully below gap

            System.arraycopy(elementData, srcStartIndex,

            dest, destIndex, srcEndIndex - srcStartIndex);

        } else { // above gap or spans the gap

            if (srcStartIndex >= gapStart) { // fully above gap

                System.arraycopy(elementData, srcStartIndex + gapLength, dest, destIndex,

                srcEndIndex - srcStartIndex);

            } else { // spans gap

                int beforeGap = gapStart - srcStartIndex;

                System.arraycopy(elementData, srcStartIndex, dest, destIndex, beforeGap);

                System.arraycopy(elementData, gapStart + gapLength, dest, destIndex + beforeGap,

                srcEndIndex - srcStartIndex - beforeGap);

            }

        }

    }

    /**

     * Returns an array containing all of the elements in this list

     * in the correct order.

     *

     * @return an array containing all of the elements in this list

     * 	       in the correct order.

     */

    public Object[] toArray() {

        int size = size();

        Object[] result = new Object[size];

        copyAllData(result);

        return result;

    }

    /**

     * Returns an array containing all of the elements in this list in the

     * correct order; the runtime type of the returned array is that of the

     * specified array.  If the list fits in the specified array, it is

     * returned therein.  Otherwise, a new array is allocated with the runtime

     * type of the specified array and the size of this list.<p>

     *

     * If the list fits in the specified array with room to spare (i.e., the

     * array has more elements than the list), the element in the array

     * immediately following the end of the collection is set to

     * <tt>null</tt>.  This is useful in determining the length of the list

     * <i>only</i> if the caller knows that the list does not contain any

     * <tt>null</tt> elements.

     *

     * @param a the array into which the elements of the list are to

     *		be stored, if it is big enough; otherwise, a new array of the

     * 		same runtime type is allocated for this purpose.

     * @return an array containing the elements of the list.

     * @throws ArrayStoreException if the runtime type of a is not a supertype

     *         of the runtime type of every element in this list.

     */

    public Object[] toArray(Object a[]) {

        int size = size();

        if (a.length < size) {

            a = (Object[])java.lang.reflect.Array.newInstance(

                a.getClass().getComponentType(), size);

        }

        copyAllData(a);

        if (a.length > size)

            a[size] = null;

        return a;

    }

    // Positional Access Operations

    /**

     * Returns the element at the specified position in this list.

     *

     * @param  index index of element to return.

     * @return the element at the specified position in this list.

     * @throws    IndexOutOfBoundsException if index is out of range <tt>(index

     * 		  &lt; 0 || index &gt;= size())</tt>.

     */

    public Object get(int index) {

        // rangeCheck(index) not necessary - would fail with AIOOBE anyway

        return elementData[(index < gapStart) ? index : (index + gapLength)];

    }

    /**

     * Replaces the element at the specified position in this list with

     * the specified element.

     *

     * @param index index of element to replace.

     * @param element element to be stored at the specified position.

     * @return the element previously at the specified position.

     * @throws    IndexOutOfBoundsException if index out of range

     *		  <tt>(index &lt; 0 || index &gt;= size())</tt>.

     */

    public Object set(int index, Object element) {

        // rangeCheck(index) not necessary - would fail with AIOOBE anyway

        if (index >= gapStart) {

            index += gapLength;

        }

        Object oldValue = elementData[index];

        elementData[index] = element;

        return oldValue;

    }

    /**

     * Appends the specified element to the end of this list.

     *

     * @param o element to be appended to this list.

     * @return <tt>true</tt> (as per the general contract of Collection.add).

     */

    public boolean add(Object o) {

        add(size(), o);

        return true;

    }

    /**

     * Inserts the specified element at the specified position in this

     * list. Shifts the element currently at that position (if any) and

     * any subsequent elements to the right (adds one to their indices).

     *

     * @param index index at which the specified element is to be inserted.

     * @param element element to be inserted.

     * @throws    IndexOutOfBoundsException if index is out of range

     *		  <tt>(index &lt; 0 || index &gt; size())</tt>.

     */

    public void add(int index, Object element) {

        int size = size();

        if (index > size || index < 0) {

            throw new IndexOutOfBoundsException(

                "Index: " + index + ", Size: " + size); // NOI18N

        }

        ensureCapacity(size + 1);  // Increments modCount!!

        moveGap(index);

        elementData[gapStart++] = element;

        gapLength--;

    }

    /**

     * Appends all of the elements in the specified Collection to the end of

     * this list, in the order that they are returned by the

     * specified Collection's Iterator.  The behavior of this operation is

     * undefined if the specified Collection is modified while the operation

     * is in progress.  (This implies that the behavior of this call is

     * undefined if the specified Collection is this list, and this

     * list is nonempty.)

     *

     * @param c the elements to be inserted into this list.

     * @return <tt>true</tt> if this list changed as a result of the call.

     * @throws    NullPointerException if the specified collection is null.

     */

    public boolean addAll(Collection c) {

        return addAll(size(), c);

    }

    /**

     * Inserts all of the elements in the specified Collection into this

     * list, starting at the specified position.  Shifts the element

     * currently at that position (if any) and any subsequent elements to

     * the right (increases their indices).  The new elements will appear

     * in the list in the order that they are returned by the

     * specified Collection's iterator.

     *

     * @param index index at which to insert first element

     *		    from the specified collection.

     * @param c elements to be inserted into this list.

     * @return <tt>true</tt> if this list changed as a result of the call.

     * @throws    IndexOutOfBoundsException if index out of range <tt>(index

     *		  &lt; 0 || index &gt; size())</tt>.

     * @throws    NullPointerException if the specified Collection is null.

     */

    public boolean addAll(int index, Collection c) {

        return addArray(index, c.toArray());

    }

    /*

     * Inserts all elements from the given array into this list, starting

     * at the given index.

     *

     * @param index index at which to insert first element from the array.

     * @param elements array of elements to insert.

     */

    public boolean addArray(int index, Object[] elements) {

        return addArray(index, elements, 0, elements.length);

    }

    /**

     * Inserts elements from the given array into this list, starting

     * at the given index.

     *

     * @param index index at which to insert first element.

     * @param elements array of elements from which to insert elements.

     * @param off offset in the elements pointing to first element to copy.

     * @param len number of elements to copy from the elements array.

     */

    public boolean addArray(int index, Object[] elements, int off, int len) {

        int size = size();

        if (index > size || index < 0) {

            throw new IndexOutOfBoundsException(

                "Index: " + index + ", Size: " + size); // NOI18N

        }

        ensureCapacity(size + len);  // Increments modCount

        moveGap(index);

        System.arraycopy(elements, off, elementData, gapStart, len);

        gapStart += len;

        gapLength -= len;

        return (len != 0);

    }

    /**

     * Removes all of the elements from this list.  The list will

     * be empty after this call returns.

     */

    public void clear() {

        removeRange(0, size());

    }

    /**

     * Removes the element at the specified position in this list.

     * Shifts any subsequent elements to the left (subtracts one from their

     * indices).

     *

     * @param index the index of the element to removed.

     * @return the element that was removed from the list.

     * @throws    IndexOutOfBoundsException if index out of range <tt>(index

     * 		  &lt; 0 || index &gt;= size())</tt>.

     */

    public Object remove(int index) {

        int size = size();

        if (index >= size || index < 0) {

            throw new IndexOutOfBoundsException(

                "remove(): Index: " + index + ", Size: " + size); // NOI18N

        }

        modCount++;

        moveGap(index + 1); // if previous were adds() - this should be no-op

        Object oldValue = elementData[index];

        removeUpdate(index, elementData, index, index + 1);

        elementData[index] = null;

        gapStart--;

        gapLength++;

        return oldValue;

    }

    /**

     * Removes elements at the given index.

     *

     * @param index index of the first element to be removed.

     * @param count number of elements to remove.

     */

    public void remove(int index, int count) {

        int toIndex = index + count;

        if (index < 0 || toIndex < index || toIndex > size()) {

            throw new IndexOutOfBoundsException("index=" + index // NOI18N

            + ", count=" + count + ", size()=" + size()); // NOI18N

        }

        removeRange(index, toIndex);

    }

    /**

     * Removes from this List all of the elements whose index is between

     * fromIndex, inclusive and toIndex, exclusive.  Shifts any succeeding

     * elements to the left (reduces their index).

     * This call shortens the list by <tt>(toIndex - fromIndex)</tt> elements.

     * (If <tt>toIndex==fromIndex</tt>, this operation has no effect.)

     *

     * @param fromIndex index of first element to be removed.

     * @param toIndex index after last element to be removed.

     */

    protected void removeRange(int fromIndex, int toIndex) {

        modCount++;

        if (fromIndex == toIndex) {

            return;

        }

        int removeCount = toIndex - fromIndex;

        if (fromIndex >= gapStart) { // completely over gap

            // Move gap to the start of the removed area

            // (this should be the minimum necessary count of elements moved)

            moveGap(fromIndex);

            // Allow GC of removed items

            fromIndex += gapLength; // begining of abandoned area

            toIndex += gapLength;

            removeUpdate(fromIndex - gapLength, elementData, fromIndex, toIndex);

            while (fromIndex < toIndex) {

                elementData[fromIndex] = null;

                fromIndex++;

            }

        } else { // completely below gap or spans the gap

            if (toIndex <= gapStart) {

                // Move gap to the end of the removed area

                // (this should be the minimum necessary count of elements moved)

                moveGap(toIndex);

                gapStart = fromIndex;

                // Call removeUpdate() for items that will be physically removed soon

                removeUpdate(fromIndex, elementData, fromIndex, toIndex);

            } else { // spans gap: gapStart > fromIndex but gapStart - fromIndex < removeCount

                removeUpdate(fromIndex, elementData, fromIndex, gapStart);

                // Allow GC of removed items

                for (int clearIndex = fromIndex; clearIndex < gapStart; clearIndex++) {

                    elementData[clearIndex] = null;

                }

                fromIndex = gapStart + gapLength; // part above the gap

                gapStart = toIndex - removeCount; // original value of fromIndex

                toIndex += gapLength;

                removeUpdate(gapStart, elementData, fromIndex, toIndex);

            }

            // Allow GC of removed items

            while (fromIndex < toIndex) {

                elementData[fromIndex++] = null;

            }

        }

        gapLength += removeCount;

    }

    /**

     * Called prior physical removing of the data from the list.

     * <br>

     * The implementation can possibly update the elements in the removed area.

     * <br>

     * After this method finishes the whole removed area will be

     * <code>null</code>-ed.

     *

     * @param index index in the list of the first item being removed.

     * @param data array of objects from which the data are being removed.

     *  The next two parameters define the indexes at which the elements

     *  can be updated.

     *  <br>

     *  Absolutely no changes should be done outside of

     *  <code>&lt;startOff, endOff)</code> area.

     * @param startOff offset in the data array of the first element that

     *  will be removed.

     * @param endOff offset in the data array following the last item that will

     *  be removed.

     */

    protected void removeUpdate(int index, Object[] data, int startOff, int endOff) {

    }

    /*

    protected void movedAboveGapUpdate(Object[] array, int index, int count) {

    }

    protected void movedBelowGapUpdate(Object[] array, int index, int count) {

    }

    */

    private void moveGap(int index) {

        if (index == gapStart) {

            return; // do nothing

        }

        if (index < gapStart) { // move gap down

            int moveSize = gapStart - index;

            System.arraycopy(elementData, index, elementData,

            gapStart + gapLength - moveSize, moveSize);

            clearEmpty(index, Math.min(moveSize, gapLength));

            gapStart = index;

            // movedAboveGapUpdate(elementData, gapStart + gapLength, moveSize);

        } else { // above gap

            int gapEnd = gapStart + gapLength;

            int moveSize = index - gapStart;

            System.arraycopy(elementData, gapEnd, elementData, gapStart, moveSize);

            if (index < gapEnd) {

                clearEmpty(gapEnd, moveSize);

            } else {

                clearEmpty(index, gapLength);

            }

            // movedBelowGapUpdate(elementData, gapStart, moveSize);

            gapStart += moveSize;

        }

    }

    private void copyAllData(Object[] toArray) {

        if (gapLength != 0) {

            int gapEnd = gapStart + gapLength;

            System.arraycopy(elementData, 0, toArray, 0, gapStart);

            System.arraycopy(elementData, gapEnd, toArray, gapStart,

                elementData.length - gapEnd);

        } else { // no gap => single copy of everything

            System.arraycopy(elementData, 0, toArray, 0, elementData.length);

        }

    }

    private void clearEmpty(int index, int length) {

        while (--length >= 0) {

            elementData[index++] = null; // allow GC

        }

    }

    private void resetModCount() {

        modCount = 0;

    }

    /**

     * Save the state of the <tt>GapList</tt> instance to a stream (that

     * is, serialize it).

     *

     * @serialData The length of the array backing the <tt>GapList</tt>

     *             instance is emitted (int), followed by all of its elements

     *             (each an <tt>Object</tt>) in the proper order.

     */

    private void writeObject(java.io.ObjectOutputStream s)

    throws java.io.IOException{

        // Write out element count, and any hidden stuff

        s.defaultWriteObject();

        // Write out array length

        s.writeInt(elementData.length);

        // Write out all elements in the proper order.

        int i = 0;

        while (i < gapStart) {