Class Reconciler

    • Constructor Detail

      • Reconciler

        public Reconciler()
        Creates a new reconciler with the following configuration: it is an incremental reconciler with a standard delay of 500 milliseconds. There are no predefined reconciling strategies. The partitioning it uses is the default partitioning IDocumentExtension3.DEFAULT_PARTITIONING.
    • Method Detail

      • setDocumentPartitioning

        public void setDocumentPartitioning​(String partitioning)
        Sets the document partitioning for this reconciler.
        Parameters:
        partitioning - the document partitioning for this reconciler
        Since:
        3.0
      • setReconcilingStrategy

        public void setReconcilingStrategy​(IReconcilingStrategy strategy,
                                           String contentType)
        Registers a given reconciling strategy for a particular content type. If there is already a strategy registered for this type, the new strategy is registered instead of the old one.
        Parameters:
        strategy - the reconciling strategy to register, or null to remove an existing one
        contentType - the content type under which to register
      • getReconcilingStrategy

        public IReconcilingStrategy getReconcilingStrategy​(String contentType)
        Description copied from interface: IReconciler
        Returns the reconciling strategy registered with the reconciler for the specified content type.
        Specified by:
        getReconcilingStrategy in interface IReconciler
        Parameters:
        contentType - the content type for which to determine the reconciling strategy
        Returns:
        the reconciling strategy registered for the given content type, or null if there is no such strategy
      • process

        protected void process​(DirtyRegion dirtyRegion)
        Processes a dirty region. If the dirty region is null the whole document is consider being dirty. The dirty region is partitioned by the document and each partition is handed over to a reconciling strategy registered for the partition's content type.
        Specified by:
        process in class AbstractReconciler
        Parameters:
        dirtyRegion - the dirty region to be processed
        See Also:
        AbstractReconciler.process(DirtyRegion)
      • reconcilerDocumentChanged

        protected void reconcilerDocumentChanged​(IDocument document)
        Description copied from class: AbstractReconciler
        Hook called when the document whose contents should be reconciled has been changed, i.e., the input document of the text viewer this reconciler is installed on. Usually, subclasses use this hook to inform all their reconciling strategies about the change.
        Specified by:
        reconcilerDocumentChanged in class AbstractReconciler
        Parameters:
        document - the new reconciler document
      • initialProcess

        protected void initialProcess()
        Description copied from class: AbstractReconciler
        This method is called on startup of the background activity. It is called only once during the life time of the reconciler. Clients may reimplement this method.
        Overrides:
        initialProcess in class AbstractReconciler