classpathhelper.eclipse.ui.classloaderview
Class ClassPathElement

java.lang.Object
  extended byclasspathhelper.util.AbstractTree
      extended byclasspathhelper.eclipse.ui.classloaderview.ClassPathElement
All Implemented Interfaces:
IDecorable, ITree

public class ClassPathElement
extends AbstractTree
implements IDecorable

Visual Tree node representing a location on the classpath. It's children are typicallly ClassElement objects.

Since:
1.0
Author:
bharris

Field Summary
 
Fields inherited from interface classpathhelper.eclipse.ui.IDecorable
BLOCKED, BLOCKED_DIFF, IGNORED, UNREFERENCED, UNRESOLVED, WONTLOAD
 
Constructor Summary
ClassPathElement(Location theLocation, CGClassLoader theClassLoader)
           
 
Method Summary
 void determineInitialDecorations()
          Method called to load enough children to determine what decorations should be applied to this element.
 ITree[] getChildren()
          Getter for this nodes children.
 Image getIconName()
          The associated Icon.
 boolean hasChildren()
          Does this node have children.
 boolean hasUnresolved()
          Getter method indicating whether or not this location contains unresolved classes.
 boolean hasWontLoad()
          Will this not load or does this element contain elements that won't load.
 boolean isBlocked()
          Getter method indicating whether or not this location contains blocked classes.
 boolean isBlockedDiffVersion()
          Getter method indicating whether or not this location contains blocked classes (some blocked with different versions).
 boolean isIgnored()
          Getter for the ignored flag on the underlying location.
 boolean isUnreferenced()
          Is this element referred to by anyone?
protected  void setBlocked(boolean blocked)
          Setter method for the has blocked property.
protected  void setBlockedDiffVersion(boolean blocked)
          Setter method for the has blocked (with different versions) property.
protected  void setUnresolved(boolean unresolved)
          Setter for the flag indicating whether or not this location has classes with unresolved dependencies.
 boolean supportingDecorations()
          Method added to allow nodes to indicate whether or not they are supporting decorations.
 java.lang.String toString()
           
 
Methods inherited from class classpathhelper.util.AbstractTree
addChild, addChildren, getParent, getRoot, removeAllChildren, removeChild, setParent
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ClassPathElement

public ClassPathElement(Location theLocation,
                        CGClassLoader theClassLoader)
Parameters:
theLocation - The location corresponding to this visual tree node.
Since:
1.0
Method Detail

determineInitialDecorations

public void determineInitialDecorations()
Method called to load enough children to determine what decorations should be applied to this element.

Since:
1.0

isIgnored

public boolean isIgnored()
Getter for the ignored flag on the underlying location.

Specified by:
isIgnored in interface IDecorable
Returns:
true If this location is ignored on the classpath, otherwise false.
Since:
1.0

isBlocked

public boolean isBlocked()
Getter method indicating whether or not this location contains blocked classes.

Specified by:
isBlocked in interface IDecorable
Returns:
true If this location contains blocked classes, otherwise false
Since:
1.0

setBlocked

protected void setBlocked(boolean blocked)
Setter method for the has blocked property.

Parameters:
blocked - The blocked flag.
Since:
1.0

isBlockedDiffVersion

public boolean isBlockedDiffVersion()
Getter method indicating whether or not this location contains blocked classes (some blocked with different versions).

Specified by:
isBlockedDiffVersion in interface IDecorable
Returns:
true If this location contains blocked classes (with different locations), otherwise false
Since:
1.0

setBlockedDiffVersion

protected void setBlockedDiffVersion(boolean blocked)
Setter method for the has blocked (with different versions) property.

Parameters:
blocked - The blocked flag.
Since:
1.0

hasUnresolved

public boolean hasUnresolved()
Getter method indicating whether or not this location contains unresolved classes.

Specified by:
hasUnresolved in interface IDecorable
Returns:
true if this location contains unresolved classes, otherwise false
Since:
1.0

setUnresolved

protected void setUnresolved(boolean unresolved)
Setter for the flag indicating whether or not this location has classes with unresolved dependencies.

Parameters:
unresolved - The unresolved flag.
Since:
1.0

isUnreferenced

public boolean isUnreferenced()
Description copied from interface: IDecorable
Is this element referred to by anyone?

Specified by:
isUnreferenced in interface IDecorable
Returns:
true if this element has no references to it (other than possibly itself), otherwise false.

supportingDecorations

public boolean supportingDecorations()
Description copied from interface: IDecorable

Method added to allow nodes to indicate whether or not they are supporting decorations. Some node types are used in multiple places and in some contexts don't require decorations. In other cases a node might indicate that they do not support decorations while they are still calculating their details.

Specified by:
supportingDecorations in interface IDecorable
Returns:
true if this node is currently supporting decorations, otherwise false

hasWontLoad

public boolean hasWontLoad()
Description copied from interface: IDecorable
Will this not load or does this element contain elements that won't load. Elements typically won't load if something they depend on won't load.

Specified by:
hasWontLoad in interface IDecorable
Returns:
true if this node has elements that won't load (possibly itself), otherwise false

getIconName

public Image getIconName()
Description copied from interface: ITree
The associated Icon.

Specified by:
getIconName in interface ITree
Returns:
The Icon for this node.

hasChildren

public boolean hasChildren()
Description copied from interface: ITree
Does this node have children.

Specified by:
hasChildren in interface ITree
Overrides:
hasChildren in class AbstractTree

getChildren

public ITree[] getChildren()
Description copied from interface: ITree
Getter for this nodes children.

Specified by:
getChildren in interface ITree
Overrides:
getChildren in class AbstractTree

toString

public java.lang.String toString()