Skip to content

Commit d0a8af2

Browse files
committed
Fix API warnings in macosx fragments
For cocoa specific implementations of - o.e.swt.accessibility.Accessible tag methods already tagged as @noreference also with @nooverride so that API tools considers them as internal and does not complain about non-API types being referenced in their signature. - o.e.swt.graphics.GCData tag all fields as @noreference so that API tools does not complain about non-API types being used in public fields of this actually internal class (tagged as @noreference). Suppress issue about forbidden extension of Scrollable by Composite.
1 parent 2bfbebf commit d0a8af2

File tree

4 files changed

+226
-16
lines changed
  • binaries
  • bundles/org.eclipse.swt

4 files changed

+226
-16
lines changed

binaries/org.eclipse.swt.cocoa.macosx.aarch64/.settings/.api_filters

Lines changed: 102 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -248,6 +248,108 @@
248248
</message_arguments>
249249
</filter>
250250
</resource>
251+
<resource path="Eclipse SWT/cocoa/org/eclipse/swt/graphics/GCData.java" type="org.eclipse.swt.graphics.GCData">
252+
<filter id="338940029">
253+
<message_arguments>
254+
<message_argument value="org.eclipse.swt.graphics.GCData"/>
255+
<message_argument value="bg"/>
256+
</message_arguments>
257+
</filter>
258+
<filter id="338940029">
259+
<message_arguments>
260+
<message_argument value="org.eclipse.swt.graphics.GCData"/>
261+
<message_argument value="clipPath"/>
262+
</message_arguments>
263+
</filter>
264+
<filter id="338940029">
265+
<message_arguments>
266+
<message_argument value="org.eclipse.swt.graphics.GCData"/>
267+
<message_argument value="fg"/>
268+
</message_arguments>
269+
</filter>
270+
<filter id="338940029">
271+
<message_arguments>
272+
<message_argument value="org.eclipse.swt.graphics.GCData"/>
273+
<message_argument value="flippedContext"/>
274+
</message_arguments>
275+
</filter>
276+
<filter id="338940029">
277+
<message_arguments>
278+
<message_argument value="org.eclipse.swt.graphics.GCData"/>
279+
<message_argument value="inverseTransform"/>
280+
</message_arguments>
281+
</filter>
282+
<filter id="338940029">
283+
<message_arguments>
284+
<message_argument value="org.eclipse.swt.graphics.GCData"/>
285+
<message_argument value="layoutManager"/>
286+
</message_arguments>
287+
</filter>
288+
<filter id="338940029">
289+
<message_arguments>
290+
<message_argument value="org.eclipse.swt.graphics.GCData"/>
291+
<message_argument value="paintRect"/>
292+
</message_arguments>
293+
</filter>
294+
<filter id="338940029">
295+
<message_arguments>
296+
<message_argument value="org.eclipse.swt.graphics.GCData"/>
297+
<message_argument value="path"/>
298+
</message_arguments>
299+
</filter>
300+
<filter id="338940029">
301+
<message_arguments>
302+
<message_argument value="org.eclipse.swt.graphics.GCData"/>
303+
<message_argument value="size"/>
304+
</message_arguments>
305+
</filter>
306+
<filter id="338940029">
307+
<message_arguments>
308+
<message_argument value="org.eclipse.swt.graphics.GCData"/>
309+
<message_argument value="textContainer"/>
310+
</message_arguments>
311+
</filter>
312+
<filter id="338940029">
313+
<message_arguments>
314+
<message_argument value="org.eclipse.swt.graphics.GCData"/>
315+
<message_argument value="textStorage"/>
316+
</message_arguments>
317+
</filter>
318+
<filter id="338940029">
319+
<message_arguments>
320+
<message_argument value="org.eclipse.swt.graphics.GCData"/>
321+
<message_argument value="transform"/>
322+
</message_arguments>
323+
</filter>
324+
<filter id="338940029">
325+
<message_arguments>
326+
<message_argument value="org.eclipse.swt.graphics.GCData"/>
327+
<message_argument value="view"/>
328+
</message_arguments>
329+
</filter>
330+
<filter id="338940029">
331+
<message_arguments>
332+
<message_argument value="org.eclipse.swt.graphics.GCData"/>
333+
<message_argument value="visiblePath"/>
334+
</message_arguments>
335+
</filter>
336+
</resource>
337+
<resource path="Eclipse SWT/cocoa/org/eclipse/swt/widgets/Composite.java" type="org.eclipse.swt.widgets.Composite">
338+
<filter id="576778288">
339+
<message_arguments>
340+
<message_argument value="Scrollable"/>
341+
<message_argument value="Composite"/>
342+
</message_arguments>
343+
</filter>
344+
</resource>
345+
<resource path="Eclipse SWT/cocoa/org/eclipse/swt/widgets/Display.java" type="org.eclipse.swt.widgets.Display">
346+
<filter id="336744520">
347+
<message_arguments>
348+
<message_argument value="@noextend"/>
349+
<message_argument value="org.eclipse.swt.widgets.Display"/>
350+
</message_arguments>
351+
</filter>
352+
</resource>
251353
<resource path="Eclipse SWT/common/org/eclipse/swt/events/ArmListener.java" type="org.eclipse.swt.events.ArmListener">
252354
<filter id="576720909">
253355
<message_arguments>
@@ -448,14 +550,6 @@
448550
</message_arguments>
449551
</filter>
450552
</resource>
451-
<resource path="Eclipse SWT/cocoa/org/eclipse/swt/widgets/Display.java" type="org.eclipse.swt.widgets.Display">
452-
<filter id="336744520">
453-
<message_arguments>
454-
<message_argument value="@noextend"/>
455-
<message_argument value="org.eclipse.swt.widgets.Display"/>
456-
</message_arguments>
457-
</filter>
458-
</resource>
459553
<resource path="Eclipse SWT/common/org/eclipse/swt/widgets/TypedListener.java" type="org.eclipse.swt.widgets.TypedListener">
460554
<filter comment="Class declared as internal in its JavaDoc since ever." id="336744520">
461555
<message_arguments>

binaries/org.eclipse.swt.cocoa.macosx.x86_64/.settings/.api_filters

Lines changed: 102 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -248,6 +248,108 @@
248248
</message_arguments>
249249
</filter>
250250
</resource>
251+
<resource path="Eclipse SWT/cocoa/org/eclipse/swt/graphics/GCData.java" type="org.eclipse.swt.graphics.GCData">
252+
<filter id="338940029">
253+
<message_arguments>
254+
<message_argument value="org.eclipse.swt.graphics.GCData"/>
255+
<message_argument value="bg"/>
256+
</message_arguments>
257+
</filter>
258+
<filter id="338940029">
259+
<message_arguments>
260+
<message_argument value="org.eclipse.swt.graphics.GCData"/>
261+
<message_argument value="clipPath"/>
262+
</message_arguments>
263+
</filter>
264+
<filter id="338940029">
265+
<message_arguments>
266+
<message_argument value="org.eclipse.swt.graphics.GCData"/>
267+
<message_argument value="fg"/>
268+
</message_arguments>
269+
</filter>
270+
<filter id="338940029">
271+
<message_arguments>
272+
<message_argument value="org.eclipse.swt.graphics.GCData"/>
273+
<message_argument value="flippedContext"/>
274+
</message_arguments>
275+
</filter>
276+
<filter id="338940029">
277+
<message_arguments>
278+
<message_argument value="org.eclipse.swt.graphics.GCData"/>
279+
<message_argument value="inverseTransform"/>
280+
</message_arguments>
281+
</filter>
282+
<filter id="338940029">
283+
<message_arguments>
284+
<message_argument value="org.eclipse.swt.graphics.GCData"/>
285+
<message_argument value="layoutManager"/>
286+
</message_arguments>
287+
</filter>
288+
<filter id="338940029">
289+
<message_arguments>
290+
<message_argument value="org.eclipse.swt.graphics.GCData"/>
291+
<message_argument value="paintRect"/>
292+
</message_arguments>
293+
</filter>
294+
<filter id="338940029">
295+
<message_arguments>
296+
<message_argument value="org.eclipse.swt.graphics.GCData"/>
297+
<message_argument value="path"/>
298+
</message_arguments>
299+
</filter>
300+
<filter id="338940029">
301+
<message_arguments>
302+
<message_argument value="org.eclipse.swt.graphics.GCData"/>
303+
<message_argument value="size"/>
304+
</message_arguments>
305+
</filter>
306+
<filter id="338940029">
307+
<message_arguments>
308+
<message_argument value="org.eclipse.swt.graphics.GCData"/>
309+
<message_argument value="textContainer"/>
310+
</message_arguments>
311+
</filter>
312+
<filter id="338940029">
313+
<message_arguments>
314+
<message_argument value="org.eclipse.swt.graphics.GCData"/>
315+
<message_argument value="textStorage"/>
316+
</message_arguments>
317+
</filter>
318+
<filter id="338940029">
319+
<message_arguments>
320+
<message_argument value="org.eclipse.swt.graphics.GCData"/>
321+
<message_argument value="transform"/>
322+
</message_arguments>
323+
</filter>
324+
<filter id="338940029">
325+
<message_arguments>
326+
<message_argument value="org.eclipse.swt.graphics.GCData"/>
327+
<message_argument value="view"/>
328+
</message_arguments>
329+
</filter>
330+
<filter id="338940029">
331+
<message_arguments>
332+
<message_argument value="org.eclipse.swt.graphics.GCData"/>
333+
<message_argument value="visiblePath"/>
334+
</message_arguments>
335+
</filter>
336+
</resource>
337+
<resource path="Eclipse SWT/cocoa/org/eclipse/swt/widgets/Composite.java" type="org.eclipse.swt.widgets.Composite">
338+
<filter id="576778288">
339+
<message_arguments>
340+
<message_argument value="Scrollable"/>
341+
<message_argument value="Composite"/>
342+
</message_arguments>
343+
</filter>
344+
</resource>
345+
<resource path="Eclipse SWT/cocoa/org/eclipse/swt/widgets/Display.java" type="org.eclipse.swt.widgets.Display">
346+
<filter id="336744520">
347+
<message_arguments>
348+
<message_argument value="@noextend"/>
349+
<message_argument value="org.eclipse.swt.widgets.Display"/>
350+
</message_arguments>
351+
</filter>
352+
</resource>
251353
<resource path="Eclipse SWT/common/org/eclipse/swt/events/ArmListener.java" type="org.eclipse.swt.events.ArmListener">
252354
<filter id="576720909">
253355
<message_arguments>
@@ -448,14 +550,6 @@
448550
</message_arguments>
449551
</filter>
450552
</resource>
451-
<resource path="Eclipse SWT/cocoa/org/eclipse/swt/widgets/Display.java" type="org.eclipse.swt.widgets.Display">
452-
<filter id="336744520">
453-
<message_arguments>
454-
<message_argument value="@noextend"/>
455-
<message_argument value="org.eclipse.swt.widgets.Display"/>
456-
</message_arguments>
457-
</filter>
458-
</resource>
459553
<resource path="Eclipse SWT/common/org/eclipse/swt/widgets/TypedListener.java" type="org.eclipse.swt.widgets.TypedListener">
460554
<filter comment="Class declared as internal in its JavaDoc since ever." id="336744520">
461555
<message_arguments>

bundles/org.eclipse.swt/Eclipse SWT Accessibility/cocoa/org/eclipse/swt/accessibility/Accessible.java

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -789,6 +789,7 @@ id getColumnsAttribute(int childID) {
789789
* </p>
790790
*
791791
* @noreference This method is not intended to be referenced by clients.
792+
* @nooverride This method is not intended to be re-implemented or extended by clients.
792793
*/
793794
public id internal_accessibilityActionDescription(NSString action, int childID) {
794795
NSString returnValue = NSString.string();
@@ -834,6 +835,7 @@ public id internal_accessibilityActionDescription(NSString action, int childID)
834835
* </p>
835836
*
836837
* @noreference This method is not intended to be referenced by clients.
838+
* @nooverride This method is not intended to be re-implemented or extended by clients.
837839
*/
838840
public NSArray internal_accessibilityActionNames(int childID) {
839841
if (accessibleActionListenersSize() > 0) {
@@ -919,6 +921,7 @@ public NSArray internal_accessibilityActionNames(int childID) {
919921
* </p>
920922
*
921923
* @noreference This method is not intended to be referenced by clients.
924+
* @nooverride This method is not intended to be re-implemented or extended by clients.
922925
*/
923926
public boolean internal_accessibilityIsAttributeSettable(NSString attribute, int childID) {
924927
if (accessibleTextExtendedListenersSize() > 0) {
@@ -944,6 +947,7 @@ public boolean internal_accessibilityIsAttributeSettable(NSString attribute, int
944947
* </p>
945948
*
946949
* @noreference This method is not intended to be referenced by clients.
950+
* @nooverride This method is not intended to be re-implemented or extended by clients.
947951
*/
948952
public NSArray internal_accessibilityAttributeNames(int childID) {
949953
// The supported attribute set depends on the role played by the control.
@@ -1226,6 +1230,7 @@ public NSArray internal_accessibilityAttributeNames(int childID) {
12261230
* </p>
12271231
*
12281232
* @noreference This method is not intended to be referenced by clients.
1233+
* @nooverride This method is not intended to be re-implemented or extended by clients.
12291234
*/
12301235
public id internal_accessibilityAttributeValue(NSString attribute, int childID) {
12311236
if (attribute.isEqualToString(OS.NSAccessibilityRoleAttribute)) return getRoleAttribute(childID);
@@ -1285,6 +1290,7 @@ public id internal_accessibilityAttributeValue(NSString attribute, int childID)
12851290
* </p>
12861291
*
12871292
* @noreference This method is not intended to be referenced by clients.
1293+
* @nooverride This method is not intended to be re-implemented or extended by clients.
12881294
*/
12891295
public id internal_accessibilityAttributeValue_forParameter(NSString attribute, id parameter, int childID) {
12901296
if (attribute.isEqualToString(OS.NSAccessibilityStringForRangeParameterizedAttribute)) return getStringForRangeParameterizedAttribute(parameter, childID);
@@ -1312,6 +1318,7 @@ public id internal_accessibilityAttributeValue_forParameter(NSString attribute,
13121318
* </p>
13131319
*
13141320
* @noreference This method is not intended to be referenced by clients.
1321+
* @nooverride This method is not intended to be re-implemented or extended by clients.
13151322
*/
13161323
public id internal_accessibilityFocusedUIElement(int childID) {
13171324
AccessibleControlEvent event = new AccessibleControlEvent(this);
@@ -1352,6 +1359,7 @@ public id internal_accessibilityFocusedUIElement(int childID) {
13521359
* </p>
13531360
*
13541361
* @noreference This method is not intended to be referenced by clients.
1362+
* @nooverride This method is not intended to be re-implemented or extended by clients.
13551363
*/
13561364
public id internal_accessibilityHitTest(NSPoint point, int childID) {
13571365
AccessibleControlEvent event = new AccessibleControlEvent(this);
@@ -1422,6 +1430,7 @@ public boolean internal_accessibilityIsIgnored(int childID) {
14221430
* </p>
14231431
*
14241432
* @noreference This method is not intended to be referenced by clients.
1433+
* @nooverride This method is not intended to be re-implemented or extended by clients.
14251434
*/
14261435
public NSArray internal_accessibilityParameterizedAttributeNames(int childID) {
14271436
AccessibleControlEvent event = new AccessibleControlEvent(this);
@@ -1483,6 +1492,7 @@ public NSArray internal_accessibilityParameterizedAttributeNames(int childID) {
14831492
* </p>
14841493
*
14851494
* @noreference This method is not intended to be referenced by clients.
1495+
* @nooverride This method is not intended to be re-implemented or extended by clients.
14861496
*/
14871497
public boolean internal_accessibilityPerformAction(NSString action, int childID) {
14881498
String actionName = action.getString();
@@ -1528,6 +1538,7 @@ public boolean internal_accessibilityPerformAction(NSString action, int childID)
15281538
* </p>
15291539
*
15301540
* @noreference This method is not intended to be referenced by clients.
1541+
* @nooverride This method is not intended to be re-implemented or extended by clients.
15311542
*/
15321543
public void internal_accessibilitySetValue_forAttribute(id value, NSString attribute, int childId) {
15331544
if (attribute.isEqualToString(OS.NSAccessibilitySelectedTextRangeAttribute)) setSelectedTextRangeAttribute(value, childId);

bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/graphics/GCData.java

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,19 +51,30 @@ public final class GCData {
5151
public int fillRule = SWT.FILL_EVEN_ODD;
5252
public Image image;
5353

54+
/** @noreference This field is not intended to be referenced by clients. */
5455
public NSTextStorage textStorage;
56+
/** @noreference This field is not intended to be referenced by clients. */
5557
public NSLayoutManager layoutManager;
58+
/** @noreference This field is not intended to be referenced by clients. */
5659
public NSTextContainer textContainer;
60+
/** @noreference This field is not intended to be referenced by clients. */
5761
public NSColor fg, bg;
5862
public double drawXOffset, drawYOffset;
63+
/** @noreference This field is not intended to be referenced by clients. */
5964
public NSRect paintRect;
65+
/** @noreference This field is not intended to be referenced by clients. */
6066
public NSBezierPath path;
67+
/** @noreference This field is not intended to be referenced by clients. */
6168
public NSAffineTransform transform, inverseTransform;
69+
/** @noreference This field is not intended to be referenced by clients. */
6270
public NSBezierPath clipPath, visiblePath;
6371
public long visibleRgn;
72+
/** @noreference This field is not intended to be referenced by clients. */
6473
public NSView view;
74+
/** @noreference This field is not intended to be referenced by clients. */
6575
public NSSize size;
6676
public Thread thread;
77+
/** @noreference This field is not intended to be referenced by clients. */
6778
public NSGraphicsContext flippedContext;
6879
public boolean restoreContext;
6980
}

0 commit comments

Comments
 (0)