com.ibm.xtools.common.ui.reduction

Class EditingCapabilities

java.lang.Object

com.ibm.xtools.common.ui.reduction.EditingCapabilities

public class EditingCapabilities
extends java.lang.Object

Contains enabled and required sets of editing capabilities.

Both enabled and required editing capability sets can only both be null, or not null. Neither will be null while the other is not.

The difference between a null set of editing capabilities and an empty set is that if the set is null, then UI reduction should not take place. However if the set is empty, then UI reduction should take place and all reduced capabilities should be off.

Constructor Summary

Constructors

Constructor and Description
EditingCapabilities(EditingCapabilities ec) Constructs a new EditingCapabilities instance from a other EditingCapabilities instance.
EditingCapabilities(java.util.Set<java.lang.String> enabled, java.util.Set<java.lang.String> required) Constructs a new EditingCapabilities instance with given enabled and required editing capabilities.

Method Summary

Modifier and Type	Method and Description
void	addAllEnabledEditingCapabilities(java.util.Set<java.lang.String> addition) Adds the given set of enabled editing capabilities.
void	addAllRequiredEditingCapabilities(java.util.Set<java.lang.String> addition) Adds the given set of required editing capabilities.
boolean	equals(java.lang.Object o)
java.util.Set<java.lang.String>	getEnabledEditingCapabilities() Returns the set of enabled editing capabilities.
java.util.Set<java.lang.String>	getRequiredEditingCapabilities() Returns the set of required editing capabilities.
int	hashCode()
void	retainAllEnabledEditingCapabilities(java.util.Set<java.lang.String> retain) Retains all the given set of enabled editing capabilities.
void	setEditingCapabilities(java.util.Set<java.lang.String> enabled, java.util.Set<java.lang.String> required) Sets the enabled and required editing capabilities.

Methods inherited from class java.lang.Object

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

Constructor Detail

EditingCapabilities

public EditingCapabilities(EditingCapabilities ec)

Constructs a new EditingCapabilities instance from a other EditingCapabilities instance.

Parameters:

ec - the EditingCapabilities to copy

EditingCapabilities

public EditingCapabilities(java.util.Set<java.lang.String> enabled,
                           java.util.Set<java.lang.String> required)

Constructs a new EditingCapabilities instance with given enabled and required editing capabilities.

Parameters:

enabled -

required -

Method Detail

getEnabledEditingCapabilities

public java.util.Set<java.lang.String> getEnabledEditingCapabilities()

Returns the set of enabled editing capabilities.

Returns:

the set of enabled editing capabilities

getRequiredEditingCapabilities

public java.util.Set<java.lang.String> getRequiredEditingCapabilities()

Returns the set of required editing capabilities.

Returns:

the set of required editing capabilities

addAllEnabledEditingCapabilities

public void addAllEnabledEditingCapabilities(java.util.Set<java.lang.String> addition)

Adds the given set of enabled editing capabilities.

Parameters:

addition - the set of editing capabilities to add

retainAllEnabledEditingCapabilities

public void retainAllEnabledEditingCapabilities(java.util.Set<java.lang.String> retain)

Retains all the given set of enabled editing capabilities.

Parameters:

retain - the set of editing capabilities to retain

addAllRequiredEditingCapabilities

public void addAllRequiredEditingCapabilities(java.util.Set<java.lang.String> addition)

Adds the given set of required editing capabilities.

Parameters:

addition - the set of editing capabilities to add

setEditingCapabilities

public void setEditingCapabilities(java.util.Set<java.lang.String> enabled,
                                   java.util.Set<java.lang.String> required)

Sets the enabled and required editing capabilities.

Parameters:

enabled - the enabled editing capabilities

required - the required editing capabilities

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object