oracle.ide.model
Class TechId

java.lang.Object
  oracle.ide.model.TechId

All Implemented Interfaces:

java.lang.Comparable

public final class TechId
extends java.lang.Object
implements java.lang.Comparable

The TechId class is a unique identifier for representing a technology in the system. Each instance wraps the display attributes for representing the technology in the user interface.

Method Summary

boolean	addDependency(TechId dependency) Ensures that this technology depends on another technology.
int	compareTo(java.lang.Object object) Compares two TechId instances for ordering.
static TechId	createTechId(java.lang.String key, java.lang.String name, java.lang.String description) Factory method for generating a new technology id.
static TechId	createTechId(java.lang.String key, java.lang.String name, java.lang.String description, boolean obsolete) Factory method for generating a new technology id.
boolean	dependsOn(TechId techId) Returns true if this technology depends on the specified technology, either directly or indirectly.
java.util.Set	getDependencies() Returns the collection of technologies upon which this technology directly depends; if this technology does not depend upon other technologies, the collection is empty.
java.lang.String	getDescription() Returns the display description for this technology.
java.lang.String	getKey() Returns the key for this technology.
java.lang.String	getName() Returns the display name for this technology.
boolean	isInScope(TechnologyScope scope) Returns true if this technology exists in the specified TechnologyScope.
boolean	isObsolete() Returns true if this technology is marked as obsolete, and should not be added to new projects (and should be migrated out of old projects)
boolean	isVisible() Returns true if this technology should be visible in the user interface, otherwise returns false.
boolean	removeDependency(TechId dependency) Removes a dependent technology from the this technology, if the dependency exists.
java.lang.String	toString() Returns a short description of the technology.

Methods inherited from class java.lang.Object

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

Method Detail

getName

public java.lang.String getName()

Returns the display name for this technology.

getDescription

public java.lang.String getDescription()

Returns the display description for this technology.

getKey

public java.lang.String getKey()

Returns the key for this technology.

addDependency

public boolean addDependency(TechId dependency)

Ensures that this technology depends on another technology. Returns true if the specified technology was a new dependency.

Returns:

true if the dependencies changed as a result of the call

removeDependency

public boolean removeDependency(TechId dependency)

Removes a dependent technology from the this technology, if the dependency exists. Returns true if this technology contained the specified dependency.

Returns:

true if the dependencies changed as a result of the call

getDependencies

public java.util.Set getDependencies()

Returns the collection of technologies upon which this technology directly depends; if this technology does not depend upon other technologies, the collection is empty.

Returns:

the group of TechIds upon which this technology is dependent

isVisible

public boolean isVisible()

Returns true if this technology should be visible in the user interface, otherwise returns false.

isObsolete

public boolean isObsolete()

Returns true if this technology is marked as obsolete, and should not be added to new projects (and should be migrated out of old projects)

isInScope

public boolean isInScope(TechnologyScope scope)

Returns true if this technology exists in the specified TechnologyScope. If this is a pseudo-technology, then the PseudoTechnologyCallback may be queried to determine if this technology is in the specified scope.

Parameters:

scope - the current technology scope.

dependsOn

public boolean dependsOn(TechId techId)

Returns true if this technology depends on the specified technology, either directly or indirectly.

Parameters:

techId - the technology

Returns:

true if this technology depends on the specified technology

compareTo

public int compareTo(java.lang.Object object)

Compares two TechId instances for ordering.

Specified by:

compareTo in interface java.lang.Comparable

Throws:

java.lang.ClassCastException - if the argument is not another TechId instance.

toString

public java.lang.String toString()

Returns a short description of the technology.

Overrides:

toString in class java.lang.Object

createTechId

public static TechId createTechId(java.lang.String key,
                                  java.lang.String name,
                                  java.lang.String description)

Factory method for generating a new technology id.

Parameters:

key - a well-defined string that identifies the technology programmatically

name - the translatable name for this technology, for display in the user interface.

description - the translatable description for this technology, for display in the user interface.

createTechId

public static TechId createTechId(java.lang.String key,
                                  java.lang.String name,
                                  java.lang.String description,
                                  boolean obsolete)

Factory method for generating a new technology id.

Parameters:

key - a well-defined string that identifies the technology programmatically

name - the translatable name for this technology, for display in the user interface.

description - the translatable description for this technology, for display in the user interface.