Quelle  apichanges.xml

<?xml version="1.0" encoding="UTF-8"?>
<!-- Search for CHANGEME in this document when copying and using it: -->
<!--

    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.

-->
<?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>
        <apidef name="general">Editor Guarded Sections API</apidef>
        <!-- etc. -->
    </apidefs>

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

    <changes>
        <change id="protectRange">
            <api name="general"/>
            <summary>Allow to protect existing text</summary>
            <version major="1" minor="33"/>
            <date day="17" month="2" year="2016"/>
            <author login="sdedic"/>
            <compatibility addition="yes" binary="compatible" source="compatible"/>
            <description>
                Added method to create guarded block on top of existing text.
            </description>
            <class name="GuardedSectionManager" package="org.netbeans.api.editor.guards"/>
        </change>
        <change id="DocumentGuards">
            <api name="general"/>
            <summary>DocumentGuards API</summary>
            <version major="1" minor="29"/>
            <date day="21" month="5" year="2014"/>
            <author login="sdedic"/>
            <compatibility addition="yes" binary="compatible" deletion="no" deprecation="no" modification="no"/>
            <description>
                <p>
                    APIs exposed and actually used on GuardedDocument in <code>editor.lib</code> module is now declared in Editor Guarded Sections.
                    Clients may depend on Guarded Sections instead of on fading-away editor.lib module.
                </p>
                <p>
                    Dependency on <code>openide.text</code> eliminated, new SPI <code>GuardedRegionMarker</code>
                    is added for Documents that are willing to style their contents according to guarded areas.
                </p>
            </description>
            <class name="GuardedRegionMarker" package="org.netbeans.spi.editor.guards"/>
            <class name="DocumentGuards" package="org.netbeans.api.editor.guards"/>
            <issue number="244679"/>
        </change>
        <change id="AbstractGuardedSectionsProvider-useReadersWritersOnSet">
            <api name="general"/>
            <summary>Ability run guarded readers/writers when the content of the guarded section's content is set</summary>
            <version major="1" minor="20"/>
            <date day="25" month="11" year="2012"/>
            <author login="jlahoda"/>
            <compatibility addition="yes" binary="compatible" deletion="no" deprecation="no" modification="no"/>
            <description>
                <p>When this option is set, setting the content of a GuardedSection will pass the data through the given
                guarded writer and back through the given guarded reader, to ensure the result is the same
                as if it would be read from the disk.</p>
                <p>Note that this new mode is not fully compatible with the original mode, e.g. all the set methods
                of all the GuardedSection classes will throw IllegalStateException if invoked inside the write&read part.</p>
            </description>
            <issue number="221844"/>
        </change>
        
        <change id="GuardedSectionsProvider-Charset">
            <api name="general"/>
            <summary>GuardedSectionsProvider supports Charset</summary>
            <version major="1" minor="0"/>
            <date day="19" month="6" year="2007"/>
            <author login="jpokorsky"/>
            <compatibility addition="no" binary="incompatible" deletion="no" deprecation="no" modification="yes"/>
            <description>
                In order to use proper encoding by guards impl it is necessary to
                change GuardedSectionsProvider to accept encoding rather as <code>java.nio.Charset</code> instance
                than as a plain encoding name.
                <ul>
                    <li><code>Reader createGuardedReader(InputStream stream, String encoding) throws UnsupportedEncodingException</code>
                        replaced with
                        <code>Reader createGuardedReader(InputStream stream, Charset charset)</code></li>
                    <li><code>Writer createGuardedWriter(OutputStream stream, String encoding) throws UnsupportedEncodingException</code>
                        replaced with
                        <code>Reader createGuardedReader(InputStream stream, Charset charset)</code></li>
                </ul>
            </description>
            <issue number="99363"/>
        </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 CHANGEME/apichanges.xml

-->
    <head>
      <title>Change History for the Editor Guarded Sections 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="@org-netbeans-modules-editor-guards@/architecture-summary.html">-->Editor Guarded Sections API<!--</a>-->.</p>

<!-- The actual lists of changes, as summaries and details: -->
      <hr/>
      <standard-changelists module-code-name="org.netbeans.modules.editor.guards/1"/>

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

    </body>
  </htmlcontents>

</apichanges>