Provide API for IFile Bulk read/write of all bytes/String/chars

Convenience methods like java.nio.file.Files.readAllBytes(Path) etc.

The new API could be used to substitute similar Util methods like
org.eclipse.jdt.internal.core.util.Util.getResourceContentsAsCharArray
(hotspot of jdt pasrsing)
Searching the workspace like
org.eclipse.search.internal.core.text.FileCharSequenceProvider.toShortString(IFile)
is similar but not directly replaceable with this API.

Note that clients currently do have to query file.getCharset() and
file.getContents() separately, possible opening the file twice to
identify the UTF-BOM while the new API combines both calls, which would
allow platform to open the file single time. While this PR does not
implements such optimizations it is already faster to use the JDKs bulk
methods instead of streaming.

Also this API avoids typical warnings of not closed Streams with the
former stream api in client code.

Author: EcljpseB0T

resources/bundles/org.eclipse.core.filesystem/META-INF/MANIFEST.MF

@@ -2,7 +2,7 @@ Manifest-Version: 1.0
 Bundle-ManifestVersion: 2
 Bundle-Name: %pluginName
 Bundle-SymbolicName: org.eclipse.core.filesystem; singleton:=true
-Bundle-Version: 1.10.400.qualifier
+Bundle-Version: 1.11.0.qualifier
 Bundle-Localization: plugin
 Require-Bundle: org.eclipse.equinox.common;bundle-version="[3.18.0,4.0.0)",
  org.eclipse.equinox.registry;bundle-version="[3.2.0,4.0.0)",

resources/bundles/org.eclipse.core.filesystem/src/org/eclipse/core/filesystem/IFileStore.java

@@ -15,12 +15,17 @@
 ******************************************************************************/
 package org.eclipse.core.filesystem;
 
+import java.io.IOException;
 import java.io.InputStream;
 import java.io.OutputStream;
 import java.net.URI;
 import org.eclipse.core.filesystem.provider.FileStore;
 import org.eclipse.core.internal.filesystem.FileStoreUtil;
-import org.eclipse.core.runtime.*;
+import org.eclipse.core.runtime.CoreException;
+import org.eclipse.core.runtime.IAdaptable;
+import org.eclipse.core.runtime.IPath;
+import org.eclipse.core.runtime.IProgressMonitor;
+import org.eclipse.core.runtime.Status;
 
 /**
  * A file store is responsible for storage and retrieval of a single file in some file system.
@@ -412,6 +417,29 @@ public interface IFileStore extends IAdaptable {
 	 */
 	public InputStream openInputStream(int options, IProgressMonitor monitor) throws CoreException;
 
+	/**
+	 * Returns the bytes contents of this file. This method is not intended for reading in
+	 * large files that do not fit in a byte array. Preferable over calling
+	 * {@code openInputStream(options, monitor).readAllBytes()}
+	 * @param options bit-wise or of option flag constants (currently only {@link EFS#NONE}
+	 * is applicable).
+	 * @param monitor a progress monitor, or <code>null</code> if progress
+	 *    reporting and cancellation are not desired
+	 * @return contents of this file as byte array.
+	 * @throws CoreException if this method fails.
+	 * @see #openInputStream(int, IProgressMonitor)
+	 * @since 1.11
+	 */
+	public default byte[] readAllBytes(int options, IProgressMonitor monitor) throws CoreException {
+		// Default implementation is meant to be overridden for local files
+		// as Files.readAllBytes is ~ 1.5 times faster
+		try (InputStream stream = openInputStream(options, monitor)) {
+			return stream.readAllBytes();
+		} catch (IOException e) {
+			throw new CoreException(Status.error("Error reading " + getName(), e)); //$NON-NLS-1$
+		}
+	}
+
 	/**
 	 * Returns an open output stream on the contents of this file. The number of
 	 * concurrently open streams depends on implementation and can be limited.
@@ -449,6 +477,31 @@ public interface IFileStore extends IAdaptable {
 	 */
 	public OutputStream openOutputStream(int options, IProgressMonitor monitor) throws CoreException;
 
+	/**
+	 * Writes the contents to this file.
+	 * <p>
+	 * The {@link EFS#APPEND} update flag controls where
+	 * output is written to the file. If this flag is specified, content written
+	 * to the stream will be appended to the end of the file. If this flag is
+	 * not specified, the contents of the existing file, if any, is truncated to zero
+	 * and the new output will be written from the start of the file.
+	 * </p>
+	 *
+	 * @param content contents given as byte array
+	 * @param options bit-wise or of option flag constants ({@link EFS#APPEND}).
+	 * @param monitor a progress monitor, or <code>null</code> if progress
+	 *    reporting and cancellation are not desired
+	 * @see #openOutputStream(int, IProgressMonitor)
+	 * @since 1.11
+	 * **/
+	public default void write(byte[] content, int options, IProgressMonitor monitor) throws CoreException {
+		try (OutputStream out = openOutputStream(options, monitor)) {
+			out.write(content);
+		} catch (IOException e) {
+			throw new CoreException(Status.error(e.getMessage(), e));
+		}
+	}
+
 	/**
 	 * Writes information about this file to the underlying file system. Only
 	 * certain parts of the file information structure can be written using this

resources/bundles/org.eclipse.core.filesystem/src/org/eclipse/core/internal/filesystem/local/LocalFile.java

@@ -31,6 +31,7 @@
 import java.nio.file.FileAlreadyExistsException;
 import java.nio.file.Files;
 import java.nio.file.NoSuchFileException;
+import java.nio.file.StandardOpenOption;
 import org.eclipse.core.filesystem.EFS;
 import org.eclipse.core.filesystem.IFileInfo;
 import org.eclipse.core.filesystem.IFileStore;
@@ -447,6 +448,7 @@ private boolean isSameFile(File source, File destination) throws IOException {
 		}
 	}
 
+	/** @see #readAllBytes(int, IProgressMonitor) */
 	@Override
 	public InputStream openInputStream(int options, IProgressMonitor monitor) throws CoreException {
 		try {
@@ -467,6 +469,28 @@ public InputStream openInputStream(int options, IProgressMonitor monitor) throws
 		}
 	}
 
+	/** @see #openInputStream(int, IProgressMonitor) */
+	@Override
+	public byte[] readAllBytes(int options, IProgressMonitor monitor) throws CoreException {
+		try {
+			return Files.readAllBytes(file.toPath());
+		} catch (IOException e) {
+			String message;
+			if (!file.exists()) {
+				message = NLS.bind(Messages.fileNotFound, filePath);
+				Policy.error(EFS.ERROR_NOT_EXISTS, message, e);
+			} else if (file.isDirectory()) {
+				message = NLS.bind(Messages.notAFile, filePath);
+				Policy.error(EFS.ERROR_WRONG_TYPE, message, e);
+			} else {
+				message = NLS.bind(Messages.couldNotRead, filePath);
+				Policy.error(EFS.ERROR_READ, message, e);
+			}
+			return null;
+		}
+	}
+
+	/** @see #write(byte[], int, IProgressMonitor) */
 	@Override
 	public OutputStream openOutputStream(int options, IProgressMonitor monitor) throws CoreException {
 		try {
@@ -486,6 +510,30 @@ public OutputStream openOutputStream(int options, IProgressMonitor monitor) thro
 		}
 	}
 
+	/** @see #openOutputStream(int, IProgressMonitor) */
+	@Override
+	public void write(byte[] content, int options, IProgressMonitor monitor) throws CoreException {
+		try {
+			boolean append = (options & EFS.APPEND) != 0;
+			if (append) {
+				Files.write(file.toPath(), content, StandardOpenOption.CREATE, StandardOpenOption.WRITE);
+			} else {
+				Files.write(file.toPath(), content); // default uses StandardOpenOption.TRUNCATE_EXISTING
+			}
+		} catch (IOException e) {
+			checkReadOnlyParent(file, e);
+			String message;
+			String path = filePath;
+			if (file.isDirectory()) {
+				message = NLS.bind(Messages.notAFile, path);
+				Policy.error(EFS.ERROR_WRONG_TYPE, message, e);
+			} else {
+				message = NLS.bind(Messages.couldNotWrite, path);
+				Policy.error(EFS.ERROR_WRITE, message, e);
+			}
+		}
+	}
+
 	@Override
 	public void putInfo(IFileInfo info, int options, IProgressMonitor monitor) throws CoreException {
 		boolean success = true;

resources/bundles/org.eclipse.core.resources/META-INF/MANIFEST.MF

@@ -2,7 +2,7 @@ Manifest-Version: 1.0
 Bundle-ManifestVersion: 2
 Bundle-Name: %pluginName
 Bundle-SymbolicName: org.eclipse.core.resources; singleton:=true
-Bundle-Version: 3.20.300.qualifier
+Bundle-Version: 3.21.0.qualifier
 Bundle-Activator: org.eclipse.core.resources.ResourcesPlugin
 Bundle-Vendor: %providerName
 Bundle-Localization: plugin