/*
 * Copyright (c) 2022 MarkLogic Corporation
 *
 * 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.marklogic.client.query;

/**
 * A MatchSnippet is a Java object representation of a part of a snippet.
 */
public interface MatchSnippet {
  /**
   * Identifies whether this run of text in the snippet matches the search criteria or not.
   *
   * If the text matches the criteria, it will be highlighted.
   *
   * @return The hightlight value.
   */
  boolean isHighlighted();

  /**
   * Returns the string value of the run of text in this part of the snippet.
   * @return The text string.
   */
  String getText();
}
