Enum Class MemoryUse

java.lang.Object
java.lang.Enum<MemoryUse>
org.gnome.soup.MemoryUse
All Implemented Interfaces:
Serializable, Comparable<MemoryUse>, Constable, Enumeration
@Generated("org.javagi.JavaGI") public enum MemoryUse extends Enum<MemoryUse> implements Enumeration
The lifetime of the memory being passed.

  • Nested Class Summary

    Nested classes/interfaces inherited from class Enum

    Enum.EnumDesc<E>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    COPY
    The passed-in data belongs to the caller and libsoup will copy it into new memory leaving the caller free to reuse the original memory.
    STATIC
    The memory is statically allocated and constant; libsoup can use the passed-in buffer directly and not need to worry about it being modified or freed.
    TAKE
    The caller has allocated the memory and libsoup will assume ownership of it and free it with GLib#free.

  • Method Summary

    Modifier and Type
    Method
    Description
    static @Nullable Type
    getType()
    Get the GType of the MemoryUse class.
    int
    getValue()
    Get the numeric value of this enum
    static MemoryUse
    of(int value)
    Create a new MemoryUse for the provided value
    static MemoryUse
    of(MemorySegment address)
    Create a new MemoryUse for the value in the provided memory address.
    static MemoryUse
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static MemoryUse[]
    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

    • STATIC

      public static final MemoryUse STATIC
      The memory is statically allocated and constant; libsoup can use the passed-in buffer directly and not need to worry about it being modified or freed.

    • TAKE

      public static final MemoryUse TAKE
      The caller has allocated the memory and libsoup will assume ownership of it and free it with GLib#free.

    • COPY

      public static final MemoryUse COPY
      The passed-in data belongs to the caller and libsoup will copy it into new memory leaving the caller free to reuse the original memory.

  • Method Details

    • values

      public static MemoryUse[] 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 MemoryUse 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 MemoryUse of(int value)
      Create a new MemoryUse 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 MemoryUse of(MemorySegment address)
      Create a new MemoryUse 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 MemoryUse class.
      Returns:
      the GType