org.eclipse.ui.console.PatternMatchEvent Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of org.eclipse.ui.console Show documentation
Console
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.ui.console;

import java.util.EventObject;

/**
 * An event describing a pattern match in a text console. The source of the event
 * is a TextConsole.
 * 
 * Clients may instantiate this class.
 * 
 * @see org.eclipse.ui.console.IPatternMatchListener
 * @see org.eclipse.ui.console.TextConsole
 * @since 3.1
 * @noextend This class is not intended to be subclassed by clients.
 */
public class PatternMatchEvent extends EventObject {
	/*
	 * required by EventObject for ObjectSerialization.
	 */
	private static final long serialVersionUID = 876890383326854537L;

	/**
	 * The offset of the match within the console's document.
	 */
	private final int offset;

	/**
	 * The length of the matched string
	 */
	private final int length;

	/**
	 * Constructs a new pattern match event.
	 *
	 * @param console the console in which the match was found
	 * @param matchOffset the offset at which the match was found
	 * @param matchLength the length of the text that matched
	 */
	public PatternMatchEvent(TextConsole console, int matchOffset, int matchLength) {
		super(console);
		offset = matchOffset;
		length = matchLength;
	}

	/**
	 * Returns the length of the matched string.
	 *
	 * @return the length of the matched string
	 */
	public int getLength() {
		return length;
	}

	/**
	 * Returns the offset of the match within the document.
	 *
	 * @return the offset of the match within the document
	 */
	public int getOffset() {
		return offset;
	}

}