Use Path to represent file-system paths for ImageData creation

Use java.nio.file.Path to model file-system paths instead of String to
represent file-system paths.

Add the new way to create ImageData as static factory instead of a
constructor, because a constructor is not really suitable to create a
copy of the first element of an array of ImageData.

Also inline the ImageDataLoader and use the new ImageData.load()
factories instead.

Author: HannesWell

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

@@ -15,6 +15,7 @@
 
 
 import java.io.*;
+import java.nio.file.Path;
 import java.util.*;
 import java.util.function.*;
 
@@ -130,9 +131,9 @@ public final class Image extends Resource implements Drawable {
 	static final int DEFAULT_SCANLINE_PAD = 4;
 
 	/**
-	 * ImageFileNameProvider to provide file names at various Zoom levels
+	 * ImageFileProvider to provide files at various Zoom levels
 	 */
-	private ImageFileNameProvider imageFileNameProvider;
+	private ImageFileProvider imageFileProvider;
 
 	/**
 	 * ImageDataProvider to provide ImageData at various Zoom levels
@@ -391,11 +392,11 @@ public Image(Device device, Image srcImage, int flag) {
 		/* Create the 100% representation for the new image from source image & apply flag */
 		createRepFromSourceAndApplyFlag(srcImage.getRepresentation (100), srcWidth, srcHeight, flag);
 
-		imageFileNameProvider = srcImage.imageFileNameProvider;
+		imageFileProvider = srcImage.imageFileProvider;
 		imageDataProvider = srcImage.imageDataProvider;
 		imageGcDrawer = srcImage.imageGcDrawer;
 		this.styleFlag = srcImage.styleFlag | flag;
-		if (imageFileNameProvider != null || imageDataProvider != null ||srcImage.imageGcDrawer != null) {
+		if (imageFileProvider != null || imageDataProvider != null ||srcImage.imageGcDrawer != null) {
 			/* If source image has 200% representation then create the 200% representation for the new image & apply flag */
 			NSBitmapImageRep rep200 = srcImage.getRepresentation (200);
 			if (rep200 != null) createRepFromSourceAndApplyFlag(rep200, srcWidth * 2, srcHeight * 2, flag);
@@ -653,18 +654,11 @@ public Image(Device device, ImageData source, ImageData mask) {
  * </p>
  * <pre>
  *     static Image loadImage (Display display, Class clazz, String string) {
- *          InputStream stream = clazz.getResourceAsStream (string);
- *          if (stream == null) return null;
- *          Image image = null;
- *          try {
- *               image = new Image (display, stream);
- *          } catch (SWTException ex) {
- *          } finally {
- *               try {
- *                    stream.close ();
- *               } catch (IOException ex) {}
- *          }
- *          return image;
+ *         try (InputStream stream = clazz.getResourceAsStream(string)){
+ *             if (stream == null) return null;
+*              return new Image (display, stream);
+ *         } catch (SWTException | IOException ex) {
+ *         }
  *     }
  * </pre>
  * <p>
@@ -695,7 +689,7 @@ public Image(Device device, InputStream stream) {
 	NSAutoreleasePool pool = null;
 	if (!NSThread.isMainThread()) pool = (NSAutoreleasePool) new NSAutoreleasePool().alloc().init();
 	try {
-		initWithSupplier(zoom -> ImageDataLoader.load(stream, FileFormat.DEFAULT_ZOOM, zoom));
+		initWithSupplier(zoom -> ImageData.load(stream, FileFormat.DEFAULT_ZOOM, zoom));
 		init();
 	} finally {
 		if (pool != null) pool.release();
@@ -740,8 +734,9 @@ public Image(Device device, String filename) {
 	if (!NSThread.isMainThread()) pool = (NSAutoreleasePool) new NSAutoreleasePool().alloc().init();
 	try {
 		if (filename == null) SWT.error(SWT.ERROR_NULL_ARGUMENT);
-		initNative(filename);
-		if (this.handle == null) initWithSupplier(zoom -> ImageDataLoader.load(filename, FileFormat.DEFAULT_ZOOM, zoom));
+		Path file = Path.of(filename);
+		initNative(file);
+		if (this.handle == null) initWithSupplier(zoom -> ImageData.load(file, FileFormat.DEFAULT_ZOOM, zoom));
 		init();
 	} finally {
 		if (pool != null) pool.release();
@@ -776,28 +771,63 @@ public Image(Device device, String filename) {
  *    <li>ERROR_NO_HANDLES if a handle could not be obtained for image creation</li>
  * </ul>
  * @since 3.104
+ * @deprecated Instead use {@link #Image(Device, ImageFileProvider)}
  */
+@Deprecated(since = "2025-06")
 public Image(Device device, ImageFileNameProvider imageFileNameProvider) {
+	this(device, DPIUtil.asImageFileProvider(imageFileNameProvider));
+}
+
+/**
+ * Constructs an instance of this class by loading its representation
+ * from the file retrieved from the {@link ImageFileProvider}. Throws an
+ * error if an error occurs while loading the image, or if the result
+ * is an image of an unsupported type.
+ * <p>
+ * This constructor is provided for convenience for loading image as
+ * per DPI level.
+ *
+ * @param device the device on which to create the image
+ * @param imageFileProvider the {@link ImageFileProvider} object that is
+ * to be used to get the file
+ *
+ * @exception IllegalArgumentException <ul>
+ *    <li>ERROR_NULL_ARGUMENT - if device is null and there is no current device</li>
+ *    <li>ERROR_NULL_ARGUMENT - if the ImageFileNameProvider is null</li>
+ *    <li>ERROR_INVALID_ARGUMENT - if the fileName provided by ImageFileNameProvider is null at 100% zoom</li>
+ * </ul>
+ * @exception SWTException <ul>
+ *    <li>ERROR_IO - if an IO error occurs while reading from the file</li>
+ *    <li>ERROR_INVALID_IMAGE - if the image file contains invalid data </li>
+ *    <li>ERROR_UNSUPPORTED_DEPTH - if the image file describes an image with an unsupported depth</li>
+ *    <li>ERROR_UNSUPPORTED_FORMAT - if the image file contains an unrecognized format</li>
+ * </ul>
+ * @exception SWTError <ul>
+ *    <li>ERROR_NO_HANDLES if a handle could not be obtained for image creation</li>
+ * </ul>
+ * @since 3.130
+ */
+public Image(Device device, ImageFileProvider imageFileProvider) {
 	super(device);
-	if (imageFileNameProvider == null) SWT.error(SWT.ERROR_NULL_ARGUMENT);
-	this.imageFileNameProvider = imageFileNameProvider;
-	String filename = imageFileNameProvider.getImagePath(100);
-	if (filename == null) SWT.error(SWT.ERROR_INVALID_ARGUMENT);
+	if (imageFileProvider == null) SWT.error(SWT.ERROR_NULL_ARGUMENT);
+	this.imageFileProvider = imageFileProvider;
+	Path file = imageFileProvider.getImagePath(100);
+	if (file == null) SWT.error(SWT.ERROR_INVALID_ARGUMENT);
 	NSAutoreleasePool pool = null;
 	if (!NSThread.isMainThread()) pool = (NSAutoreleasePool) new NSAutoreleasePool().alloc().init();
 	try {
-		initNative(filename);
-		if (this.handle == null) init(ImageDataLoader.load(filename, 100, 100).element());
+		initNative(file);
+		if (this.handle == null) init(ImageData.load(file, 100, 100).element());
 		init();
-		String filename2x = imageFileNameProvider.getImagePath(200);
-		if (filename2x != null) {
+		Path file2x = imageFileProvider.getImagePath(200);
+		if (file2x != null) {
 			alphaInfo_200 = new AlphaInfo();
-			id id = NSImageRep.imageRepWithContentsOfFile(NSString.stringWith(filename2x));
+			id id = NSImageRep.imageRepWithContentsOfFile(NSString.stringWith(file2x.toString()));
 			NSImageRep rep = new NSImageRep(id);
 			handle.addRepresentation(rep);
 		} else {
 			// Try to natively scale up the image (e.g. possible if it's an SVG)
-			ElementAtZoom<ImageData> imageData2x = ImageDataLoader.load(filename, 100, 200);
+			ElementAtZoom<ImageData> imageData2x = ImageData.load(file, 100, 200);
 			if (imageData2x.zoom() == 200) {
 				alphaInfo_200 = new AlphaInfo();
 				NSBitmapImageRep rep = createRepresentation (imageData2x.element(), alphaInfo_200);
@@ -878,7 +908,7 @@ public Image(Device device, ImageDataProvider imageDataProvider) {
  *    <li>ERROR_NULL_ARGUMENT - if device is null and there is no current device</li>
  *    <li>ERROR_NULL_ARGUMENT - if the ImageGcDrawer is null</li>
  * </ul>
- * @since 3.129
+ * @since 3.130
  */
 public Image(Device device, ImageGcDrawer imageGcDrawer, int width, int height) {
 	super(device);
@@ -921,7 +951,7 @@ private ImageData drawWithImageGcDrawer(ImageGcDrawer imageGcDrawer, int width,
 
 private AlphaInfo _getAlphaInfoAtCurrentZoom (NSBitmapImageRep rep) {
 	int deviceZoom = DPIUtil.getDeviceZoom();
-	if (deviceZoom != 100 && (imageFileNameProvider != null || imageDataProvider != null)) {
+	if (deviceZoom != 100 && (imageFileProvider != null || imageDataProvider != null)) {
 		if (alphaInfo_100.alphaData != null && alphaInfo_200 != null) {
 			if (alphaInfo_200.alphaData == null) initAlpha_200(rep);
 			return alphaInfo_200;
@@ -1195,8 +1225,8 @@ public boolean equals (Object object) {
 	if (device != image.device || alphaInfo_100.transparentPixel != image.alphaInfo_100.transparentPixel) return false;
 	if (imageDataProvider != null && image.imageDataProvider != null) {
 		return styleFlag == image.styleFlag && imageDataProvider.equals (image.imageDataProvider);
-	} else if (imageFileNameProvider != null && image.imageFileNameProvider != null) {
-		return styleFlag == image.styleFlag && imageFileNameProvider.equals (image.imageFileNameProvider);
+	} else if (imageFileProvider != null && image.imageFileProvider != null) {
+		return styleFlag == image.styleFlag && imageFileProvider.equals (image.imageFileProvider);
 	} else if (imageGcDrawer != null && image.imageGcDrawer != null) {
 		return styleFlag == image.styleFlag && imageGcDrawer.equals(image.imageGcDrawer) && width == image.width
 				&& height == image.height;
@@ -1434,8 +1464,8 @@ NSBitmapImageRep createImageRep(NSSize targetSize) {
 public int hashCode () {
 	if (imageDataProvider != null) {
 		return imageDataProvider.hashCode();
-	} else if (imageFileNameProvider != null) {
-		return imageFileNameProvider.hashCode();
+	} else if (imageFileProvider != null) {
+		return imageFileProvider.hashCode();
 	} else if (imageGcDrawer != null) {
 		return Objects.hash(imageGcDrawer, height, width);
 	} else {
@@ -1545,7 +1575,8 @@ void initAlpha_100(NSBitmapImageRep nativeRep) {
 
 }
 
-void initNative(String filename) {
+void initNative(Path file) {
+	String filename = file.toString();
 	NSAutoreleasePool pool = null;
 	NSImage nativeImage = null;
 

bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/graphics/ImageData.java

@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2000, 2016 IBM Corporation and others.
+ * Copyright (c) 2000, 2025 IBM Corporation and others.
  *
  * This program and the accompanying materials
  * are made available under the terms of the Eclipse Public License 2.0
@@ -15,9 +15,12 @@
 
 
 import java.io.*;
+import java.nio.file.Path;
+import java.util.*;
 
 import org.eclipse.swt.*;
 import org.eclipse.swt.internal.*;
+import org.eclipse.swt.internal.DPIUtil.*;
 
 /**
  * Instances of this class are device-independent descriptions
@@ -239,6 +242,97 @@ public final class ImageData implements Cloneable {
 		{ 0x000000, 0x800000, 0x200000, 0xa00000, 0x080000, 0x880000, 0x280000, 0xa80000 }
 	};
 
+	/**
+	 * Creates an {@code ImageData} loaded from the specified file. Throws an error
+	 * if an error occurs loading the image, or if the image has an unsupported
+	 * type.
+	 * <p>
+	 * This factory is provided for convenience when loading a single image only. If
+	 * the file contains multiple images, only the first one will be loaded. To load
+	 * multiple images, use {@link ImageLoader#load(Path)}.
+	 * </p>
+	 *
+	 * @param file the file to load the image from (must not be null)
+	 *
+	 * @exception IllegalArgumentException <ul>
+	 *    <li>ERROR_NULL_ARGUMENT - if the file name is null</li>
+	 * </ul>
+	 * @exception SWTException <ul>
+	 *    <li>ERROR_IO - if an IO error occurs while reading from the file</li>
+	 *    <li>ERROR_INVALID_IMAGE - if the image file contains invalid data</li>
+	 *    <li>ERROR_UNSUPPORTED_FORMAT - if the image file contains an unrecognized format</li>
+	 * </ul>
+	 * @since 3.130
+	 */
+	public static ImageData load(Path file) {
+		return first(new ImageLoader().load(file));
+	}
+
+	/**
+	 * Creates an <code>ImageData</code> loaded from the specified input stream.
+	 * Throws an error if an error occurs while loading the image, or if the image
+	 * has an unsupported type. Application code is still responsible for closing
+	 * the input stream.
+	 * <p>
+	 * This factory is provided for convenience when loading a single image only. If
+	 * the stream contains multiple images, only the first one will be loaded. To
+	 * load multiple images, use {@link ImageLoader#load(InputStream)}.
+	 * </p>
+	 * <p>
+	 * This factory may be used to load a resource as follows:
+	 * </p>
+	 *
+	 * <pre>
+	 * static ImageData loadImageData(Class clazz, String string) {
+	 *     try (InputStream stream = clazz.getResourceAsStream(string)) {
+	 *         if (stream == null) return null;
+	 *         return ImageData.load(stream);
+	 *     } catch (SWTException | IOException ex) {
+	 *         // handle exception appropriately
+	 *     }
+	 * }
+	 * </pre>
+	 *
+	 * @param stream the input stream to load the image from (must not be null)
+	 *
+	 * @exception IllegalArgumentException <ul>
+	 *    <li>ERROR_NULL_ARGUMENT - if the stream is null</li>
+	 * </ul>
+	 * @exception SWTException <ul>
+	 *    <li>ERROR_IO - if an IO error occurs while reading from the stream</li>
+	 *    <li>ERROR_INVALID_IMAGE - if the image stream contains invalid data</li>
+	 *    <li>ERROR_UNSUPPORTED_FORMAT - if the image stream contains an unrecognized format</li>
+	 * </ul>
+	 *
+	 * @see ImageLoader#load(InputStream)
+	 * @since 3.130
+	 */
+	public static ImageData load(InputStream stream) {
+		return first(new ImageLoader().load(stream));
+	}
+
+	private static <T> T first(T[] data) {
+		if (data.length < 1) {
+			SWT.error(SWT.ERROR_INVALID_IMAGE);
+		}
+		return data[0];
+	}
+
+	static ElementAtZoom<ImageData> load(InputStream stream, int fileZoom, int targetZoom) {
+		return first(new ImageLoader().load(stream, fileZoom, targetZoom));
+	}
+
+	static ElementAtZoom<ImageData> load(Path file, int fileZoom, int targetZoom) {
+		return first(new ImageLoader().load(file, fileZoom, targetZoom));
+	}
+
+	private static <T> T first(List<T> data) {
+		if (data.isEmpty()) {
+			SWT.error(SWT.ERROR_INVALID_IMAGE);
+		}
+		return data.get(0);
+	}
+
 /**
  * Constructs a new, empty ImageData with the given width, height,
  * depth and palette. The data will be initialized to an (all zero)
@@ -296,24 +390,18 @@ scanlinePad, checkData(data), 0, null,
  * This constructor is provided for convenience when loading a single
  * image only. If the stream contains multiple images, only the first
  * one will be loaded. To load multiple images, use
- * <code>ImageLoader.load()</code>.
+ * {@link ImageLoader#load(InputStream)}.
  * </p><p>
  * This constructor may be used to load a resource as follows:
  * </p>
  * <pre>
  *     static ImageData loadImageData (Class clazz, String string) {
- *          InputStream stream = clazz.getResourceAsStream (string);
- *          if (stream == null) return null;
- *          ImageData imageData = null;
- *          try {
- *               imageData = new ImageData (stream);
- *          } catch (SWTException ex) {
- *          } finally {
- *               try {
- *                    stream.close ();
- *               } catch (IOException ex) {}
+ *          try (InputStream stream = clazz.getResourceAsStream (string)) {
+ *              if (stream == null) return null;
+ *              return ImageData.load(stream);
+ *          } catch (SWTException |IOException ex) {
+ *              // handle exception appropriately
  *          }
- *          return imageData;
  *     }
  * </pre>
  *
@@ -329,9 +417,11 @@ scanlinePad, checkData(data), 0, null,
  * </ul>
  *
  * @see ImageLoader#load(InputStream)
+ * @deprecated Instead use {@link #load(InputStream)}
  */
+@Deprecated(since = "2025-06")
 public ImageData(InputStream stream) {
-	ImageData i = ImageDataLoader.load(stream);
+	ImageData i = load(stream);
 	setAllFields(
 		i.width,
 		i.height,
@@ -360,7 +450,7 @@ public ImageData(InputStream stream) {
  * This constructor is provided for convenience when loading a single
  * image only. If the file contains multiple images, only the first
  * one will be loaded. To load multiple images, use
- * <code>ImageLoader.load()</code>.
+ * {@link ImageLoader#load(String)}.
  * </p>
  *
  * @param filename the name of the file to load the image from (must not be null)
@@ -373,9 +463,12 @@ public ImageData(InputStream stream) {
  *    <li>ERROR_INVALID_IMAGE - if the image file contains invalid data</li>
  *    <li>ERROR_UNSUPPORTED_FORMAT - if the image file contains an unrecognized format</li>
  * </ul>
+ * @deprecated Instead use {@link #load(Path)}
  */
+@Deprecated(since = "2025-06")
 public ImageData(String filename) {
-	ImageData i = ImageDataLoader.load(filename);
+	if (filename == null) SWT.error(SWT.ERROR_NULL_ARGUMENT);
+	ImageData i = load(Path.of(filename));
 	setAllFields(
 		i.width,
 		i.height,