org.apache.lucene.search.uhighlight.CharArrayMatcher Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of lucene-highlighter Show documentation

This is the highlighter for apache lucene java

There is a newer version: 10.0.0

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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 org.apache.lucene.search.uhighlight;

import java.util.List;
import org.apache.lucene.util.BytesRef;
import org.apache.lucene.util.CharsRef;
import org.apache.lucene.util.automaton.Automata;
import org.apache.lucene.util.automaton.CharacterRunAutomaton;

/**
 * Matches a character array
 *
 * @lucene.internal
 */
public interface CharArrayMatcher {

  /** Return {@code true} if the passed-in character array matches */
  boolean match(char[] s, int offset, int length);

  /** Return {@code true} if the passed-in CharsRef matches */
  default boolean match(CharsRef chars) {
    return match(chars.chars, chars.offset, chars.length);
  }

  static CharArrayMatcher fromTerms(List terms) {
    CharacterRunAutomaton a = new CharacterRunAutomaton(Automata.makeStringUnion(terms));
    return a::run;
  }
}