com.jayway.restassured.response.Headers Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of rest-assured Show documentation
Java DSL for easy testing of REST services
There is a newer version: 2.9.0
/*
 * Copyright 2013 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *        http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.jayway.restassured.response;

import com.jayway.restassured.internal.MultiValueEntity;

import java.util.Iterator;
import java.util.LinkedList;
import java.util.List;

import static com.jayway.restassured.internal.assertion.AssertParameter.notNull;
import static java.util.Arrays.asList;

/**
 * Represents the a number of response headers
 */
public class Headers implements Iterable {

    private final MultiValueEntity headers;

    public Headers(Header...headers) {
        this(asList(headers));
    }

    public Headers(List headers) {
        notNull(headers, "Headers");
        this.headers = new MultiValueEntity(headers);
    }

    /**
     * @return The size of the headers
     */
    public int size() {
        return headers.size();
    }

    /**
     * @return true if one or more headers are defined, false otherwise.
     */
    public boolean exist() {
        return headers.exist();
    }

    /**
     * See if a header with the given name exists
     *
     * @param headerName The name of the header to check
     * @return true if the header exists
     */
    public boolean hasHeaderWithName(String headerName) {
        return headers.hasEntityWithName(headerName);
    }

    /**
     * @return All headers as a list.
     */
    protected List list() {
        return headers.list();
    }

    /**
     *  Get a single header with the supplied name. If there are several headers match the headerName then
     *  the first one is returned.
     *
     *
     * @param headerName The name of the header to find
     * @return The found header or null if no header was found.
     */
    public Header get(String headerName) {
        notNull(headerName, "Header name");
        return headers.get(headerName);
    }

    /**
     *  Get a single header with the supplied name. If there are several headers match the headerName then
     *  the first one is returned.
     *
     * @param headerName The name of the header to find
     * @return The found header value or null if no header was found.
     */
    public String getValue(String headerName) {
        return headers.getValue(headerName);
    }

    /**
     *  Get all header values of the header with supplied name. If there's only one header matching the headerName then
     *  a list with only that header value is returned.
     *
     * @param headerName The name of the header to find
     * @return The found header values or empty list if no header was found.
     */
    public List getValues(String headerName) {
       return headers.getValues(headerName);
    }

    /**
     *  Get all headers with the supplied name. If there's only one header matching the headerName then
     *  a list with only that header is returned.
     *
     * @param headerName The name of the header to find
     * @return The found headers or empty list if no header was found.
     */
    public List getList(String headerName) {
        return headers.getList(headerName);
    }

    /**
     * @return Headers iterator
     */
    public Iterator iterator() {
        return headers.iterator();
    }

    /**
     *  An alternative way to create a Headers object from the constructor.
     *
     * @param header The header to be included
     * @param additionalHeaders Additional headers to be included (optional)
     * @return A new headers object containing the specified headers
     */
    public static Headers headers(Header header, Header... additionalHeaders) {
        notNull(header, "Header");
        final List headerList = new LinkedList();
        headerList.add(header);
        if(headerList != null) {
            for (Header additionalHeader : additionalHeaders) {
                headerList.add(additionalHeader);
            }
        }
        return new Headers(headerList);
    }

    @Override
    public String toString() {
        return headers.toString();
    }
}