Skip navigation links

Introduction

This document lists changes made to the Braces Matching SPI.


Index of APIs

Incompatible changes by date

Fuller descriptions of all changes can be found below (follow links).

Not all deprecations are listed here, assuming that the deprecated APIs continue to essentially work. For a full deprecation list, please consult the Javadoc.

All changes by date

Changes by version

These API specification versions may be used to indicate that a module requires a certain API feature in order to function. For example, if you see here a feature you need which is labelled 1.20, your manifest should contain in its main attributes the line:

OpenIDE-Module-Module-Dependencies: org.netbeans.modules.editor.bracesmatching/0 > 1.20

Changes by affected class

org.netbeans.spi.editor.bracesmatching.BraceContext

org.netbeans.spi.editor.bracesmatching.BracesMatcher


Details of all changes by API and date


Uncategorized changes

Semantic context can be provided for a brace

May 6 '13; API spec. version: 1.30; affected top-level classes: BracesMatcher BraceContext; made by: sdedic; issues: #217730
The brace tooltip may need to display additional text, if for example if-condition spans multiple lines, or for an else-branch, where the important information (if-condition text) is located elsewhere. BraceMatcher can implement the optional mixin BraceMatcher.ContextLocator and provide boundaries for this additional text.

Document locking changed

Aug 27 '08; API spec. version: 1.6; made by: vstejskal; issues: #131284

The infrastructure does not lock the document prior calling the BracesMatcher methods. This change was done in order to support BracesMatcher implementations that need parser results and have to lock the parser first.

From now on it's up to BracesMatcher implementations to readlock the document when directly searching through it for the origin or matching areas.

Added MatcherContext.isTastCanceled()

Nov 3 '07; API spec. version: 1.3; made by: vstejskal; issues: #114651

The concept of using Thread.currentThread().interrupt() for canceling braces matching tasks is flawed. The call breaks synchronization of other parts ofthe system that are used from the braces matching tasks, which results in InterruptedExceptions throw from various random places and possibly in corruption of internal data.

We introduced MatcherContext.isTaskCanceled() method for determinig if a braces matching task was caceled.

Marking the SPI as under development

Nov 1 '07; API spec. version: 1.2; made by: vstejskal

The API has gone through a fast track review, but we would like to give it one relase as a stabilization period. Therefore its major version was set to 0.

Additional highlights from BracesMatcher.findOrigin

Jun 18 '07; API spec. version: 1.1; made by: vstejskal

The BracesMatcher.findOrigin can return additional offset pairs for areas that it wants to be highlighted. The first offset pair should always mark the whole original area. If no other pairs are supplied the whole original area will be highlighted.

Braces Matching SPI created

May 17 '07; API spec. version: 1.0; made by: vstejskal

The Braces Matching SPI was created.


Built on October 1 2022.  |   Copyright © 2017-2022 Apache Software Foundation. All Rights Reserved.