com.azure.core.http.HttpHeader Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of azure-core Show documentation

This package contains core types for Azure Java clients.

There is a newer version: 1.54.1

// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.

package com.azure.core.http;

import com.azure.core.util.Header;

import java.util.List;

/**
 * Represents a single header within an HTTP request or response.
 *
 * This class encapsulates the name and value(s) of an HTTP header. If multiple values are associated with the same
 * header name, they are stored in a single HttpHeader instance with values separated by commas.
 *
 * It provides constructors to create an HttpHeader instance with a single value {@link #HttpHeader(String, String)}
 * or multiple values {@link #HttpHeader(String, List)}.
 *
 * This class is useful when you want to work with individual headers of an HTTP request or response.
 *
 * Note: Header names are case-insensitive.
 */
public class HttpHeader extends Header {
    /**
     * Create an HttpHeader instance using the provided name and value.
     *
     * @param name the name
     * @param value the value
     */
    public HttpHeader(String name, String value) {
        super(name, value);
    }

    /**
     * Create an HttpHeader instance using the provided name and values, resulting in a single HttpHeader instance with
     * a single name and multiple values set within it.
     *
     * @param name the name
     * @param values the values
     */
    public HttpHeader(String name, List values) {
        super(name, values);
    }
}