QueryCharacteristic.java

/*
 * Copyright 2025-present 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.mongodb.core.schema;

import org.bson.Document;

/**
 * Defines the specific character of a query that can be executed. Mainly used to define the characteristic of queryable
 * encrypted fields.
 * 
 * @author Christoph Strobl
 * @since 4.5
 */
public interface QueryCharacteristic {

	/**
	 * @return the query type, eg. {@literal range}.
	 */
	String queryType();

	/**
	 * @return the raw {@link Document} representation of the instance.
	 */
	default Document toDocument() {
		return new Document("queryType", queryType());
	}
}