org.vishia.util

Class SelectMask

java.lang.Object

org.vishia.util.SelectMask

All Implemented Interfaces:

MarkMask_ifc

Direct Known Subclasses:

FileMark

public class SelectMask
extends java.lang.Object
implements MarkMask_ifc

This is a standard implementation of the universal interface to mark instances as select-able and to support selection. It supports up to 32 sources or users for selection. The management of users should be defined at user level. A source is represented by a bit in the 32-bit-value of the mask. Usual only one source may existing. This class can be used either as super class for anything which should be marked as selected or as composition in that class whereby the data item selectMask is the only one data of that composition.

Field Summary

Fields

Modifier and Type	Field and Description
protected int	selectMask The mask with some mark bits.
static int	version Version, history and license.

Fields inherited from interface org.vishia.util.MarkMask_ifc

select, select2, select2Parent, selectParent

Constructor Summary

Constructors

Constructor and Description
SelectMask()

Method Summary

Modifier and Type	Method and Description
int	getMark() Returns the selection mask of this object.
int	setMarked(int mask, java.lang.Object data) Sets some bits of the mask.
int	setNonMarked(int mask, java.lang.Object data) Resets some bits of the mask.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

version

public static final int version

Version, history and license.

• 2013-04-28 Hartmut chg: new parameter data left empty here.
• 2011-11-28 Hartmut creation

Copyright/Copyleft: For this source the LGPL Lesser General Public License, published by the Free Software Foundation is valid. It means:

1. You can use this source without any restriction for any desired purpose.
2. You can redistribute copies of this source to everybody.
3. Every user of this source, also the user of redistribute copies with or without payment, must accept this license for further using.
4. But the LPGL is not appropriate for a whole software product, if this source is only a part of them. It means, the user must publish this part of source, but don't need to publish the whole source of the own product.
5. You can study and modify (improve) this source for own using or for redistribution, but you have to license the modified sources likewise under this LGPL Lesser General Public License. You mustn't delete this Copyright/Copyleft inscription in this source file.

If you are intent to use this sources without publishing its usage, you can get a second license subscribing a special contract with the author.

See Also:

Constant Field Values

selectMask

protected int selectMask

The mask with some mark bits. See getMark() See setMarked(int, Object)

Constructor Detail

SelectMask

public SelectMask()

Method Detail

getMark

public int getMark()

Description copied from interface: MarkMask_ifc

Returns the selection mask of this object. If the returned value is 0, the object is not selected. If it is not 0, any source (represented by each bit) has selected this source.

Specified by:

getMark in interface MarkMask_ifc

Returns:

bits of selection, 0 if it is not selected.

setNonMarked

public int setNonMarked(int mask,
                        java.lang.Object data)

Resets some bits of the mask.

Specified by:

setNonMarked in interface MarkMask_ifc

Parameters:

mask - This bits of the selectMask will be reseted.

data - not used here.

Returns:

The mark bits before this action is done.

setMarked

public int setMarked(int mask,
                     java.lang.Object data)

Sets some bits of the mask.

Specified by:

setMarked in interface MarkMask_ifc

Parameters:

mask - This bits of the selectMask will be reseted.

data - not used here.

Returns:

The mark bits before this action is done. If it is 0, this source is the only one which has marks the object.