/*
* $Header: /home/cvs/jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/Header.java,v 1.10.2.2 2003/12/05 20:18:22 oglueck Exp $
* $Revision: 1.10.2.2 $
* $Date: 2003/12/05 20:18:22 $
*
* ====================================================================
*
* The Apache Software License, Version 1.1
*
* Copyright (c) 1999-2003 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution, if
* any, must include the following acknowlegement:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowlegement may appear in the software itself,
* if and wherever such third-party acknowlegements normally appear.
*
* 4. The names "The Jakarta Project", "Commons", and "Apache Software
* Foundation" must not be used to endorse or promote products derived
* from this software without prior written permission. For written
* permission, please contact [email protected].
*
* 5. Products derived from this software may not be called "Apache"
* nor may "Apache" appear in their names without prior written
* permission of the Apache Group.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*
* [Additional notices, if required by prior licensing conditions]
*
*/
package org.apache.commons.httpclient;
/**
* <p>An HTTP header.</p>
*
* @author <a href="mailto:[email protected]">Remy Maucherat</a>
* @author <a href="mailto:[email protected]">Mike Bowler</a>
* @version $Revision: 1.10.2.2 $ $Date: 2003/12/05 20:18:22 $
*/
public class Header extends NameValuePair {
// ----------------------------------------------------------- Constructors
/**
* Default constructor.
*/
public Header() {
this(null, null);
}
/**
* Constructor with name and value
*
* @param name the header name
* @param value the header value
*/
public Header(String name, String value) {
super(name, value);
}
// --------------------------------------------------------- Public Methods
/**
* Returns a {@link String} representation of the header in the form:
* <pre>
* Name: valueCRLF
* </pre>
* The string is terminated by CRLF.
*
* @return stringHEAD
*/
public String toExternalForm() {
return ((null == getName() ? "" : getName())
+ ": "
+ (null == getValue() ? "" : getValue())
+ "\r\n");
}
/**
* Returns a {@link String} representation of the header.
*
* @return stringHEAD
*/
public String toString() {
return toExternalForm();
}
/**
* Returns an array of {@link HeaderElement}s
* constructed from my value.
*
* @see HeaderElement#parse
* @throws HttpException if the header cannot be parsed
* @return an array of header elements
*/
public HeaderElement[] getValues() throws HttpException {
return HeaderElement.parse(getValue());
}
}
|