Package org.gnome.gio

Class UnixMountEntry

java.lang.Object

io.github.jwharm.javagi.base.ProxyInstance

org.gnome.gio.UnixMountEntry

All Implemented Interfaces:

Proxy

@Generated("io.github.jwharm.JavaGI")
public class UnixMountEntry
extends ProxyInstance

Defines a Unix mount entry (e.g. /media/cdrom). This corresponds roughly to a mtab entry.

Field Summary

Fields inherited from class io.github.jwharm.javagi.base.ProxyInstance

address

Constructor Summary

Constructors

Constructor	Description
UnixMountEntry(MemorySegment address)	Create a UnixMountEntry proxy instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
static UnixMountEntry	at(String mountPath, @Nullable Out<Long> timeRead)	Gets a GioUnix.MountEntry for a given mount path.
int	compare(UnixMountEntry mount2)	Compares two Unix mounts.
UnixMountEntry	copy()	Makes a copy of this UnixMountEntry.
static UnixMountEntry	for_(String filePath, @Nullable Out<Long> timeRead)	Gets a GioUnix.MountEntry for a given file path.
void	free()	Frees a Unix mount.
String	getDevicePath()	Gets the device path for a Unix mount.
String	getFsType()	Gets the filesystem type for the Unix mount.
String	getMountPath()	Gets the mount path for a Unix mount.
String	getOptions()	Gets a comma separated list of mount options for the Unix mount.
String	getRootPath()	Gets the root of the mount within the filesystem.
static Type	getType()	Get the GType of the UnixMountEntry class
boolean	guessCanEject()	Guesses whether a Unix mount entry can be ejected.
Icon	guessIcon()	Guesses the icon of a Unix mount entry.
String	guessName()	Guesses the name of a Unix mount entry.
boolean	guessShouldDisplay()	Guesses whether a Unix mount entry should be displayed in the UI.
Icon	guessSymbolicIcon()	Guesses the symbolic icon of a Unix mount entry.
boolean	isReadonly()	Checks if a Unix mount is mounted read only.
boolean	isSystemInternal()	Checks if a Unix mount is a system mount.

Methods inherited from class io.github.jwharm.javagi.base.ProxyInstance

equals, handle, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

UnixMountEntry

public UnixMountEntry(MemorySegment address)

Create a UnixMountEntry proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

Method Details

getType

public static Type getType()

Get the GType of the UnixMountEntry class

Returns:

the GType

at

public static UnixMountEntry at(String mountPath,
 @Nullable
 @Nullable Out<Long> timeRead)
                         throws UnsupportedPlatformException

Gets a GioUnix.MountEntry for a given mount path.

If timeRead is set, it will be filled with a Unix timestamp for checking if the mounts have changed since with GioUnix#mountEntriesChangedSince.

If more mounts have the same mount path, the last matching mount is returned.

This will return NULL if there is no mount point at mountPath.

Parameters:

mountPath - path for a possible Unix mount

timeRead - return location for a timestamp

Returns:

a GioUnix.MountEntry

Throws:

UnsupportedPlatformException - when run on a platform other than linux or macos

Since:

2.84

for_

public static UnixMountEntry for_(String filePath,
 @Nullable
 @Nullable Out<Long> timeRead)
                           throws UnsupportedPlatformException

Gets a GioUnix.MountEntry for a given file path.

If timeRead is set, it will be filled with a Unix timestamp for checking if the mounts have changed since with GioUnix#mountEntriesChangedSince.

If more mounts have the same mount path, the last matching mount is returned.

This will return NULL if looking up the mount entry fails, if filePath doesn’t exist or there is an I/O error.

Parameters:

filePath - file path on some Unix mount

timeRead - return location for a timestamp

Returns:

a GioUnix.MountEntry

Throws:

UnsupportedPlatformException - when run on a platform other than linux or macos

Since:

2.84

compare

public int compare(UnixMountEntry mount2)

Compares two Unix mounts.

Parameters:

mount2 - second GioUnix.MountEntry to compare

Returns:

1, 0 or -1 if this UnixMountEntry is greater than, equal to, or less than mount2, respectively

Since:

2.84

copy

public UnixMountEntry copy()

Makes a copy of this UnixMountEntry.

Returns:

a new GioUnix.MountEntry

Since:

2.84

free

public void free()

Frees a Unix mount.

Since:

2.84

getDevicePath

public String getDevicePath()

Gets the device path for a Unix mount.

Returns:

a string containing the device path

Since:

2.84

getFsType

public String getFsType()

Gets the filesystem type for the Unix mount.

Returns:

a string containing the file system type

Since:

2.84

getMountPath

public String getMountPath()

Gets the mount path for a Unix mount.

Returns:

the mount path for this UnixMountEntry

Since:

2.84

getOptions

public String getOptions()

Gets a comma separated list of mount options for the Unix mount.

For example: rw,relatime,seclabel,data=ordered.

This is similar to MountPoint#getOptions, but it takes a GioUnix.MountEntry as an argument.

Returns:

a string containing the options, or NULL if not available.

Since:

2.84

getRootPath

public String getRootPath()

Gets the root of the mount within the filesystem. This is useful e.g. for mounts created by bind operation, or btrfs subvolumes.

For example, the root path is equal to / for a mount created by mount /dev/sda1 /mnt/foo and /bar for mount --bind /mnt/foo/bar /mnt/bar.

Returns:

a string containing the root, or NULL if not supported

Since:

2.84

guessCanEject

public boolean guessCanEject()

Guesses whether a Unix mount entry can be ejected.

Returns:

true if this UnixMountEntry is deemed to be ejectable; false otherwise

Since:

2.84

guessIcon

public Icon guessIcon()

Guesses the icon of a Unix mount entry.

Returns:

a Icon

Since:

2.84

guessName

public String guessName()

Guesses the name of a Unix mount entry.

The result is a translated string.

Returns:

a newly allocated translated string

Since:

2.84

guessShouldDisplay

public boolean guessShouldDisplay()

Guesses whether a Unix mount entry should be displayed in the UI.

Returns:

true if this UnixMountEntry is deemed to be displayable; false otherwise

Since:

2.84

guessSymbolicIcon

public Icon guessSymbolicIcon()

Guesses the symbolic icon of a Unix mount entry.

Returns:

a Icon

Since:

2.84

isReadonly

public boolean isReadonly()

Checks if a Unix mount is mounted read only.

Returns:

true if this UnixMountEntry is read only; false otherwise

Since:

2.84

isSystemInternal

public boolean isSystemInternal()

Checks if a Unix mount is a system mount.

This is the Boolean OR of GioUnix#isSystemFsType, GioUnix#isSystemDevicePath and GioUnix#isMountPathSystemInternal on this UnixMountEntry’s properties.

The definition of what a ‘system’ mount entry is may change over time as new file system types and device paths are ignored.

Returns:

true if the Unix mount is for a system path; false otherwise

Since:

2.84