Package org.eclipse.team.core.variants
Class PersistantResourceVariantByteStore
java.lang.Object
org.eclipse.team.core.variants.ResourceVariantByteStore
org.eclipse.team.core.variants.PersistantResourceVariantByteStore
A
ResourceVariantByteStore that caches the variant bytes using
the org.eclipse.core.resources.ISynchronizer so that the tree is
cached across workbench invocations.- Since:
- 3.0
- Restriction:
- This class is not intended to be subclassed by clients.
-
Constructor Summary
ConstructorsConstructorDescriptionCreate a persistent tree that uses the given qualified name as the key in theorg.eclipse.core.resources.ISynchronizer. -
Method Summary
Modifier and TypeMethodDescriptionbooleandeleteBytes(IResource resource) This method should be invoked by a client to indicate that it is known that there is no remote resource associated with the local resource.voiddispose()Dispose of any cached sync bytes when this cache is no longer needed.booleanflushBytes(IResource resource, int depth) Remove the bytes from the tree for the resource variants corresponding to the given local resource and its descendants to the given depth.byte[]Return the bytes for the variant corresponding the given local resource.Return the qualified name that uniquely identifies this tree.booleanisVariantKnown(IResource resource) Return whether the resource variant state for this resource is known.Return the children of the given resource that have resource variants in this tree.voidrun(IResource root, IWorkspaceRunnable runnable, IProgressMonitor monitor) Run the given action which may contain multiple modifications to the byte store.booleanSet the bytes for the variant corresponding the given local resource.Methods inherited from class org.eclipse.team.core.variants.ResourceVariantByteStore
equals
-
Constructor Details
-
PersistantResourceVariantByteStore
Create a persistent tree that uses the given qualified name as the key in theorg.eclipse.core.resources.ISynchronizer. It must be unique and should use the plugin as the local name and a unique id within the plugin as the qualifier name.- Parameters:
name- the key used in the Core synchronizer
-
-
Method Details
-
dispose
public void dispose()Description copied from class:ResourceVariantByteStoreDispose of any cached sync bytes when this cache is no longer needed.- Specified by:
disposein classResourceVariantByteStore
-
getSyncName
Return the qualified name that uniquely identifies this tree.- Returns:
- the qualified name that uniquely identifies this tree.
-
getBytes
Description copied from class:ResourceVariantByteStoreReturn the bytes for the variant corresponding the given local resource. A return value ofnullmeans that no bytes have been stored for the resource variant. It is up to the client to determine whether this means that the resource variant does not exist or that it has not been fetched or otherwise determined yet.- Specified by:
getBytesin classResourceVariantByteStore- Parameters:
resource- the local resource- Returns:
- the bytes that represent the resource's variant
- Throws:
TeamException- if an error occurs
-
setBytes
Description copied from class:ResourceVariantByteStoreSet the bytes for the variant corresponding the given local resource. The bytes should never benull. If it is known that the remote does not exist,deleteBytes(IResource)should be used instead. If the sync bytes for the remote are stale and should be removed,flushBytes(IResouce, int)should be called.- Specified by:
setBytesin classResourceVariantByteStore- Parameters:
resource- the local resourcebytes- the bytes that represent the resource's variant- Returns:
trueif the bytes changed- Throws:
TeamException- if an error occurs
-
flushBytes
Description copied from class:ResourceVariantByteStoreRemove the bytes from the tree for the resource variants corresponding to the given local resource and its descendants to the given depth. After the bytes are removed,getBytes(resource)will returnnullfor the affected resources.- Specified by:
flushBytesin classResourceVariantByteStore- Parameters:
resource- the local resourcedepth- the depth of the operation (one ofIResource.DEPTH_ZERO,IResource.DEPTH_ONE, orIResource.DEPTH_INFINITE)- Returns:
trueif there were bytes present which were removed- Throws:
TeamException- if an error occurs
-
isVariantKnown
Return whether the resource variant state for this resource is known. This is used to differentiate the case where a resource variant has never been fetched from the case where the resource variant is known to not exist. In the later case, this method returnstruewhilegetBytesreturnsnull- Parameters:
resource- the local resource- Returns:
- whether the resource variant state for this resource is known
- Throws:
TeamException- if this operation fails. Reasons include:IResourceStatus.PARTNER_NOT_REGISTEREDThe sync partner is not registered.
-
deleteBytes
This method should be invoked by a client to indicate that it is known that there is no remote resource associated with the local resource. After this method is invoked,isVariantKnown(resource)will returntrueandgetBytes(resource)will returnnull.- Specified by:
deleteBytesin classResourceVariantByteStore- Parameters:
resource- the local resource- Returns:
trueif this changes the remote sync bytes- Throws:
TeamException- if an error occurs
-
members
Description copied from class:ResourceVariantByteStoreReturn the children of the given resource that have resource variants in this tree.- Specified by:
membersin classResourceVariantByteStore- Parameters:
resource- the parent resource- Returns:
- the members who have resource variants in this tree.
- Throws:
TeamException- if an error occurs
-
run
public void run(IResource root, IWorkspaceRunnable runnable, IProgressMonitor monitor) throws TeamException Description copied from class:ResourceVariantByteStoreRun the given action which may contain multiple modifications to the byte store. By default, the action is run. Subclasses may override to obtain scheduling rules or batch deltas (if the byte store modifies workspace resources).- Overrides:
runin classResourceVariantByteStore- Parameters:
root- the root resource for all modificationsrunnable- the action to performmonitor- a progress monitor.- Throws:
TeamException- if the operation failed.
-