blob: 181d6e3afcb0b073b4b5c9ebb6783369988b03fa [file] [log] [blame]
/*******************************************************************************
* Copyright (c) 2005-2014 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
*******************************************************************************/
package org.eclipse.sirius.query.legacy.tools.strings;
/**
* It's a scanner that ignores a sequence of characters.
*
*
*/
public interface Jump {
/**
* Returns the index within the buffer of the first occurrence of this jump,
* starting at the specified index.
*
* @param buffer
* is the text to be explored
* @param posBegin
* is the beginning index
* @param posEnd
* is the ending index
* @return the index within the buffer of the first occurrence
*/
public Int2 begin(String buffer, int posBegin, int posEnd);
/**
* Returns the index within the buffer of the end of this jump.
*
* @param buffer
* is the text to be explored
* @param begin
* is the beginning index of this jump
* @param posEnd
* is the ending index
* @param spec
* is the pattern's escape character
* @param inhibs
* are the ignored blocks
* @return the last ignored index
*/
public int end(String buffer, Int2 begin, int posEnd, String spec, String[][] inhibs);
}