com.avaje.ebeaninternal.server.lucene.DocFieldWriter Maven / Gradle / Ivy

Go to download
/**
 * Copyright (C) 2009 Authors
 * 
 * This file is part of Ebean.
 * 
 * Ebean is free software; you can redistribute it and/or modify it 
 * under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation; either version 2.1 of the License, or
 * (at your option) any later version.
 *  
 * Ebean is distributed in the hope that it will be useful, but 
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public License
 * along with Ebean; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA  
 */
package com.avaje.ebeaninternal.server.lucene;

import org.apache.lucene.document.Document;

/**
 * Safe for a single thread to write to the document and index.
 * 
 * This can cache/reuse Fields knowing that it will only be used in a single
 * thread (not concurrently).
 * 
 * 
 * @author rbygrave
 */
public interface DocFieldWriter {

    /**
     * Write the bean properties value(s) to the document (via fields).
     */
    public void writeValue(Object bean, Document document);

}