org.eclipse.jface.text.DocumentRewriteSessionType Maven / Gradle / Ivy
The newest version!
/*******************************************************************************
* Copyright (c) 2000, 2008 IBM Corporation and others.
*
* This program and the accompanying materials
* are made available under the terms of the Eclipse Public License 2.0
* which accompanies this distribution, and is available at
* https://www.eclipse.org/legal/epl-2.0/
*
* SPDX-License-Identifier: EPL-2.0
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.jface.text;
/**
* A document rewrite session type.
*
* Allowed values are:
*
*
* - {@link DocumentRewriteSessionType#UNRESTRICTED}
* - {@link DocumentRewriteSessionType#UNRESTRICTED_SMALL} (since 3.3)
* - {@link DocumentRewriteSessionType#SEQUENTIAL}
* - {@link DocumentRewriteSessionType#STRICTLY_SEQUENTIAL}
*
*
* @see org.eclipse.jface.text.IDocument
* @see org.eclipse.jface.text.IDocumentExtension4
* @see org.eclipse.jface.text.IDocumentRewriteSessionListener
* @since 3.1
*/
public class DocumentRewriteSessionType {
/**
* An unrestricted rewrite session is a sequence of unrestricted replace operations. This
* session type should only be used for large operations that touch more than about
* fifty lines. Use {@link #UNRESTRICTED_SMALL} for small operations.
*/
public final static DocumentRewriteSessionType UNRESTRICTED= new DocumentRewriteSessionType();
/**
* An small unrestricted rewrite session is a short sequence of unrestricted replace operations.
* This should be used for changes that touch less than about fifty lines.
*
* @since 3.3
*/
public final static DocumentRewriteSessionType UNRESTRICTED_SMALL= new DocumentRewriteSessionType();
/**
* A sequential rewrite session is a sequence of non-overlapping replace
* operations starting at an arbitrary document offset.
*/
public final static DocumentRewriteSessionType SEQUENTIAL= new DocumentRewriteSessionType();
/**
* A strictly sequential rewrite session is a sequence of non-overlapping
* replace operations from the start of the document to its end.
*/
public final static DocumentRewriteSessionType STRICTLY_SEQUENTIAL= new DocumentRewriteSessionType();
/**
* Prohibit external object creation.
*/
private DocumentRewriteSessionType() {
}
}