org.springframework.data.elasticsearch.annotations.HighlightField Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of spring-data-elasticsearch Show documentation

Spring Data Implementation for Elasticsearch

There is a newer version: 5.2.5

Show newest version

/*
 * Copyright 2020-2021 the original author or authors.
 *
 * 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
 *
 *      https://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.springframework.data.elasticsearch.annotations;

import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;

/**
 * @author Peter-Josef Meisch
 * @since 4.0
 */
@Documented
@Retention(RetentionPolicy.RUNTIME)
public @interface HighlightField {

	/**
	 * The name of the field to apply highlighting to. This must be the field name of the entity's property, not the name
	 * of the field in the index mappings.
	 */
	String name() default "";

	HighlightParameters parameters() default @HighlightParameters;
}