platform/lang-api/src/com/intellij/find/FindResult.java

/*
 * Copyright 2000-2009 JetBrains s.r.o.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.intellij.find;

import com.intellij.openapi.util.TextRange;

/**
 * Represents the result of a Find operation.
 *
 * @see FindManager#findString(CharSequence, int, FindModel)
 */
public abstract class FindResult extends TextRange {
  public FindResult(int startOffset, int endOffset) {
    super(startOffset, endOffset);
  }

  /**
   * Checks if the find operation was successful.
   *
   * @return true if a string was found by the operation, false otherwise.
   */
  public abstract boolean isStringFound();
}