JAVA-6168 JAVA-6244 JAVA-6196: QE prefix/suffix/substring GA + rename Text API to String #2010
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -68,3 +68,4 @@ driver-benchmarks/.factorypath | |
| # bin build directories | ||
| **/bin | ||
|
|
||
| docs/superpowers/ | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,192 @@ | ||
| /* | ||
| * Copyright 2008-present MongoDB, Inc. | ||
| * | ||
| * 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.mongodb.client.model.vault; | ||
|
|
||
| import com.mongodb.lang.Nullable; | ||
| import org.bson.BsonDocument; | ||
|
|
||
| /** | ||
| * String options for a Queryable Encryption field that supports string queries (prefix, suffix, and substring). | ||
| * | ||
| * @since 5.9 | ||
| * @mongodb.server.release 8.2 | ||
| * @mongodb.driver.manual /core/queryable-encryption/ queryable encryption | ||
| */ | ||
| public class StringOptions { | ||
|
nhachicha marked this conversation as resolved.
Collaborator
Author
There was a problem hiding this comment. Note to reviewer: Class similar to
rozza marked this conversation as resolved.
|
||
| private boolean caseSensitive; | ||
| private boolean diacriticSensitive; | ||
| @Nullable | ||
| private BsonDocument prefixOptions; | ||
| @Nullable | ||
| private BsonDocument suffixOptions; | ||
| @Nullable | ||
| private BsonDocument substringOptions; | ||
|
|
||
| /** | ||
| * Construct a new instance | ||
| */ | ||
| public StringOptions() { | ||
| } | ||
|
|
||
| /** | ||
| * @return true if string indexes for this field are case sensitive. | ||
| */ | ||
| public boolean getCaseSensitive() { | ||
| return caseSensitive; | ||
| } | ||
|
|
||
| /** | ||
| * Set case sensitivity | ||
| * | ||
| * @param caseSensitive true if string indexes are case sensitive | ||
| * @return this | ||
| */ | ||
| public StringOptions caseSensitive(final boolean caseSensitive) { | ||
| this.caseSensitive = caseSensitive; | ||
| return this; | ||
| } | ||
|
|
||
| /** | ||
| * @return true if string indexes are diacritic sensitive | ||
| */ | ||
| public boolean getDiacriticSensitive() { | ||
| return diacriticSensitive; | ||
| } | ||
|
|
||
| /** | ||
| * Set diacritic sensitivity | ||
| * | ||
| * @param diacriticSensitive true if string indexes are diacritic sensitive | ||
| * @return this | ||
| */ | ||
| public StringOptions diacriticSensitive(final boolean diacriticSensitive) { | ||
| this.diacriticSensitive = diacriticSensitive; | ||
| return this; | ||
| } | ||
|
|
||
| /** | ||
| * Set the prefix options. | ||
| * | ||
| * <p>Expected to be a {@link BsonDocument} in the format of:</p> | ||
| * | ||
| * <pre> | ||
| * {@code | ||
| * { | ||
| * // strMinQueryLength is the minimum allowed query length. Querying with a shorter string will error. | ||
| * strMinQueryLength: BsonInt32, | ||
| * // strMaxQueryLength is the maximum allowed query length. Querying with a longer string will error. | ||
| * strMaxQueryLength: BsonInt32 | ||
| * } | ||
| * } | ||
| * </pre> | ||
| * | ||
| * @param prefixOptions the prefix options or null | ||
| * @return this | ||
| */ | ||
| public StringOptions prefixOptions(@Nullable final BsonDocument prefixOptions) { | ||
| this.prefixOptions = prefixOptions; | ||
| return this; | ||
| } | ||
|
|
||
| /** | ||
| * @see #prefixOptions(BsonDocument) | ||
| * @return the prefix options document or null | ||
| */ | ||
| @Nullable | ||
| public BsonDocument getPrefixOptions() { | ||
| return prefixOptions; | ||
| } | ||
|
|
||
| /** | ||
| * Set the suffix options. | ||
| * | ||
| * <p>Expected to be a {@link BsonDocument} in the format of:</p> | ||
| * | ||
| * <pre> | ||
| * {@code | ||
| * { | ||
| * // strMinQueryLength is the minimum allowed query length. Querying with a shorter string will error. | ||
| * strMinQueryLength: BsonInt32, | ||
| * // strMaxQueryLength is the maximum allowed query length. Querying with a longer string will error. | ||
| * strMaxQueryLength: BsonInt32 | ||
| * } | ||
| * } | ||
| * </pre> | ||
| * | ||
| * @param suffixOptions the suffix options or null | ||
| * @return this | ||
| */ | ||
| public StringOptions suffixOptions(@Nullable final BsonDocument suffixOptions) { | ||
| this.suffixOptions = suffixOptions; | ||
| return this; | ||
| } | ||
|
|
||
| /** | ||
| * @see #suffixOptions(BsonDocument) | ||
| * @return the suffix options document or null | ||
| */ | ||
| @Nullable | ||
| public BsonDocument getSuffixOptions() { | ||
| return suffixOptions; | ||
| } | ||
|
|
||
| /** | ||
| * Set the substring options. | ||
| * | ||
| * <p>Expected to be a {@link BsonDocument} in the format of:</p> | ||
| * | ||
| * <pre> | ||
| * {@code | ||
| * { | ||
| * // strMaxLength is the maximum allowed length to insert. Inserting longer strings will error. | ||
| * strMaxLength: BsonInt32, | ||
| * // strMinQueryLength is the minimum allowed query length. Querying with a shorter string will error. | ||
| * strMinQueryLength: BsonInt32, | ||
| * // strMaxQueryLength is the maximum allowed query length. Querying with a longer string will error. | ||
| * strMaxQueryLength: BsonInt32 | ||
| * } | ||
| * } | ||
| * </pre> | ||
| * | ||
| * @param substringOptions the substring options or null | ||
| * @return this | ||
| */ | ||
| public StringOptions substringOptions(@Nullable final BsonDocument substringOptions) { | ||
| this.substringOptions = substringOptions; | ||
| return this; | ||
| } | ||
|
|
||
| /** | ||
| * @see #substringOptions(BsonDocument) | ||
| * @return the substring options document or null | ||
| */ | ||
| @Nullable | ||
| public BsonDocument getSubstringOptions() { | ||
| return substringOptions; | ||
| } | ||
|
|
||
| @Override | ||
| public String toString() { | ||
| return "StringOptions{" | ||
| + "caseSensitive=" + caseSensitive | ||
| + ", diacriticSensitive=" + diacriticSensitive | ||
| + ", prefixOptions=" + prefixOptions | ||
| + ", suffixOptions=" + suffixOptions | ||
| + ", substringOptions=" + substringOptions | ||
| + '}'; | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.