|
Eclipse Platform Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
A handle that provides access to locally cached resource variants that represent a resource line-up such as a project version or branch.
This interface is not intended to be implemented by clients. However,
clients may subclass AbstractResourceVariantTree
or ResourceVariantTree
.
AbstractResourceVariantTree
,
ResourceVariantTree
Method Summary | |
---|---|
void |
flushVariants(IResource resource,
int depth)
Flush any variants in the tree for the given resource to the depth specified. |
IResourceVariant |
getResourceVariant(IResource resource)
Return the resource variant corresponding to the local resource. |
boolean |
hasResourceVariant(IResource resource)
Return whether the local resource has a variant in this tree. |
IResource[] |
members(IResource resource)
Returns the members of the local resource that have resource variants in this tree. |
IResource[] |
refresh(IResource[] resources,
int depth,
IProgressMonitor monitor)
Refreshes the resource variant tree for the specified resources and possibly their descendants, depending on the depth. |
IResource[] |
roots()
Returns the list of root resources for which this tree may have resource variants. |
Method Detail |
public IResource[] roots()
public IResource[] members(IResource resource) throws TeamException
getResourceVariant(IResource)
.
resource
- the local resource
TeamException
public IResourceVariant getResourceVariant(IResource resource) throws TeamException
null
if there is no variant for the resource.
resource
- the local resource
TeamException
public boolean hasResourceVariant(IResource resource) throws TeamException
resource
- the local resource
true
if the tree contains a variant for the resource
TeamException
public IResource[] refresh(IResource[] resources, int depth, IProgressMonitor monitor) throws TeamException
resources
- the resources whose variants should be refresheddepth
- the depth of the refresh (one of IResource.DEPTH_ZERO
,
IResource.DEPTH_ONE
, or IResource.DEPTH_INFINITE
)monitor
- a progress monitor
TeamException
public void flushVariants(IResource resource, int depth) throws TeamException
resource
- the resourcedepth
- the flush depth (one of IResource.DEPTH_ZERO
,
IResource.DEPTH_ONE
, or IResource.DEPTH_INFINITE
)
TeamException
|
Eclipse Platform Release 3.1 |
|||||||||||
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 2000, 2005. All rights reserved.