Interface IResourceVariantTree

    • Method Detail

      • roots

        IResource[] roots()
        Returns the list of root resources for which this tree may have resource variants.
        Returns:
        the list of root resources.
      • members

        IResource[] members​(IResource resource)
                     throws TeamException
        Returns the members of the local resource that have resource variants in this tree. The members may or may not exist locally. The resource variants corresponding to the members can be retrieved using getResourceVariant(IResource).
        Parameters:
        resource - the local resource
        Returns:
        the members of the local resource for which this tree contains resource variants
        Throws:
        TeamException
      • getResourceVariant

        IResourceVariant getResourceVariant​(IResource resource)
                                     throws TeamException
        Return the resource variant corresponding to the local resource. Return null if there is no variant for the resource.
        Parameters:
        resource - the local resource
        Returns:
        the resource's variant in this tree
        Throws:
        TeamException
      • hasResourceVariant

        boolean hasResourceVariant​(IResource resource)
                            throws TeamException
        Return whether the local resource has a variant in this tree.
        Parameters:
        resource - the local resource
        Returns:
        true if the tree contains a variant for the resource
        Throws:
        TeamException
      • refresh

        IResource[] refresh​(IResource[] resources,
                            int depth,
                            IProgressMonitor monitor)
                     throws TeamException
        Refreshes the resource variant tree for the specified resources and possibly their descendants, depending on the depth.
        Parameters:
        resources - the resources whose variants should be refreshed
        depth - the depth of the refresh (one of IResource.DEPTH_ZERO, IResource.DEPTH_ONE, or IResource.DEPTH_INFINITE)
        monitor - a progress monitor
        Returns:
        the array of resources whose corresponding variants have changed as a result of the refresh
        Throws:
        TeamException
      • flushVariants

        void flushVariants​(IResource resource,
                           int depth)
                    throws TeamException
        Flush any variants in the tree for the given resource to the depth specified.
        Parameters:
        resource - the resource
        depth - the flush depth (one of IResource.DEPTH_ZERO, IResource.DEPTH_ONE, or IResource.DEPTH_INFINITE)
        Throws:
        TeamException