Enum Class IOFlags

java.lang.Object
java.lang.Enum<IOFlags>
org.gnome.glib.IOFlags
All Implemented Interfaces:
Serializable, Comparable<IOFlags>, Constable, Enumeration
@Generated("org.javagi.JavaGI") public enum IOFlags extends Enum<IOFlags> implements Enumeration
Specifies properties of a GIOChannel. Some of the flags can only be read with g_io_channel_get_flags(), but not changed with g_io_channel_set_flags().

  • Nested Class Summary

    Nested classes/interfaces inherited from class Enum

    Enum.EnumDesc<E>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    APPEND
    turns on append mode, corresponds to O_APPEND (see the documentation of the UNIX open() syscall)
    IS_READABLE
    indicates that the io channel is readable.
    IS_SEEKABLE
    indicates that the io channel is seekable, i.e.
    IS_WRITABLE
    indicates that the io channel is writable.
    MASK
    the mask that specifies all the valid flags.
    NONBLOCK
    turns on nonblocking mode, corresponds to O_NONBLOCK/O_NDELAY (see the documentation of the UNIX open() syscall)
    NONE
    no special flags set.
    SET_MASK
    the mask of the flags that the user can modify with g_io_channel_set_flags()

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final IOFlags
    GET_MASK
    the mask of the flags that are returned from g_io_channel_get_flags()
    static final IOFlags
    IS_WRITEABLE
    a misspelled version of GIOFLAGISWRITABLE that existed before the spelling was fixed in GLib 2.30.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    getValue()
    Get the numeric value of this enum
    static Set<IOFlags>
    of(int flags)
    Create a new EnumSet<IOFlags> for the provided bitfield
    static Set<IOFlags>
    of(MemorySegment address)
    Create a new EnumSet<IOFlags> for the bitfield in the provided memory address.
    static IOFlags
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static IOFlags[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • NONE

      public static final IOFlags NONE
      no special flags set. Since: 2.74

    • APPEND

      public static final IOFlags APPEND
      turns on append mode, corresponds to O_APPEND (see the documentation of the UNIX open() syscall)

    • NONBLOCK

      public static final IOFlags NONBLOCK
      turns on nonblocking mode, corresponds to O_NONBLOCK/O_NDELAY (see the documentation of the UNIX open() syscall)

    • IS_READABLE

      public static final IOFlags IS_READABLE
      indicates that the io channel is readable. This flag cannot be changed.

    • IS_WRITABLE

      public static final IOFlags IS_WRITABLE
      indicates that the io channel is writable. This flag cannot be changed.

    • IS_SEEKABLE

      public static final IOFlags IS_SEEKABLE
      indicates that the io channel is seekable, i.e. that g_io_channel_seek_position() can be used on it. This flag cannot be changed.

    • MASK

      public static final IOFlags MASK
      the mask that specifies all the valid flags.

    • SET_MASK

      public static final IOFlags SET_MASK
      the mask of the flags that the user can modify with g_io_channel_set_flags()

  • Field Details

    • IS_WRITEABLE

      public static final IOFlags IS_WRITEABLE
      a misspelled version of GIOFLAGISWRITABLE that existed before the spelling was fixed in GLib 2.30. It is kept here for compatibility reasons. Deprecated since 2.30

    • GET_MASK

      public static final IOFlags GET_MASK
      the mask of the flags that are returned from g_io_channel_get_flags()

  • Method Details

    • values

      public static IOFlags[] 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 IOFlags 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

    • getValue

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

    • of

      public static Set<IOFlags> of(int flags)
      Create a new EnumSet<IOFlags> for the provided bitfield
      Parameters:
      flags - the IOFlags bitfield
      Returns:
      the EnumSet for the provided bitfield

    • of

      public static Set<IOFlags> of(MemorySegment address)
      Create a new EnumSet<IOFlags> for the bitfield in the provided memory address.
      Parameters:
      address - the memory address holding a bitfield value
      Returns:
      the EnumSet for the bitfield in the provided memory address