de.frag.umlplugin.uml
Class CompartmentVisibility

java.lang.Object
  extended by de.frag.umlplugin.uml.CompartmentVisibility

public class CompartmentVisibility
extends java.lang.Object

Stores compartment visibility information for a single UML diagram.


Field Summary
static java.lang.String COMPARTMENT_VISIBILITY
           
 
Constructor Summary
CompartmentVisibility()
          Creates new compartment visibility.
CompartmentVisibility(org.jdom.Element visibilityElement)
          Creates new compartment visibility.
 
Method Summary
 org.jdom.Element createElement()
          Creates JDOM element that contains a serialized description of this compartment visibility object.
 boolean isFieldsVisible(java.lang.String qualifiedClassName)
          Checks whether fields are visible for given class.
 boolean isMethodsVisible(java.lang.String qualifiedClassName)
          Checks whether methods are visible for given class.
 void renameClasses(ClassRenamer renamer)
          Rename all classes in all compartment visibility sets to keep class names in sync after refactorings were applied.
 void setFieldsVisible(java.lang.String qualifiedClassName, boolean visible)
          Sets field compartment visibilty for given class.
 void setMethodsVisible(java.lang.String qualifiedClassName, boolean visible)
          Sets method compartment visibilty for given class.
 void toggleFieldsAndMethodsVisible(java.lang.String qualifiedClassName)
          Toggles visibility of fields and methods.
 void toggleFieldsVisible(java.lang.String qualifiedClassName)
          Toggles visibility of fields.
 void toggleMethodsVisible(java.lang.String qualifiedClassName)
          Toggles visibility of methods.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

COMPARTMENT_VISIBILITY

public static final java.lang.String COMPARTMENT_VISIBILITY
See Also:
Constant Field Values
Constructor Detail

CompartmentVisibility

public CompartmentVisibility()
Creates new compartment visibility. Initially all field- and method-compartments will be invisible.


CompartmentVisibility

public CompartmentVisibility(@NotNull
                             org.jdom.Element visibilityElement)
Creates new compartment visibility. Visibility information will be deserialized from given JDOM element.

Parameters:
visibilityElement - JDOM element with serialized visibility information
Method Detail

setFieldsVisible

public void setFieldsVisible(@Nullable
                             java.lang.String qualifiedClassName,
                             boolean visible)
Sets field compartment visibilty for given class.

Parameters:
qualifiedClassName - qualified name of class
visible - true, if fields should be visible; false otherwise

setMethodsVisible

public void setMethodsVisible(@Nullable
                              java.lang.String qualifiedClassName,
                              boolean visible)
Sets method compartment visibilty for given class.

Parameters:
qualifiedClassName - qualified name of class
visible - true, if methods should be visible; false otherwise

isFieldsVisible

public boolean isFieldsVisible(@Nullable
                               java.lang.String qualifiedClassName)
Checks whether fields are visible for given class.

Parameters:
qualifiedClassName - qualified name of class
Returns:
true, if fields are visible; false otherwise

isMethodsVisible

public boolean isMethodsVisible(@Nullable
                                java.lang.String qualifiedClassName)
Checks whether methods are visible for given class.

Parameters:
qualifiedClassName - qualified name of class
Returns:
true, if methods are visible; false otherwise

toggleFieldsVisible

public void toggleFieldsVisible(@Nullable
                                java.lang.String qualifiedClassName)
Toggles visibility of fields.

Parameters:
qualifiedClassName - target class

toggleMethodsVisible

public void toggleMethodsVisible(@Nullable
                                 java.lang.String qualifiedClassName)
Toggles visibility of methods.

Parameters:
qualifiedClassName - target class

toggleFieldsAndMethodsVisible

public void toggleFieldsAndMethodsVisible(@Nullable
                                          java.lang.String qualifiedClassName)
Toggles visibility of fields and methods.

Parameters:
qualifiedClassName - target class

createElement

@NotNull
public org.jdom.Element createElement()
Creates JDOM element that contains a serialized description of this compartment visibility object.

Returns:
created JDOM element

renameClasses

public void renameClasses(@NotNull
                          ClassRenamer renamer)
Rename all classes in all compartment visibility sets to keep class names in sync after refactorings were applied.

Parameters:
renamer - renamer to use for renaming class names