net.sf.mmm.client.ui.base.attribute

Class AbstractFlagAdvanced

java.lang.Object

net.sf.mmm.client.ui.base.attribute.AbstractFlagAdvanced

All Implemented Interfaces:

AttributeReadFlag, AttributeReadFlagAdvanced, AttributeWriteFlagAdvanced

Direct Known Subclasses:

AbstractUiWidgetNative.VisibleFlag

public abstract class AbstractFlagAdvanced
extends Object
implements AttributeWriteFlagAdvanced

This is the abstract base implementation of AttributeWriteFlagAdvanced.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
private Set<FlagModifier>	falseModifiersSet

Constructor Summary

Constructors

Modifier	Constructor and Description
	AbstractFlagAdvanced() The constructor.
protected	AbstractFlagAdvanced(Set<FlagModifier> falseModifiersSet) The constructor for a concurrent (thread-safe) implementation.

Method Summary

Modifier and Type	Method and Description
boolean	getFlag() This method reads the flag value.
boolean	getFlag(FlagModifier modifier) This method gets the value of the flag for the given FlagModifier.
void	setFlag(boolean flag, FlagModifier modifier) This method sets the flag for the given FlagModifier.

Methods inherited from class java.lang.Object

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

Field Detail

falseModifiersSet

private Set<FlagModifier> falseModifiersSet

See Also:

setFlag(boolean, FlagModifier)

Constructor Detail

AbstractFlagAdvanced

public AbstractFlagAdvanced()

The constructor.

AbstractFlagAdvanced

protected AbstractFlagAdvanced(Set<FlagModifier> falseModifiersSet)

The constructor for a concurrent (thread-safe) implementation. Typically clients have less requirements for concurrency and ideally use a single UI thread.

Parameters:

falseModifiersSet - is the underlying Set used to store the FlagModifier for which the flag has been set to false.

Method Detail

getFlag

public boolean getFlag()

This method reads the flag value. This is a generic attribute. The meaning of the flag needs to be defined by the JavaDoc of the accessor to get the flag instance.
NOTE:
This method determines if the flag is true for all FlagModifiers.

Specified by:

getFlag in interface AttributeReadFlag

Specified by:

getFlag in interface AttributeReadFlagAdvanced

Returns:

true if all aggregated flags are true and all parents have the same flag set to true.

getFlag

public boolean getFlag(FlagModifier modifier)

This method gets the value of the flag for the given FlagModifier.

Specified by:

getFlag in interface AttributeReadFlagAdvanced

Parameters:

modifier - is the FlagModifier. May be null for the default modifier.

Returns:

the flag for the given FlagModifier. Will be true if it has never been set for the given FlagModifier.

setFlag

public void setFlag(boolean flag,
                    FlagModifier modifier)

This method sets the flag for the given FlagModifier.

Specified by:

setFlag in interface AttributeWriteFlagAdvanced

Parameters:

flag - is the new value of flag.

modifier - is the FlagModifier. May be null for the default modifier.