Package com.nomagic.magicdraw.core.modules

Class ModuleUsage

java.lang.Object

com.nomagic.magicdraw.core.modules.ModuleUsage

@OpenApiAll
public class ModuleUsage
extends java.lang.Object

Information about module attachment on some owner. The same module can be attached on many owners, so this class is used for describing one of such usages

Field Summary

Fields

Modifier and Type	Field	Description
private IProject	mOwner
private IProject	mUsed

Constructor Summary

Constructors

Constructor	Description
ModuleUsage(IProject owner, IProject module)	Constructor

Method Summary

Modifier and Type	Method	Description
static java.util.List<ModuleUsage>	createUsages(IAttachedProject module, boolean allUsages)	Create usages information for a given module
static java.util.List<ModuleUsage>	createUsages(IProject owner, java.util.Collection<IProject> modules)	Create usages information of given modules from given owner.
static java.util.List<ModuleUsage>	createUsages(java.util.Collection<IAttachedProject> modules, boolean allUsages)	Create usages information for a given modules
static java.util.List<ModuleUsage>	createUsages(java.util.Collection<IAttachedProject> modules, java.util.Collection<? extends IProject> exceptTheseOwners)	Create all usages information for a given modules excepts if modules is used by given owners
boolean	equals(java.lang.Object o)
IProject	getOwner()
IProject	getUsed()
int	hashCode()
boolean	isValid()

Methods inherited from class java.lang.Object

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

Field Detail

mOwner

private final IProject mOwner

mUsed

private final IProject mUsed

Constructor Detail

ModuleUsage

public ModuleUsage(IProject owner,
                   IProject module)

Constructor

Parameters:

owner - module owner

module - attached module

Method Detail

getOwner

public IProject getOwner()

Returns:

attached module owner

getUsed

public IProject getUsed()

Returns:

attached module

isValid

public boolean isValid()

Returns:

true if usage is valid - owner actually has used project as attachment

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

createUsages

public static java.util.List<ModuleUsage> createUsages(IAttachedProject module,
                                                       boolean allUsages)

Create usages information for a given module

Parameters:

module - module

allUsages - create just one (first) usage information or create info about all usages

Returns:

usages

createUsages

public static java.util.List<ModuleUsage> createUsages(IProject owner,
                                                       java.util.Collection<IProject> modules)

Create usages information of given modules from given owner.

Parameters:

owner - modules owner

modules - attached modules to owner

Returns:

usages

createUsages

public static java.util.List<ModuleUsage> createUsages(java.util.Collection<IAttachedProject> modules,
                                                       boolean allUsages)

Create usages information for a given modules

Parameters:

modules - module

allUsages - create just one (first) usage information for every given module or create info about all usages

Returns:

usages

createUsages

public static java.util.List<ModuleUsage> createUsages(java.util.Collection<IAttachedProject> modules,
                                                       java.util.Collection<? extends IProject> exceptTheseOwners)

Create all usages information for a given modules excepts if modules is used by given owners

Parameters:

modules - modules

exceptTheseOwners - skip usages from these owners

Returns:

usages