fr.esrf.TangoApi.PipeBlobBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of JTangoCommons Show documentation
Common classes for tango java API
There is a newer version: 10.0.0
package fr.esrf.TangoApi;

import fr.esrf.Tango.DevEncoded;
import fr.esrf.Tango.DevState;

import java.util.ArrayList;
import java.util.List;

/**
 * Implements builder pattern for {@link PipeBlob}
 *
 * Not thread safe. Designed to be thread confinement.
 *
 * @author Igor Khokhriakov 
 * @since 06.10.14
 */
//@NotThreadSafe
public class PipeBlobBuilder {
    private String blobName;
    private List elements = new ArrayList();

    public PipeBlobBuilder(String blobName) {
        this.blobName = blobName;
    }

    public PipeBlobBuilder add(String name, boolean value) {
        elements.add(new PipeDataElement(name, value));
        return this;
    }

    public PipeBlobBuilder add(String name, boolean[] value) {
        elements.add(new PipeDataElement(name, value));
        return this;
    }

    public PipeBlobBuilder add(String name, short value) {
        elements.add(new PipeDataElement(name, value));
        return this;
    }

    /**
     *
     * @param name
     * @param value
     * @param asUChar treat Java short (2 bytes) as C++ unsigned char (1 byte)
     */
    public PipeBlobBuilder add(String name, short[] value, boolean asUChar) {
        elements.add(new PipeDataElement(name, value, asUChar));
        return this;
    }

    public PipeBlobBuilder add(String name, int value) {
        elements.add(new PipeDataElement(name, value));
        return this;
    }

    /**
     *
     * @param name
     * @param value
     * @param asUShort treat Java int (4 bytes) as C++ unsigned short (2 bytes)
     */
    public PipeBlobBuilder add(String name, int[] value, boolean asUShort) {
        elements.add(new PipeDataElement(name, value, asUShort));
        return this;
    }

    public PipeBlobBuilder add(String name, long value) {
        elements.add(new PipeDataElement(name, value));
        return this;
    }

    public PipeBlobBuilder add(String name, long[] value) {
        elements.add(new PipeDataElement(name, value));
        return this;
    }

    public PipeBlobBuilder add(String name, float value) {
        elements.add(new PipeDataElement(name, value));
        return this;
    }

    public PipeBlobBuilder add(String name, float[] value) {
        elements.add(new PipeDataElement(name, value));
        return this;
    }

    public PipeBlobBuilder add(String name, double value) {
        elements.add(new PipeDataElement(name, value));
        return this;
    }

    public PipeBlobBuilder add(String name, double[] value) {
        elements.add(new PipeDataElement(name, value));
        return this;
    }

    public PipeBlobBuilder add(String name, String value) {
        elements.add(new PipeDataElement(name, value));
        return this;
    }

    public PipeBlobBuilder add(String name, String[] value) {
        elements.add(new PipeDataElement(name, value));
        return this;
    }

    public PipeBlobBuilder add(String name, DevState value) {
        elements.add(new PipeDataElement(name, value));
        return this;
    }

    public PipeBlobBuilder add(String name, DevState[] value) {
        elements.add(new PipeDataElement(name, value));
        return this;
    }

    public PipeBlobBuilder add(String name, DevEncoded value) {
        elements.add(new PipeDataElement(name, value));
        return this;
    }

    public PipeBlobBuilder add(String name, DevEncoded[] value) {
        elements.add(new PipeDataElement(name, value));
        return this;
    }

    public PipeBlobBuilder add(String name, PipeBlob value) {
        elements.add(new PipeDataElement(name, value));
        return this;
    }

	/**
	 * Adds a generic array to this PipeBlob
	 *
	 * @throws IllegalArgumentException if value is not an array
	 */
    public PipeBlobBuilder add(String name, Object value){
        elements.add(PipeDataElement.newInstance(name, value));
        return this;
    }

    public PipeBlob build(){
        PipeBlob blob = new PipeBlob(blobName);
        blob.addAll(elements);
        return blob;
    }
}