Enum Class OptionFlags

java.lang.Object
java.lang.Enum<OptionFlags>
org.gnome.glib.OptionFlags
All Implemented Interfaces:
Serializable, Comparable<OptionFlags>, Constable, Enumeration
@Generated("org.javagi.JavaGI") public enum OptionFlags extends Enum<OptionFlags> implements Enumeration
Flags which modify individual options.

  • Enum Constant Details

    • NONE

      public static final OptionFlags NONE
      No flags.
      Since:
      2.42

    • HIDDEN

      public static final OptionFlags HIDDEN
      The option doesn't appear in --help output.

    • IN_MAIN

      public static final OptionFlags IN_MAIN
      The option appears in the main section of the --help output, even if it is defined in a group.

    • REVERSE

      public static final OptionFlags REVERSE
      For options of the OptionArg.NONE kind, this flag indicates that the sense of the option is reversed. i.e. false will be stored into the argument rather than true.

    • NO_ARG

      public static final OptionFlags NO_ARG
      For options of the OptionArg.CALLBACK kind, this flag indicates that the callback does not take any argument (like a OptionArg.NONE option). Since 2.8

    • FILENAME

      public static final OptionFlags FILENAME
      For options of the OptionArg.CALLBACK kind, this flag indicates that the argument should be passed to the callback in the GLib filename encoding rather than UTF-8. Since 2.8

    • OPTIONAL_ARG

      public static final OptionFlags OPTIONAL_ARG
      For options of the OptionArg.CALLBACK kind, this flag indicates that the argument supply is optional. If no argument is given then data of GOptionParseFunc will be set to NULL. Since 2.8

    • NOALIAS

      public static final OptionFlags NOALIAS
      This flag turns off the automatic conflict resolution which prefixes long option names with groupname- if there is a conflict. This option should only be used in situations where aliasing is necessary to model some legacy commandline interface. It is not safe to use this option, unless all option groups are under your direct control. Since 2.8.

    • DEPRECATED

      public static final OptionFlags DEPRECATED

      This flag marks the option as deprecated in the --help.

      You should update the description of the option to describe what the user should do in response to the deprecation, for instance: remove the option, or replace it with another one.

      Since:
      2.84

  • Method Details

    • values

      public static OptionFlags[] 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 OptionFlags 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<OptionFlags> of(int flags)
      Create a new EnumSet<OptionFlags> for the provided bitfield
      Parameters:
      flags - the OptionFlags bitfield
      Returns:
      the EnumSet for the provided bitfield

    • of

      public static Set<OptionFlags> of(MemorySegment address)
      Create a new EnumSet<OptionFlags> 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