org.gnome.glib.OptionFlags Maven / Gradle / Ivy

Go to download
// Java-GI - Java language bindings for GObject-Introspection-based libraries
// Copyright (C) 2022-2024 Jan-Willem Harmannij
//
// SPDX-License-Identifier: LGPL-2.1-or-later
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, see .
//
// This file has been generated with Java-GI.
// Do not edit this file directly!
// Visit  for more information.
//
package org.gnome.glib;

import io.github.jwharm.javagi.base.Bitfield;
import javax.annotation.processing.Generated;

/**
 * Flags which modify individual options.
 */
@Generated("io.github.jwharm.JavaGI")
public class OptionFlags extends Bitfield {
    /**
     * No flags. Since: 2.42.
     */
    public static final OptionFlags NONE = new OptionFlags(0);

    /**
     * The option doesn't appear in {@code --help} output.
     */
    public static final OptionFlags HIDDEN = new OptionFlags(1);

    /**
     * The option appears in the main section of the
     *     {@code --help} output, even if it is defined in a group.
     */
    public static final OptionFlags IN_MAIN = new OptionFlags(2);

    /**
     * For options of the {@link org.gnome.glib.OptionArg#NONE} kind, this
     *     flag indicates that the sense of the option is reversed. i.e. {@code false} will
     *     be stored into the argument rather than {@code true}.
     */
    public static final OptionFlags REVERSE = new OptionFlags(4);

    /**
     * For options of the {@link org.gnome.glib.OptionArg#CALLBACK} kind,
     *     this flag indicates that the callback does not take any argument
     *     (like a {@link org.gnome.glib.OptionArg#NONE} option). Since 2.8
     */
    public static final OptionFlags NO_ARG = new OptionFlags(8);

    /**
     * For options of the {@link org.gnome.glib.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
     */
    public static final OptionFlags FILENAME = new OptionFlags(16);

    /**
     * For options of the {@link org.gnome.glib.OptionArg#CALLBACK}
     *     kind, this flag indicates that the argument supply is optional.
     *     If no argument is given then data of {@code GOptionParseFunc} will be
     *     set to NULL. Since 2.8
     */
    public static final OptionFlags OPTIONAL_ARG = new OptionFlags(32);

    /**
     * This flag turns off the automatic conflict
     *     resolution which prefixes long option names with {@code 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.
     */
    public static final OptionFlags NOALIAS = new OptionFlags(64);

    static {
        GLib.javagi$ensureInitialized();
    }

    /**
     * Create a new OptionFlags with the provided value
     */
    public OptionFlags(int value) {
        super(value);
    }

    /**
     * Combine (bitwise OR) operation
     *
     * @param masks one or more values to combine with
     * @return the combined value by calculating {@code this | mask}
     */
    public OptionFlags or(OptionFlags... masks) {
        int value = this.getValue();
        for (OptionFlags arg : masks) {
            value |= arg.getValue();
        }
        return new OptionFlags(value);
    }

    /**
     * Combine (bitwise OR) operation
     *
     * @param mask the first value to combine
     * @param masks the other values to combine
     * @return the combined value by calculating {@code mask | masks[0] | masks[1] | ...}
     */
    public static OptionFlags combined(OptionFlags mask, OptionFlags... masks) {
        int value = mask.getValue();
        for (OptionFlags arg : masks) {
            value |= arg.getValue();
        }
        return new OptionFlags(value);
    }
}