Readded VolumeInformation

Restored VolumeInformation from commit 99bcbda (party reverting commit 3c343eb) to wrap the result of DokanyFileSystem#getVolumeInformation to aid in creating a wrapper ("EasyDokanFileSystem") for DokanyFileSystem

This commit is part of my effort to fix dokan-java's issue 32 (dokan-dev#32): Adding wrappers for high-level programming

src/main/java/dev/dokan/dokan_java/legacy/structure/VolumeInformation.java

@@ -0,0 +1,113 @@
+package dev.dokan.dokan_java.legacy.structure;
+
+import dev.dokan.dokan_java.DokanyOperations;
+import dev.dokan.dokan_java.constants.microsoft.FileSystemFlag;
+import dev.dokan.dokan_java.structure.EnumIntegerSet;
+
+/**
+ * Supplementary class to bundle information of the mounted volume and its filesystem.
+ * <p>Mainly used for {@link DokanyOperations#GetVolumeInformation} function to have all needed information at one place.</p>
+ * TODO: Maybe this can be completely integrated in the DokanyFileSystem class
+ */
+public final class VolumeInformation {
+	private final int maxComponentLength;
+	private final String name;
+	private final int serialNumber;
+	private final String fileSystemName;
+	private final EnumIntegerSet<FileSystemFlag> fileSystemFeatures;
+
+	public static final int DEFAULT_MAX_COMPONENT_LENGTH = 256;
+	public static final int DEFAULT_SERIAL_NUMBER = 305419896;
+	public static final String DEFAULT_VOLUME_NAME = "VOLUME1";
+	public static final String DEFAULT_FS_NAME = "DOKANY";
+	public static final EnumIntegerSet<FileSystemFlag> DEFAULT_FS_FEATURES = new EnumIntegerSet<>(FileSystemFlag.class);
+
+	static {
+		DEFAULT_FS_FEATURES.add(FileSystemFlag.CASE_PRESERVED_NAMES);
+	}
+
+	/**
+	 * Provides default values for maxComponentLength and fileSystemFeatures.
+	 *
+	 * @param volumeName
+	 * @param serialNumber
+	 * @param fileSystemName
+	 */
+	public VolumeInformation(final String volumeName, final int serialNumber, final String fileSystemName) {
+		this(DEFAULT_MAX_COMPONENT_LENGTH, volumeName, serialNumber, fileSystemName, DEFAULT_FS_FEATURES);
+	}
+
+	/**
+	 * Provides default values for all values.
+	 */
+	public VolumeInformation() {
+		this(DEFAULT_MAX_COMPONENT_LENGTH, DEFAULT_VOLUME_NAME, DEFAULT_SERIAL_NUMBER, DEFAULT_FS_NAME, DEFAULT_FS_FEATURES);
+	}
+
+	public int getMaxComponentLength() {
+		return this.maxComponentLength;
+	}
+
+	public String getName() {
+		return this.name;
+	}
+
+	public int getSerialNumber() {
+		return this.serialNumber;
+	}
+
+	public String getFileSystemName() {
+		return this.fileSystemName;
+	}
+
+	public EnumIntegerSet<FileSystemFlag> getFileSystemFeatures() {
+		return this.fileSystemFeatures;
+	}
+
+	@Override
+	public boolean equals(final Object o) {
+		if (o == this) return true;
+		if (!(o instanceof VolumeInformation)) return false;
+		final VolumeInformation other = (VolumeInformation) o;
+		if (this.getMaxComponentLength() != other.getMaxComponentLength()) return false;
+		final Object this$name = this.getName();
+		final Object other$name = other.getName();
+		if (this$name == null ? other$name != null : !this$name.equals(other$name)) return false;
+		if (this.getSerialNumber() != other.getSerialNumber()) return false;
+		final Object this$fileSystemName = this.getFileSystemName();
+		final Object other$fileSystemName = other.getFileSystemName();
+		if (this$fileSystemName == null ? other$fileSystemName != null : !this$fileSystemName.equals(other$fileSystemName)) return false;
+		final Object this$fileSystemFeatures = this.getFileSystemFeatures();
+		final Object other$fileSystemFeatures = other.getFileSystemFeatures();
+		if (this$fileSystemFeatures == null ? other$fileSystemFeatures != null : !this$fileSystemFeatures.equals(other$fileSystemFeatures)) return false;
+		return true;
+	}
+
+	@Override
+	public int hashCode() {
+		final int PRIME = 59;
+		int result = 1;
+		result = result * PRIME + this.getMaxComponentLength();
+		final Object $name = this.getName();
+		result = result * PRIME + ($name == null ? 43 : $name.hashCode());
+		result = result * PRIME + this.getSerialNumber();
+		final Object $fileSystemName = this.getFileSystemName();
+		result = result * PRIME + ($fileSystemName == null ? 43 : $fileSystemName.hashCode());
+		final Object $fileSystemFeatures = this.getFileSystemFeatures();
+		result = result * PRIME + ($fileSystemFeatures == null ? 43 : $fileSystemFeatures.hashCode());
+		return result;
+	}
+
+	@Override
+	public String toString() {
+		return "VolumeInformation(maxComponentLength=" + this.getMaxComponentLength() + ", name=" + this.getName() + ", serialNumber=" + this.getSerialNumber() + ", fileSystemName=" + this.getFileSystemName() + ", fileSystemFeatures=" + this.getFileSystemFeatures() + ")";
+	}
+
+	public VolumeInformation(final int maxComponentLength, final String name, final int serialNumber, final String fileSystemName, final EnumIntegerSet<FileSystemFlag> fileSystemFeatures) {
+		this.maxComponentLength = maxComponentLength;
+		this.name = name;
+		this.serialNumber = serialNumber;
+		this.fileSystemName = fileSystemName;
+		this.fileSystemFeatures = fileSystemFeatures;
+	}
+}