|
IBM Rational Software Modeler Release 6.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
The IArtifactManager
provides a level of abstraction for
managing elements that contain some form of Artifact
hierarchy. It isolates the client from becoming intimate with the sturcture
and location of that hierarchy.
This interface is not intended to be implemented by clients.
Field Summary | |
static int |
UNLIMITED
Indicates that an unlimited number of Artifact instances
should be returned in method calls that have a maxReturned
parameter. |
Method Summary | |
boolean |
addArtifact(Artifact anArtifact)
Adds an Artifact to the artifact hierarchy being managed. |
boolean |
containsArtifact(Artifact theArtifact)
Determines if a particular Artifact is contained in the
artifact hierarchy. |
boolean |
containsArtifact(IArtifactFilter theArtifactFilter)
Determines if an Artifact is contained in the artifact
hierarchy that matches the given filter. |
Artifact |
findArtifact(IArtifactFilter theArtifactFilter)
Finds an Artifact that matches the given filter. |
IArtifactManagerAdapter |
getAdapter()
Retrieves the adapter for the object being managed |
Collection |
getArtifacts()
Retrieves all the artifacts in the artifact hierarchy. |
Collection |
getArtifacts(IArtifactFilter theArtifactFilter,
int maxReturned)
Retrieves a Collection of Artifact
instances that match the given filter. |
Field Detail |
public static final int UNLIMITED
Artifact
instances
should be returned in method calls that have a maxReturned
parameter.
Method Detail |
public IArtifactManagerAdapter getAdapter()
public Collection getArtifacts()
Collection
containing all artifacts in the
artifact hierarchypublic Collection getArtifacts(IArtifactFilter theArtifactFilter, int maxReturned) throws IllegalArgumentException
Collection
of Artifact
instances that match the given filter. A maximum of
maxReturned
will be returned. Walking of the artifact
heirarchy will cease when the end is reached or maxReturned
are found. Use UNLIMITED
to indicate there is no limit on the
number returned.
theArtifactFilter
- the filter to use find matching artifactsmaxReturned
- the maximum number of artifacts that can be returned
Collection
of artifacts matching the filter
IllegalArgumentException
- if theArtifactFilter
is null
.public boolean containsArtifact(Artifact theArtifact)
Artifact
is contained in the
artifact hierarchy.
theArtifact
- to find in the artifact hierarchy
true
if the Artifact
is contained
in the hierachy
IllegalArgumentException
- if theArtifact
is null
.public boolean containsArtifact(IArtifactFilter theArtifactFilter)
Artifact
is contained in the artifact
hierarchy that matches the given filter.
theArtifactFilter
- the filter to use find matching artifact
true
if the artifact hierarch contains an
Artifact
matching the filter criteria
IllegalArgumentException
- if theArtifactFilter
is null
.public Artifact findArtifact(IArtifactFilter theArtifactFilter)
Artifact
that matches the given filter.
theArtifactFilter
- the filter to use find the matching artifact
Artifact
matching the filter criteria or
null
- Throws:
IllegalArgumentException
- if theArtifactFilter
is null
.
public boolean addArtifact(Artifact anArtifact) throws IllegalArgumentException
Artifact
to the artifact hierarchy being managed.
anArtifact
- to add to the artifact hierarchy
true
if successfully added
IllegalArgumentException
- if anArtifact
is null
|
IBM Rational Software Modeler Release 6.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2004. All rights reserved.