A C D E F G I L M N O S T V

A

accept(IExplorableElementVisitor) - Method in interface org.pfsw.odem.IExplorableElementVisiting

Implementation of the visitor pattern (GOF) for all derived interfaces if IExplorableElement.

acceptContainers(IContainersVisitor) - Method in interface org.pfsw.odem.IStructureVisiting

Implementation of the visitor pattern (GOF).

acceptNamespaces(INamespacesVisitor) - Method in interface org.pfsw.odem.INamespace

Implementation of the visitor pattern (GOF).

acceptNamespaces(INamespacesVisitor) - Method in interface org.pfsw.odem.IStructureVisiting

Implementation of the visitor pattern (GOF).

acceptTypes(ITypesVisitor) - Method in interface org.pfsw.odem.IExplorableElementVisiting

Implementation of the visitor pattern (GOF) for all derived interfaces if IExplorableElement.

add(IDependency<S, T>) - Method in class org.pfsw.odem.DependencySet

Add a new dependency.

C

collect(IDependencyFilter<IDependency<S, T>>) - Method in class org.pfsw.odem.DependencySet

Return a list of all dependencies that match the given filter.

collectForClassification(DependencyClassification) - Method in class org.pfsw.odem.DependencySet

Return a list of all dependencies with the given classification.

collectInto(Collection<IDependency<S, T>>, IDependencyFilter<IDependency<S, T>>) - Method in class org.pfsw.odem.DependencySet

Adds all dependencies that match the given filter to the provided collection.

ContainerClassification - Enum in org.pfsw.odem

Specifies the currently container types

copy() - Method in class org.pfsw.odem.DependencySet

Returns a copy of this dependency set that contains the identical dependency objects (i.e. no deep copy).

D

DependencyClassification - Enum in org.pfsw.odem

Specifies the currently supported types

DependencySet<S extends IExplorableElement,T extends IExplorableElement> - Class in org.pfsw.odem

A set of IDependency objects.

DependencySet() - Constructor for class org.pfsw.odem.DependencySet

Initialize the new instance with a default capcity of 50.

DependencySet(int) - Constructor for class org.pfsw.odem.DependencySet

Initialize the new instance with an initial capacity.

E

EMPTY_CONTAINER_ARRAY - Static variable in interface org.pfsw.odem.IContainer

An empty array of IContainer elements that can be used as return value in implementations whenever an empty array is needed.

EMPTY_NAMESPACE_ARRAY - Static variable in interface org.pfsw.odem.INamespace

An empty array of INamespace elements that can be used as return value in implementations whenever an empty array is needed.

EMPTY_TYPE_ARRAY - Static variable in interface org.pfsw.odem.IType

An empty array of IType elements that can be used as return value in implementations whenever an empty array is needed.

F

fromString(String) - Static method in enum org.pfsw.odem.ContainerClassification

Returns the enum value with the given name.

fromString(String) - Static method in enum org.pfsw.odem.DependencyClassification

Returns the enum value with the given name.

fromString(String) - Static method in enum org.pfsw.odem.TypeClassification

Returns the enum value with the given name.

fromString(String) - Static method in enum org.pfsw.odem.Visibility

Returns the enum value with the given name.

G

getClassification() - Method in interface org.pfsw.odem.IContainer

Returns the classification of this container.

getClassification() - Method in interface org.pfsw.odem.IType

Returns the classification (i.e.

getContainers() - Method in interface org.pfsw.odem.IExplorationContext

Returns all containers of this exploration context.

getContext() - Method in interface org.pfsw.odem.IExplorableElement

Returns the exploration context the element belongs to

getDependencies() - Method in interface org.pfsw.odem.IType

Returns all dependencies to other types.

getDependencyClassification() - Method in interface org.pfsw.odem.IDependency

Returns what kind of dependency it is

getDescription() - Method in interface org.pfsw.odem.IExplorationContext

Returns a text that describes the context.

getDirectReferredTypes() - Method in interface org.pfsw.odem.IType

Returns all types this type directly depends on.

getName() - Method in interface org.pfsw.odem.IExplorationModelObject

Returns the identifying name of the model object

getNamespace() - Method in interface org.pfsw.odem.IType

Returns the namespace the type belongs to.

getNamespaces() - Method in interface org.pfsw.odem.IContainer

Returns all namespaces in this container.

getParentContainer() - Method in interface org.pfsw.odem.IContainer

Returns the parent container of this container.

getProperty(String) - Method in interface org.pfsw.odem.IObjectProperties

Returns the property associated with the given name.

getProperty(String) - Method in class org.pfsw.odem.ObjectProperties

Returns the property associated with the given name.

getPropertyNames() - Method in interface org.pfsw.odem.IObjectProperties

Returns all currently known properties.

getPropertyNames() - Method in class org.pfsw.odem.ObjectProperties

Returns all currently known properties.

getSourceElement() - Method in interface org.pfsw.odem.IDependency

Returns the element that depends on the target element

getSubContainers() - Method in interface org.pfsw.odem.IContainer

Returns all sub containers of this container.

getTargetElement() - Method in interface org.pfsw.odem.IDependency

Returns the element the source element depends on

getTypes() - Method in interface org.pfsw.odem.INamespace

Returns all types in this namespace.

getUnqualifiedName() - Method in interface org.pfsw.odem.IType

Returns the name without the namespace

getVisibility() - Method in interface org.pfsw.odem.IType

Returns the visibility of this type.

I

IContainer - Interface in org.pfsw.odem

Represents a containers that hold types and namespaces.

IContainersVisitor - Interface in org.pfsw.odem

This interface defines one part of the "Visitor Pattern".

IDependency<S extends IExplorableElement,T extends IExplorableElement> - Interface in org.pfsw.odem

Represents a directed dependency between two IExplorableElements.

IDependencyFilter<D extends IDependency> - Interface in org.pfsw.odem

Simple filter for IDependency objects

IExplorableElement - Interface in org.pfsw.odem

Common interface for all model objects that can be used for dependency exploration.

IExplorableElementFilter<E extends IExplorableElement> - Interface in org.pfsw.odem

Simple filter for IExplorableElement objects

IExplorableElementVisiting - Interface in org.pfsw.odem

Specifies all methods that are necessary to fully provide the "Vistor Pattern" in conjunction with the IxxxVisitor interfaces defined here in the same package.

IExplorableElementVisitor - Interface in org.pfsw.odem

This is the callback interface an object must implement to be used within a transparent navigation over all explorable elements.

IExplorationContext - Interface in org.pfsw.odem

Exploration of dependencies always must happen in a particular context.

IExplorationModelObject - Interface in org.pfsw.odem

This is the base interface of all objects that comprise the exploration model.

INamespace - Interface in org.pfsw.odem

Represents a namespace an IType belongs to.

INamespacesVisitor - Interface in org.pfsw.odem

This interface defines one part of the "Visitor Pattern".

IObjectProperties - Interface in org.pfsw.odem

Each object that supports generic attributes must implement this interface.

isAbstract() - Method in interface org.pfsw.odem.IType

Returns whether or not this type is abstract.

isDerived() - Method in class org.pfsw.odem.TypeDependency

Returns true if the source type of this dependency either extends or implements the target type.

isDirectExtensionOf(IType) - Method in interface org.pfsw.odem.IType

Returns true if this type extends the given type directly.

isDirectImplementorOf(IType) - Method in interface org.pfsw.odem.IType

Returns true if this type directly implements the given type.

isExtension() - Method in class org.pfsw.odem.TypeDependency

Returns true if the source type of this dependency extends the target type.

isFinal() - Method in interface org.pfsw.odem.IType

Returns whether or not this type is final.

isImplementation() - Method in class org.pfsw.odem.TypeDependency

Returns true if the source type of this dependency implements the target (interface) type.

isParamTypeInMethod() - Method in class org.pfsw.odem.TypeDependency

Returns true if the target type of this dependency is the type of a method parameter in one of the source type's methods.

isReferencedInMethodSignature() - Method in class org.pfsw.odem.TypeDependency

Returns true if the target type of this dependency is used in one of the source type's methods.

isReturnTypeOfMethod() - Method in class org.pfsw.odem.TypeDependency

Returns true if the target type of this dependency is the type of a method parameter in one of the source type's methods.

IStructureVisiting - Interface in org.pfsw.odem

Specifies the methods a holder of exploration structures such as namespaces and containers must implement.

isTypeOfField() - Method in class org.pfsw.odem.TypeDependency

Returns true if the target type of this dependency is the type of a field (i.e. instance variable or static variable) in source type.

isTypeOfLocalVariable() - Method in class org.pfsw.odem.TypeDependency

Returns true if the target type of this dependency is the type of a local variable (i.e. a field declared locally inside a method) in source type.

IType - Interface in org.pfsw.odem

Represents a type such as a class, an interface, an enumeration and so on.

ITypesVisitor - Interface in org.pfsw.odem

This interface defines one part of the "Visitor Pattern".

L

lookupSourceElement(S) - Method in class org.pfsw.odem.DependencySet

Returns the first dependency with the source element equal to the given element.

lookupTargetElement(T) - Method in class org.pfsw.odem.DependencySet

Returns the first dependency with the a target element equal to the given element.

M

matches(D) - Method in interface org.pfsw.odem.IDependencyFilter

Returns true if the given dependency matches the filter, otherwise false.

matches(E) - Method in interface org.pfsw.odem.IExplorableElementFilter

Returns true if the given element matches the filter, otherwise false.

N

newList(int) - Method in class org.pfsw.odem.DependencySet

Returns a new list to hold dependency objects of the correct type.

O

ObjectProperties - Class in org.pfsw.odem

This is an implementation of IObjectProperties which is provided here as convenience, so that not everybody is forced create his own implementation.

ObjectProperties() - Constructor for class org.pfsw.odem.ObjectProperties

Initialize the new instance with default values.

org.pfsw.odem - package org.pfsw.odem

Object Dependency Exploration Model (ODEM)
This component provides an API for analyzing type dependencies.

S

setProperty(String, Object) - Method in interface org.pfsw.odem.IObjectProperties

Sets the value of the property with the specified name to the given object.

setProperty(String, Object) - Method in class org.pfsw.odem.ObjectProperties

Sets the value of the property with the specified name to the given object.

T

toString() - Method in enum org.pfsw.odem.ContainerClassification

toString() - Method in enum org.pfsw.odem.DependencyClassification

toString() - Method in enum org.pfsw.odem.TypeClassification

toString() - Method in enum org.pfsw.odem.Visibility

TypeClassification - Enum in org.pfsw.odem

Specifies the currently supported types

TypeDependency<S extends IType,T extends IType> - Class in org.pfsw.odem

This abstract dependency class implements some convenience methods to find out the kind of dependency between two types.

TypeDependency() - Constructor for class org.pfsw.odem.TypeDependency

Initialize the new instance with default values.

V

valueOf(String) - Static method in enum org.pfsw.odem.ContainerClassification

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.pfsw.odem.DependencyClassification

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.pfsw.odem.TypeClassification

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.pfsw.odem.Visibility

Returns the enum constant of this type with the specified name.

values() - Static method in enum org.pfsw.odem.ContainerClassification

Returns an array containing the constants of this enum type, in the order they're declared.

values() - Static method in enum org.pfsw.odem.DependencyClassification

Returns an array containing the constants of this enum type, in the order they're declared.

values() - Static method in enum org.pfsw.odem.TypeClassification

Returns an array containing the constants of this enum type, in the order they're declared.

values() - Static method in enum org.pfsw.odem.Visibility

Returns an array containing the constants of this enum type, in the order they're declared.

Visibility - Enum in org.pfsw.odem

Specifies the currently supported types

visitContainer(IContainer) - Method in interface org.pfsw.odem.IContainersVisitor

Will be called for each IContainer object.

visitNamespace(INamespace) - Method in interface org.pfsw.odem.INamespacesVisitor

Will be called for each INamespace object.

visitType(IType) - Method in interface org.pfsw.odem.ITypesVisitor

Will be called for each IType object.

A C D E F G I L M N O S T V