mapping/plugins/org.eclipse.intent.mapping/src/org/eclipse/intent/mapping/text/ITextLocation.java

/*******************************************************************************
 * Copyright (c) 2015 Obeo.
 * 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:
 *    Obeo - initial API and implementation and/or initial documentation
 *******************************************************************************/
package org.eclipse.intent.mapping.text;

import org.eclipse.intent.mapping.base.ILocation;

/**
 * An {@link ILocation} for text content.
 *
 * @author <a href="mailto:yvan.lussaud@obeo.fr">Yvan Lussaud</a>
 */
public interface ITextLocation extends ILocation {

	/**
	 * Sets the start offset of {@link ITextLocation#getText() text} in the {@link ITextContainer#getText()
	 * surrounding text}.
	 * 
	 * @param offset
	 *            the start offset
	 */
	void setStartOffset(int offset);

	/**
	 * Gets the start offset of {@link ITextLocation#getText() text} in the {@link ITextContainer#getText()
	 * surrounding text}.
	 * 
	 * @return the start offset of {@link ITextLocation#getText() text} in the {@link ITextContainer#getText()
	 *         surrounding text}
	 */
	int getStartOffset();

	/**
	 * Sets the end offset of {@link ITextLocation#getText() text} in the {@link ITextContainer#getText()
	 * surrounding text}.
	 * 
	 * @param offset
	 *            the end offset
	 */
	void setEndOffset(int offset);

	/**
	 * Gets the end offset of {@link ITextLocation#getText() text} in the {@link ITextContainer#getText()
	 * surrounding text}.
	 * 
	 * @return the end offset of {@link ITextLocation#getText() text} in the {@link ITextContainer#getText()
	 *         surrounding text}
	 */
	int getEndOffset();

}