ReindexerConfiguration.java

/*
 * Copyright 2009 Niclas Hedhman.
 *
 * 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 org.qi4j.index.reindexer;

import org.qi4j.api.common.Optional;
import org.qi4j.api.configuration.ConfigurationComposite;
import org.qi4j.api.property.Property;

public interface ReindexerConfiguration
    extends ConfigurationComposite
{
    /**
     * How many EntityStates should be sent to the indexer at a time.
     * High value improves performance, but risks of running out of memory.
     *
     * If not specified, the value of 50 will be used.
     *
     * @return the property containing the loadValue.
     */
    @Optional
    Property<Integer> loadValue();
}