001/*
002 * CDDL HEADER START
003 *
004 * The contents of this file are subject to the terms of the
005 * Common Development and Distribution License, Version 1.0 only
006 * (the "License").  You may not use this file except in compliance
007 * with the License.
008 *
009 * You can obtain a copy of the license at legal-notices/CDDLv1_0.txt
010 * or http://forgerock.org/license/CDDLv1.0.html.
011 * See the License for the specific language governing permissions
012 * and limitations under the License.
013 *
014 * When distributing Covered Code, include this CDDL HEADER in each
015 * file and include the License file at legal-notices/CDDLv1_0.txt.
016 * If applicable, add the following below this CDDL HEADER, with the
017 * fields enclosed by brackets "[]" replaced with your own identifying
018 * information:
019 *      Portions Copyright [yyyy] [name of copyright owner]
020 *
021 * CDDL HEADER END
022 *
023 *      Copyright 2014 ForgeRock AS
024 */
025package org.forgerock.opendj.ldap.spi;
026
027/**
028 * Contains options indicating how indexing must be performed.
029 */
030public interface IndexingOptions {
031
032    /**
033     * Returns the maximum size to use when building the keys for the
034     * "substring" index.
035     *
036     * @return the maximum size to use when building the keys for the
037     *         "substring" index.
038     */
039    int substringKeySize();
040
041
042}