ExternalMessageBuilder.java

/*
 * Copyright (c) 2017 Bosch Software Innovations GmbH.
 *
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v2.0
 * which accompanies this distribution, and is available at
 * https://www.eclipse.org/org/documents/epl-2.0/index.php
 *
 * Contributors:
 *    Bosch Software Innovations GmbH - initial contribution
 */
package org.eclipse.ditto.model.amqpbridge;

import java.nio.ByteBuffer;
import java.util.Map;

import javax.annotation.Nullable;

/**
 * Builder for building instances of {@link ExternalMessage}.
 */
public interface ExternalMessageBuilder {

    /**
     * Adds the additional header identified by the passed {@code key} and {@code value} to this builder.
     *
     * @param key the header key
     * @param value the header value
     * @return this builder in order to enable method chaining
     */
    ExternalMessageBuilder withAdditionalHeaders(String key, String value);

    /**
     * Adds the additional headers to this builder.
     *
     * @param additionalHeaders the additional headers to add
     * @return this builder in order to enable method chaining
     */
    ExternalMessageBuilder withAdditionalHeaders(Map<String, String> additionalHeaders);

    /**
     * Sets the passed {@code text} to the builder and also changing the
     * {@link org.eclipse.ditto.model.amqpbridge.ExternalMessage.PayloadType PayloadType} to {@code TEXT}.
     *
     * @param text the text payload to set
     * @return this builder in order to enable method chaining
     */
    ExternalMessageBuilder withText(@Nullable String text);

    /**
     * Sets the passed {@code bytes} to the builder and also changing the
     * {@link org.eclipse.ditto.model.amqpbridge.ExternalMessage.PayloadType PayloadType} to {@code BYTES}.
     *
     * @param bytes the bytes payload to set
     * @return this builder in order to enable method chaining
     */
    ExternalMessageBuilder withBytes(@Nullable byte[] bytes);

    /**
     * Sets the passed {@code bytes} to the builder and also changing the
     * {@link org.eclipse.ditto.model.amqpbridge.ExternalMessage.PayloadType PayloadType} to {@code BYTES}.
     *
     * @param bytes the bytes payload to set
     * @return this builder in order to enable method chaining
     */
    ExternalMessageBuilder withBytes(@Nullable ByteBuffer bytes);

    /**
     * Builds the ExternalMessage.
     *
     * @return the build message
     */
    ExternalMessage build();
}