com.sun.jna.platform.EnumUtils Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jna-platform Show documentation
Java Native Access Platform
There is a newer version: 5.15.0
/*
 * Copyright 2014 Martin Steiger
 *
 * The contents of this file is dual-licensed under 2
 * alternative Open Source/Free licenses: LGPL 2.1 or later and
 * Apache License 2.0. (starting with JNA version 4.0.0).
 *
 * You can freely decide which license you want to apply to
 * the project.
 *
 * You may obtain a copy of the LGPL License at:
 *
 * http://www.gnu.org/licenses/licenses.html
 *
 * A copy is also included in the downloadable source code package
 * containing JNA, in file "LGPL2.1".
 *
 * You may obtain a copy of the Apache License at:
 *
 * http://www.apache.org/licenses/
 *
 * A copy is also included in the downloadable source code package
 * containing JNA, in file "AL2.0".
 */

package com.sun.jna.platform;

import java.util.HashSet;
import java.util.Set;

import com.sun.jna.platform.win32.FlagEnum;

/**
 * Several helper methods to convert integer flag (sets)
 * into enum (sets)
 * @author Martin Steiger
 */
public class EnumUtils
{
    /**
     * Uninitialized integer flag
     */
    public static final int UNINITIALIZED = -1;

    /**
     * @param val the enum
     * @return the index of the enum in the enum list
     */
    public static > int toInteger(E val)
    {
        @SuppressWarnings("unchecked")
        E[] vals = (E[]) val.getClass().getEnumConstants();

        for (int idx = 0; idx < vals.length; idx++) {
            if (vals[idx] == val) {
                return idx;
            }
        }

        throw new IllegalArgumentException();
    }

    /**
     * @param idx the enum index
     * @param clazz the enum class
     * @return the enum at position idx
     */
    public static > E fromInteger(int idx, Class clazz)
    {
        if (idx == UNINITIALIZED)
            return null;

        E[] vals = clazz.getEnumConstants();
        return vals[idx];
    }

    /**
     * @param flags the ORed flags
     * @param clazz the enum class
     * @return the representing set
     */
    public static  Set setFromInteger(int flags, Class clazz)
    {
        T[] vals = clazz.getEnumConstants();
        Set result = new HashSet();

        for (T val : vals)
        {
            if ((flags & val.getFlag()) != 0)
            {
                result.add(val);
            }
        }

        return result;
    }

    /**
     * @param set the set to convert
     * @return the flags combined into an integer
     */
    public static  int setToInteger(Set set) {
        int sum = 0;

        for (T t : set)
        {
            sum |= t.getFlag();
        }

        return sum;
    }
}