io.qt.QFlags Maven / Gradle / Ivy
/****************************************************************************
**
** Copyright (C) 1992-2009 Nokia. All rights reserved.
**
** This file is part of Qt Jambi.
**
** ** $BEGIN_LICENSE$
** Commercial Usage
** Licensees holding valid Qt Commercial licenses may use this file in
** accordance with the Qt Commercial License Agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Nokia.
**
** GNU Lesser General Public License Usage
** Alternatively, 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.
**
** In addition, as a special exception, Nokia gives you certain
** additional rights. These rights are described in the Nokia Qt LGPL
** Exception version 1.0, included in the file LGPL_EXCEPTION.txt in this
** package.
**
** 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.
**
** If you are unsure which license is appropriate for your use, please
** contact the sales department at [email protected].
** $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.ArrayList;
import java.util.Arrays;
import io.qt.internal.QtJambiEnums;
/**
* This class manages a set of QtFlagEnumerator values. Each enum value
* is treated as a flag that is either set or unset. You can set and
* clear flags, and query which flags are set.
*/
@SuppressWarnings("serial")
public abstract class QFlags
implements java.io.Serializable,
Cloneable
{
/**
* Creates a new QFlags where the flags in args are set.
* @param args enum entries
*/
@SafeVarargs
protected QFlags(T ... args) {
set(args);
}
/**
* Creates a new QFlags with given value.
* @param value
*/
protected QFlags(int value) {
this.value = value;
}
/**
* Clones the flags
*/
@SuppressWarnings("unchecked")
public QFlags clone(){
try {
return (QFlags)super.clone();
} catch (CloneNotSupportedException e) {
return null;
}
}
/**
* Combines this flags with enum entry.
* @param flag enum entry
* @return new flag
*/
public QFlags combined(T flag){
QFlags result = clone();
result.set(flag);
return result;
}
/**
* Sets the flag flag
* @param other other entry
*/
public final void set(QFlags flag) {
value |= flag.value();
}
/**
* Sets the flag flag
* @param flag other entry
* @return this
*/
public QFlags setFlag(T flag) {
return setFlag(flag, true);
}
/**
* Sets or clears the flag flag
* @param flag other entry
* @param on set (true) or clear (false)
* @return this
*/
public QFlags setFlag(T flag, boolean on) {
if(on) {
if(flag instanceof QtFlagEnumerator) {
value |= ((QtFlagEnumerator)flag).value();
}else if(flag instanceof QtByteFlagEnumerator) {
value |= ((QtByteFlagEnumerator)flag).value();
}else if(flag instanceof QtShortFlagEnumerator) {
value |= ((QtShortFlagEnumerator)flag).value();
}else if(flag instanceof QtLongFlagEnumerator) {
value |= ((QtLongFlagEnumerator)flag).value();
}
}else {
if(flag instanceof QtFlagEnumerator) {
value &= ~((QtFlagEnumerator)flag).value();
}else if(flag instanceof QtByteFlagEnumerator) {
value &= ~((QtByteFlagEnumerator)flag).value();
}else if(flag instanceof QtShortFlagEnumerator) {
value &= ~((QtShortFlagEnumerator)flag).value();
}else if(flag instanceof QtLongFlagEnumerator) {
value &= ~((QtLongFlagEnumerator)flag).value();
}
}
return this;
}
/**
* Sets the flags in ts.
*/
@SafeVarargs
public final void set(T ... ts) {
for (T flag : ts) {
if(flag instanceof QtFlagEnumerator) {
value |= ((QtFlagEnumerator)flag).value();
}else if(flag instanceof QtByteFlagEnumerator) {
value |= ((QtByteFlagEnumerator)flag).value();
}else if(flag instanceof QtShortFlagEnumerator) {
value |= ((QtShortFlagEnumerator)flag).value();
}else if(flag instanceof QtLongFlagEnumerator) {
value |= ((QtLongFlagEnumerator)flag).value();
}
}
}
/**
* Tests if other flags are set.
* @param other other flags
* @return true if flag other is set
*/
public final boolean isSet(QFlags other) {
return testFlags(other);
}
/**
* Tests if other flags are set.
* @param flags other other flags
* @return true if flag other is set
*/
@SafeVarargs
public final boolean isSet(T ... flags) {
return testFlags(flags);
}
/**
* Tests if other flag is set.
* @param other other flag
* @return true if flag other is set
*/
public final boolean testFlag(T flag) {
if(flag instanceof QtFlagEnumerator) {
QtFlagEnumerator t = (QtFlagEnumerator)flag;
return (value & t.value()) == t.value();
}else if(flag instanceof QtByteFlagEnumerator) {
QtByteFlagEnumerator t = (QtByteFlagEnumerator)flag;
return (value & t.value()) == t.value();
}else if(flag instanceof QtShortFlagEnumerator) {
QtShortFlagEnumerator t = (QtShortFlagEnumerator)flag;
return (value & t.value()) == t.value();
}else if(flag instanceof QtLongFlagEnumerator) {
QtLongFlagEnumerator t = (QtLongFlagEnumerator)flag;
return (value & t.value()) == t.value();
}
return false;
}
/**
* Tests if given flags are set.
* @param flags other flags
* @return true if flags are set
*/
@SafeVarargs
public final boolean testFlags(T... flags) {
QFlags f = this.clone();
f.clearAll();
f.set(flags);
return (value & f.value()) == f.value();
}
/**
* Tests if given flags are set.
* @param flags other flags
* @return true if flags are set
*/
public final boolean testFlags(QFlags flags) {
return (value & flags.value()) == flags.value();
}
/**
* Tests if given flags are set.
* @param flags other flags
* @return true if flags are set
*/
public final boolean testAnyFlags(QFlags flags) {
return (value & flags.value()) != 0;
}
/**
* Tests if any of the given flags is set.
* @param flags other flags
* @return true if any of the given flags is set
*/
@SafeVarargs
public final boolean testAnyFlags(T... flags) {
QFlags f = this.clone();
f.clearAll();
f.set(flags);
return (value & f.value()) != 0;
}
/**
* Clears the flag other.
*/
public final void clear(QFlags other) {
value &= ~other.value();
}
/**
* Clears all flags in ts.
*
*/
@SafeVarargs
public final void clear(T ... ts) {
for (T flag : ts) {
if(flag instanceof QtFlagEnumerator) {
value &= ~((QtFlagEnumerator)flag).value();
}else if(flag instanceof QtByteFlagEnumerator) {
value &= ~((QtByteFlagEnumerator)flag).value();
}else if(flag instanceof QtShortFlagEnumerator) {
value &= ~((QtShortFlagEnumerator)flag).value();
}else if(flag instanceof QtLongFlagEnumerator) {
value &= ~((QtLongFlagEnumerator)flag).value();
}
}
}
/**
* Clears all flags.
*/
public final void clearAll() {
value = 0;
}
/**
* Sets the value of this QFlags.
* @param value new value
*/
@NativeAccess
public final void setValue(int value) {
this.value = value;
}
/**
* Returns the value of this QFlags.
* @return value
*/
public final int toInt() {
return value;
}
/**
* Returns the value of this QFlags.
* @return value
*/
@NativeAccess
public final int value() {
return value;
}
/**
* Returns an array of flag objects represented by this QFlags.
* @return array of enum entries
*/
public T[] flags() {
return flags(QtJambiEnums.flagConstants(this));
}
/**
* Returns an unmodifiable set of flag objects represented by this QFlags.
* @return array of enum entries
*/
protected final T[] flags(T[] possibleValues){
if(possibleValues==null || possibleValues.length==0)
return possibleValues;
java.util.List result = new ArrayList<>();
T zeroValue = null;
for (T possibleValue : possibleValues) {
boolean isNull = false;
if(possibleValue instanceof QtFlagEnumerator) {
isNull = 0==((QtFlagEnumerator)possibleValue).value();
}else if(possibleValue instanceof QtByteFlagEnumerator) {
isNull = 0==((QtByteFlagEnumerator)possibleValue).value();
}else if(possibleValue instanceof QtShortFlagEnumerator) {
isNull = 0==((QtShortFlagEnumerator)possibleValue).value();
}else if(possibleValue instanceof QtLongFlagEnumerator) {
isNull = 0==((QtLongFlagEnumerator)possibleValue).value();
}
if(isNull) {
zeroValue = possibleValue;
}else {
if(this.isSet(possibleValue)) {
result.add(possibleValue);
}
}
}
if(zeroValue!=null && result.isEmpty() && value==0) {
result.add(zeroValue);
}
return result.toArray(Arrays.copyOf(possibleValues, result.size()));
}
/**
* {@inheritDoc}
*/
@Override
public final boolean equals(Object object) {
return object != null
&& object.getClass() == getClass()
&& ((QFlags) object).value() == value();
}
/**
* {@inheritDoc}
*/
@Override
public final int hashCode() {
final int prime = 31;
int result = 1;
result = prime * result + getClass().hashCode();
result = prime * result + value();
return result;
}
/**
* {@inheritDoc}
*/
@Override
public final String toString() {
QtAbstractFlagEnumerator[] flags = flags();
String className = this.getClass().getName();
int idx = className.lastIndexOf('.');
if(idx>0) {
className = className.substring(idx+1);
}
StringBuilder result = new StringBuilder();
for(String part : className.split("\\$")) {
if(part.isEmpty()) {
result.append('$');
}else {
if(part.charAt(0)>='0' && part.charAt(0)<='9') {
result.append('$');
}else {
if(result.length()>0)
result.append('.');
}
result.append(part);
}
}
result.append('(');
if(flags.length==0 && value()!=0) {
String hexString = Integer.toHexString(value);
result.append("0x");
for (int i = hexString.length(); i < 8; ++i) {
result.append('0');
}
result.append(hexString);
}else {
int initialLength = result.length();
for(QtAbstractFlagEnumerator flag : flags) {
if(result.length()>initialLength) {
result.append('|');
}
result.append(flag.name());
}
}
result.append(')');
return result.toString();
}
private int value;
@io.qt.NativeAccess
static final class ConcreteWrapper extends QFlags{
@io.qt.NativeAccess
ConcreteWrapper(int value) {
super(value);
}
public QtFlagEnumerator[] flags(){
return new QtFlagEnumerator[]{
new QtFlagEnumerator(){
@Override public int value() { return ConcreteWrapper.this.value(); }
@Override public int ordinal() { return -1; }
@Override public String name() { return "unknown"; }
@Override public Class getDeclaringClass() { return this.getClass(); }
}
};
}
@Override
public ConcreteWrapper clone() {
return new ConcreteWrapper(value());
}
@Override
public ConcreteWrapper combined(QtFlagEnumerator flag) {
return new ConcreteWrapper(value() | flag.value());
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy