org.apache.juneau.http.HeaderStringArray Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of juneau-all
Apache Juneau UberJar
There is a newer version: 9.0.1
// ***************************************************************************************************************************
// * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  See the NOTICE file *
// * distributed with this work for additional information regarding copyright ownership.  The ASF licenses this file        *
// * to you 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 org.apache.juneau.http;

import org.apache.juneau.internal.*;

/**
 * Category of headers that consist of a comma-delimited list of string values.
 *
 * 
 * 
Example
 * 
 * 	Allow: GET, PUT
 * 
 *
 * Additional Information
 * 
 * 	
 * 		org.apache.juneau.http
 * 	

 * 		
 * 		Hypertext Transfer Protocol -- HTTP/1.1
 * 
 */
public class HeaderStringArray {

	private final String[] value;

	/**
	 * Constructor.
	 *
	 * @param value The raw header value.
	 */
	protected HeaderStringArray(String value) {
		this.value = StringUtils.split(value);
	}

	/**
	 * Returns this header as a simple string value.
	 *
	 * 
	 * Functionally equivalent to calling {@link #toString()}.
	 *
	 * @return This header as a simple string.
	 */
	public String asString() {
		return StringUtils.join(value, ',');
	}

	/**
	 * Returns true if this header contains the specified value.
	 *
	 * @param val The value to check for.
	 * @return true if this header contains the specified value.
	 */
	public boolean contains(String val) {
		if (val != null)
			for (String v : value)
				if (val.equals(v))
					return true;
		return false;
	}

	/**
	 * Returns true if this header contains the specified value using {@link String#equalsIgnoreCase(String)}.
	 *
	 * @param val The value to check for.
	 * @return true if this header contains the specified value.
	 */
	public boolean containsIC(String val) {
		if (val != null)
			for (String v : value)
				if (val.equalsIgnoreCase(v))
					return true;
		return false;
	}

	@Override /* Object */
	public String toString() {
		return asString();
	}
}