org.datafx.provider.ObjectDataProviderBuilder Maven / Gradle / Ivy

Go to download
/**
 * Copyright (c) 2011, 2013, Jonathan Giles, Johan Vos, Hendrik Ebbers
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in the
 * documentation and/or other materials provided with the distribution.
 *     * Neither the name of DataFX, the website javafxdata.org, nor the
 * names of its contributors may be used to endorse or promote products
 * derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL  BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package org.datafx.provider;

import javafx.beans.property.ObjectProperty;
import org.datafx.reader.DataReader;
import org.datafx.writer.WriteBackHandler;

/**
 * Builder class for creating an {@link ObjectDataProvider}.
 * @author johan
 */
public final class ObjectDataProviderBuilder {
    
    private final ObjectDataProvider objectDataProvider;
    
    /**
     * Creates the initial builder.
     * @param  the type of the data that is expected to be returned
     * @return the builder instance
     */
    public static ObjectDataProviderBuilder create() {
        return new ObjectDataProviderBuilder();
    }
    
    private ObjectDataProviderBuilder() {
        this.objectDataProvider = new ObjectDataProvider();
    }
    
    /**
     * Provides the {@link DataReader} that contains the data
     * @param dataReader
     * @return this builder instance
     */
    public ObjectDataProviderBuilder dataReader (DataReader dataReader) {
        this.objectDataProvider.setDataReader(dataReader);
        return this;
    }
    
    /**
     * Pass an ObjectProperty that should be filled with the retrieved value.
     * @param result the ObjectProperty that we want to be used for setting the data
     * @return this builder instance
     */
    public ObjectDataProviderBuilder resultProperty(ObjectProperty result) {
        this.objectDataProvider.setResultObjectProperty(result);
        return this;
    }
    
    /**
     * Provide a handler that will be called when the retrieved data is changed
     * locally.
     * @param handler the {@link WriteBackHandler} instance
     * @return this builder instance
     */
    public ObjectDataProviderBuilder writeBackHandler(WriteBackHandler handler) {
        this.objectDataProvider.setWriteBackHandler(handler);
        return this;
    }
    
    /**
     * Construct the ObjectDataProvider that will provide the data.
     * See {@link ObjectDataProvider} for information on how to retrieve the data.
     * @return the created {@link ObjectDataProvider}
     */
    public ObjectDataProvider build () {
        return this.objectDataProvider;
    }
    
}