org.eclipse.core.filebuffers/src/org/eclipse/core/internal/filebuffers/SynchronizableDocument.java

/*******************************************************************************
 * Copyright (c) 2000, 2008 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.core.internal.filebuffers;

import org.eclipse.jface.text.BadLocationException;
import org.eclipse.jface.text.BadPartitioningException;
import org.eclipse.jface.text.BadPositionCategoryException;
import org.eclipse.jface.text.Document;
import org.eclipse.jface.text.DocumentRewriteSession;
import org.eclipse.jface.text.DocumentRewriteSessionType;
import org.eclipse.jface.text.IDocumentExtension4;
import org.eclipse.jface.text.IRegion;
import org.eclipse.jface.text.ISynchronizable;
import org.eclipse.jface.text.ITypedRegion;
import org.eclipse.jface.text.Position;


/**
 * Document that can be synchronized with a lock object.
 * <p>
 * Initially no locking takes place.
 * </p>
 *
 * @since 3.2
 */
public class SynchronizableDocument extends Document implements ISynchronizable {

	private Object fLockObject;

	/*
	 * @see org.eclipse.jface.text.ISynchronizable#setLockObject(java.lang.Object)
	 */
	public synchronized void setLockObject(Object lockObject) {
		fLockObject= lockObject;
	}

	/*
	 * @see org.eclipse.jface.text.ISynchronizable#getLockObject()
	 */
	public synchronized Object getLockObject() {
		return fLockObject;
	}

	/**
	 * {@inheritDoc}
	 *
	 * @deprecated since 3.1. Use
	 *             {@link IDocumentExtension4#startRewriteSession(DocumentRewriteSessionType)}
	 *             instead.
	 */
	public void startSequentialRewrite(boolean normalized) {
		Object lockObject= getLockObject();
		if (lockObject == null) {
			super.startSequentialRewrite(normalized);
			return;
		}
		synchronized (lockObject) {
			super.startSequentialRewrite(normalized);
		}
	}

	/**
	 * {@inheritDoc}
	 *
	 * @deprecated As of 3.1, replaced by
	 *             {@link IDocumentExtension4#stopRewriteSession(DocumentRewriteSession)}
	 */
	public void stopSequentialRewrite() {
		Object lockObject= getLockObject();
		if (lockObject == null) {
			super.stopSequentialRewrite();
			return;
		}
		synchronized (lockObject) {
			super.stopSequentialRewrite();
		}
	}

	/*
	 * @see org.eclipse.jface.text.AbstractDocument#startRewriteSession(org.eclipse.jface.text.DocumentRewriteSessionType)
	 *
	 * @since 3.5
	 */
	public DocumentRewriteSession startRewriteSession(DocumentRewriteSessionType sessionType) {
		Object lockObject= getLockObject();
		if (lockObject == null) {
			return super.startRewriteSession(sessionType);
		}
		synchronized (lockObject) {
			return super.startRewriteSession(sessionType);
		}
	}

	/*
	 * @see org.eclipse.jface.text.AbstractDocument#stopRewriteSession(org.eclipse.jface.text.DocumentRewriteSession)
	 *
	 * @since 3.5
	 */
	public void stopRewriteSession(DocumentRewriteSession session) {
		Object lockObject= getLockObject();
		if (lockObject == null) {
			super.stopRewriteSession(session);
			return;
		}
		synchronized (lockObject) {
			super.stopRewriteSession(session);
		}
	}

	/*
	 * @see IDocument#get()
	 */
	public String get() {
		Object lockObject= getLockObject();
		if (lockObject == null) {
			return super.get();
		}
		synchronized (lockObject) {
			return super.get();
		}
	}

	/*
	 * @see IDocument#get(int, int)
	 */
	public String get(int offset, int length) throws BadLocationException {
		Object lockObject= getLockObject();
		if (lockObject == null) {
			return super.get(offset, length);
		}
		synchronized (lockObject) {
			return super.get(offset, length);
		}
	}

	/*
	 * @see IDocument#getChar(int)
	 */
	public char getChar(int offset) throws BadLocationException {
		Object lockObject= getLockObject();
		if (lockObject == null) {
			return super.getChar(offset);
		}
		synchronized (lockObject) {
			return super.getChar(offset);
		}
	}

	/*
	 * @see org.eclipse.jface.text.IDocumentExtension4#getModificationStamp()
	 * @since 3.1
	 */
	public long getModificationStamp() {
		Object lockObject= getLockObject();
		if (lockObject == null) {
			return super.getModificationStamp();
		}
		synchronized (lockObject) {
			return super.getModificationStamp();
		}
	}

	/*
	 * @see IDocument#replace(int, int, String)
	 */
	public void replace(int offset, int length, String text) throws BadLocationException {
		Object lockObject= getLockObject();
		if (lockObject == null) {
			super.replace(offset, length, text);
			return;
		}
		synchronized (lockObject) {
			super.replace(offset, length, text);
		}
	}

	/*
	 * @see IDocumentExtension4#replace(int, int, String, long)
	 */
	public void replace(int offset, int length, String text, long modificationStamp) throws BadLocationException {
		Object lockObject= getLockObject();
		if (lockObject == null) {
			super.replace(offset, length, text, modificationStamp);
			return;
		}
		synchronized (lockObject) {
			super.replace(offset, length, text, modificationStamp);
		}
	}

	/*
	 * @see IDocument#set(String)
	 */
	public void set(String text) {
		Object lockObject= getLockObject();
		if (lockObject == null) {
			super.set(text);
			return;
		}
		synchronized (lockObject) {
			super.set(text);
		}
	}

	/*
	 * @see IDocumentExtension4#set(String, long)
	 */
	public void set(String text, long modificationStamp) {
		Object lockObject= getLockObject();
		if (lockObject == null) {
			super.set(text, modificationStamp);
			return;
		}
		synchronized (lockObject) {
			super.set(text, modificationStamp);
		}
	}

	/*
	 * @see org.eclipse.jface.text.AbstractDocument#addPosition(java.lang.String, org.eclipse.jface.text.Position)
	 */
	public void addPosition(String category, Position position) throws BadLocationException, BadPositionCategoryException {
		Object lockObject= getLockObject();
		if (lockObject == null) {
			super.addPosition(category, position);
			return;
		}
		synchronized (lockObject) {
			super.addPosition(category, position);
		}
	}

	/*
	 * @see org.eclipse.jface.text.AbstractDocument#removePosition(java.lang.String, org.eclipse.jface.text.Position)
	 */
	public void removePosition(String category, Position position) throws BadPositionCategoryException {
		Object lockObject= getLockObject();
		if (lockObject == null) {
			super.removePosition(category, position);
			return;
		}
		synchronized (lockObject) {
			super.removePosition(category, position);
		}
	}

	/*
	 * @see org.eclipse.jface.text.AbstractDocument#getPositions(java.lang.String)
	 */
	public Position[] getPositions(String category) throws BadPositionCategoryException {
		Object lockObject= getLockObject();
		if (lockObject == null) {
			return super.getPositions(category);
		}
		synchronized (lockObject) {
			return super.getPositions(category);
		}
	}

	/*
	 * @see org.eclipse.jface.text.AbstractDocument#getPositions(java.lang.String, int, int, boolean, boolean)
	 * @since 3.4
	 */
	public Position[] getPositions(String category, int offset, int length, boolean canStartBefore, boolean canEndAfter) throws BadPositionCategoryException {
		Object lockObject= getLockObject();
		if (lockObject == null) {
			return super.getPositions(category, offset, length, canStartBefore, canEndAfter);
		}
		synchronized (lockObject) {
			return super.getPositions(category, offset, length, canStartBefore, canEndAfter);
		}
	}

	/*
	 * @see org.eclipse.jface.text.AbstractDocument#computePartitioning(java.lang.String, int, int, boolean)
	 *
	 * @since 3.5
	 */
	public ITypedRegion[] computePartitioning(String partitioning, int offset, int length, boolean includeZeroLengthPartitions) throws BadLocationException, BadPartitioningException {
		Object lockObject= getLockObject();
		if (lockObject == null) {
			return super.computePartitioning(partitioning, offset, length, includeZeroLengthPartitions);
		}
		synchronized (lockObject) {
			return super.computePartitioning(partitioning, offset, length, includeZeroLengthPartitions);
		}
	}

	/*
	 * @see org.eclipse.jface.text.AbstractDocument#getLineDelimiter(int)
	 *
	 * @since 3.5
	 */
	public String getLineDelimiter(int line) throws BadLocationException {
		Object lockObject= getLockObject();
		if (lockObject == null) {
			return super.getLineDelimiter(line);
		}
		synchronized (lockObject) {
			return super.getLineDelimiter(line);
		}
	}

	/*
	 * @see org.eclipse.jface.text.AbstractDocument#getDefaultLineDelimiter()
	 *
	 * @since 3.5
	 */
	public String getDefaultLineDelimiter() {
		Object lockObject= getLockObject();
		if (lockObject == null) {
			return super.getDefaultLineDelimiter();
		}
		synchronized (lockObject) {
			return super.getDefaultLineDelimiter();
		}
	}

	/*
	 * @see org.eclipse.jface.text.AbstractDocument#getLineInformation(int)
	 *
	 * @since 3.5
	 */
	public IRegion getLineInformation(int line) throws BadLocationException {
		Object lockObject= getLockObject();
		if (lockObject == null) {
			return super.getLineInformation(line);
		}
		synchronized (lockObject) {
			return super.getLineInformation(line);
		}
	}

	/*
	 * @see org.eclipse.jface.text.AbstractDocument#getLineInformationOfOffset(int)
	 *
	 * @since 3.5
	 */
	public IRegion getLineInformationOfOffset(int offset) throws BadLocationException {
		Object lockObject= getLockObject();
		if (lockObject == null) {
			return super.getLineInformationOfOffset(offset);
		}
		synchronized (lockObject) {
			return super.getLineInformationOfOffset(offset);
		}
	}

	/*
	 * @see org.eclipse.jface.text.AbstractDocument#getLineLength(int)
	 *
	 * @since 3.5
	 */
	public int getLineLength(int line) throws BadLocationException {
		Object lockObject= getLockObject();
		if (lockObject == null) {
			return super.getLineLength(line);
		}
		synchronized (lockObject) {
			return super.getLineLength(line);
		}
	}

	/*
	 * @see org.eclipse.jface.text.AbstractDocument#getLineOffset(int)
	 *
	 * @since 3.5
	 */
	public int getLineOffset(int line) throws BadLocationException {
		Object lockObject= getLockObject();
		if (lockObject == null) {
			return super.getLineOffset(line);
		}
		synchronized (lockObject) {
			return super.getLineOffset(line);
		}
	}

	/*
	 * @see org.eclipse.jface.text.AbstractDocument#getLineOfOffset(int)
	 *
	 * @since 3.5
	 */
	public int getLineOfOffset(int pos) throws BadLocationException {
		Object lockObject= getLockObject();
		if (lockObject == null) {
			return super.getLineOfOffset(pos);
		}
		synchronized (lockObject) {
			return super.getLineOfOffset(pos);
		}
	}
}