io.qt.QtByteEnumerator Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of qtjambi-jre8 Show documentation
There is a newer version: 6.3.0
/****************************************************************************
**
** Copyright (C) 2009-2021 Dr. Peter Droste, Omix Visualization GmbH & Co. KG. All rights reserved.
**
** This file is part of Qt Jambi.
**
** ** $BEGIN_LICENSE$
** GNU Lesser General Public License Usage
** This file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
** 
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3.0 as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU General Public License version 3.0 requirements will be
** met: http://www.gnu.org/copyleft/gpl.html.
** $END_LICENSE$

**
** This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
** WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
**
****************************************************************************/
package io.qt;

import java.util.Comparator;

/**
 * The QtEnumerator interface servers as a base for all qint8 enum classes.
 * Its sole purpose is to unify the access to the integer
 * value of enumerators and flags using the value() method.
 *
 * If you manually implement this class, your implementation must contain a method
 * with the following signature:
 *
 *      public static T resolve(byte value);
 *
 * where T is your subclass. This should return the enum value corresponding to the
 * specified int value.
 */
public interface QtByteEnumerator extends QtAbstractEnumerator {
    /**
     * This function should return a byte value for the enum
     * values of the enumeration that implements this interface.
     */
	@NativeAccess
    public default byte value() {
		return (byte)ordinal();
	}
	
	/**
	 * @see Enum#ordinal()
	 * @return the ordinal of this enumeration constant
	 */
	public int ordinal();
	
	/**
	 * @see Enum#name()
	 * @return the name of this enum constant
	 */
	public String name();
	
	/**
	 * @see Enum#getDeclaringClass()
	 * @return the Class object corresponding to this enum constant's enum type
	 */
	public Class getDeclaringClass();
	
	/**
	 * Creates a comparator for enumeration values
	 * @param 
	 * @return comparator
	 */
	public static  Comparator comparator() {
		return (E e1, E e2)->{
			return Byte.compare(e1.value(), e2.value());
		};
	}
}