edu.ksu.cis.cadena.core.specification.module
Interface Module

All Superinterfaces:

CalmObject

public interface Module
extends CalmObject

A representation of the model object 'Module'.

The following features are supported:

• Name
• Style
• Components
• Interfaces
• Imports

See Also:

ModulePackage.getModule()

Method Summary

java.util.Collection<InterfaceType>	findInterfaces(java.util.List<InterfaceKind> interfaceKinds, boolean includeImports) Find all of the interfaces provided by this module.
EList	getComponents() Returns the value of the 'Components' containment reference list.
EList	getImports() Returns the value of the 'Imports' reference list.
EList	getInterfaces() Returns the value of the 'Interfaces' containment reference list.
java.lang.String	getName() Returns the value of the 'Name' attribute.
Style	getStyle() Returns the value of the 'Style' reference.
java.util.List<ComponentType>	getTypedComponents() Convenience method that casts the return value of getComponents() into a typed List.
java.util.List<Module>	getTypedImports() Convenience method that casts the return value of getImports() into a typed List.
java.util.List<InterfaceType>	getTypedInterfaces() Convenience method that casts the return value of getInterfaces() into a typed List.
void	setName(java.lang.String value) Sets the value of the 'Name' attribute.
void	setStyle(Style value) Sets the value of the 'Style' reference.

Methods inherited from interface edu.ksu.cis.cadena.core.specification.base.CalmObject

addBackReference, getBackReferences, getDeleted, getTrashCan, getUuid, removeBackReference

Method Detail

getName

java.lang.String getName()

Returns the value of the 'Name' attribute.

If the meaning of the 'Name' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Name' attribute.

See Also:

setName(String), ModulePackage.getModule_Name()

setName

void setName(java.lang.String value)

Sets the value of the 'Name' attribute.

Parameters:

value - the new value of the 'Name' attribute.

See Also:

getName()

getStyle

Style getStyle()

Returns the value of the 'Style' reference.

If the meaning of the 'Style' reference isn't clear, there really should be more of a description here...

Returns:

the value of the 'Style' reference.

See Also:

setStyle(Style), ModulePackage.getModule_Style()

setStyle

void setStyle(Style value)

Sets the value of the 'Style' reference.

Parameters:

value - the new value of the 'Style' reference.

See Also:

getStyle()

getComponents

EList getComponents()

Returns the value of the 'Components' containment reference list. The list contents are of type ComponentType.

If the meaning of the 'Components' containment reference list isn't clear, there really should be more of a description here...

Returns:

the value of the 'Components' containment reference list.

See Also:

ModulePackage.getModule_Components()

getInterfaces

EList getInterfaces()

Returns the value of the 'Interfaces' containment reference list. The list contents are of type InterfaceType.

If the meaning of the 'Interfaces' containment reference list isn't clear, there really should be more of a description here...

Returns:

the value of the 'Interfaces' containment reference list.

See Also:

ModulePackage.getModule_Interfaces()

getImports

EList getImports()

Returns the value of the 'Imports' reference list. The list contents are of type Module.

If the meaning of the 'Imports' reference list isn't clear, there really should be more of a description here...

Returns:

the value of the 'Imports' reference list.

See Also:

ModulePackage.getModule_Imports()

getTypedImports

java.util.List<Module> getTypedImports()

Convenience method that casts the return value of getImports() into a typed List.

Returns:

The typed list

See Also:

getImports()

getTypedInterfaces

java.util.List<InterfaceType> getTypedInterfaces()

Convenience method that casts the return value of getInterfaces() into a typed List.

Returns:

The typed list

See Also:

getInterfaces()

getTypedComponents

java.util.List<ComponentType> getTypedComponents()

Convenience method that casts the return value of getComponents() into a typed List.

Returns:

The typed list

See Also:

getComponents()

findInterfaces

java.util.Collection<InterfaceType> findInterfaces(java.util.List<InterfaceKind> interfaceKinds,
                                                   boolean includeImports)

Find all of the interfaces provided by this module.

Parameters:

interfaceKinds - The kinds of interfaces to filter by

includeImports - If true, interfaces from directly imported modules are included

Returns:

the found interfaces