Enum Class PollableReturn

java.lang.Object
java.lang.Enum<PollableReturn>
org.gnome.gio.PollableReturn
All Implemented Interfaces:
Serializable, Comparable<PollableReturn>, Constable, Enumeration
@Generated("org.javagi.JavaGI") public enum PollableReturn extends Enum<PollableReturn> implements Enumeration

Return value for various IO operations that signal errors via the return value and not necessarily via a GError.

This enum exists to be able to return errors to callers without having to allocate a GError. Allocating GErrors can be quite expensive for regularly happening errors like IOErrorEnum.WOULD_BLOCK.

In case of FAILED a GError should be set for the operation to give details about the error that happened.

Since:
2.60

  • Enum Constant Details

    • FAILED

      public static final PollableReturn FAILED
      Generic error condition for when an operation fails.

    • OK

      public static final PollableReturn OK
      The operation was successfully finished.

    • WOULD_BLOCK

      public static final PollableReturn WOULD_BLOCK
      The operation would block.

  • Method Details

    • values

      public static PollableReturn[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static PollableReturn valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • of

      public static PollableReturn of(int value)
      Create a new PollableReturn for the provided value
      Parameters:
      value - the enum value
      Returns:
      the enum for the provided value

    • getValue

      public int getValue()
      Get the numeric value of this enum
      Specified by:
      getValue in interface Enumeration
      Returns:
      the enum value

    • of

      public static PollableReturn of(MemorySegment address)
      Create a new PollableReturn for the value in the provided memory address.
      Parameters:
      address - the memory address holding a enum value
      Returns:
      the enum for the value in the provided memory address

    • getType

      public static @Nullable Type getType()
      Get the GType of the PollableReturn class.
      Returns:
      the GType