1 /*
2 * $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 $
3 * $Revision: 1.10.2.2 $
4 * $Date: 2003/12/05 20:18:22 $
5 *
6 * ====================================================================
7 *
8 * The Apache Software License, Version 1.1
9 *
10 * Copyright (c) 1999-2003 The Apache Software Foundation. All rights
11 * reserved.
12 *
13 * Redistribution and use in source and binary forms, with or without
14 * modification, are permitted provided that the following conditions
15 * are met:
16 *
17 * 1. Redistributions of source code must retain the above copyright
18 * notice, this list of conditions and the following disclaimer.
19 *
20 * 2. Redistributions in binary form must reproduce the above copyright
21 * notice, this list of conditions and the following disclaimer in
22 * the documentation and/or other materials provided with the
23 * distribution.
24 *
25 * 3. The end-user documentation included with the redistribution, if
26 * any, must include the following acknowlegement:
27 * "This product includes software developed by the
28 * Apache Software Foundation (http://www.apache.org/)."
29 * Alternately, this acknowlegement may appear in the software itself,
30 * if and wherever such third-party acknowlegements normally appear.
31 *
32 * 4. The names "The Jakarta Project", "Commons", and "Apache Software
33 * Foundation" must not be used to endorse or promote products derived
34 * from this software without prior written permission. For written
35 * permission, please contact apache@apache.org.
36 *
37 * 5. Products derived from this software may not be called "Apache"
38 * nor may "Apache" appear in their names without prior written
39 * permission of the Apache Group.
40 *
41 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
42 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
43 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
44 * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
45 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
46 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
47 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
48 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
49 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
50 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
51 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
52 * SUCH DAMAGE.
53 * ====================================================================
54 *
55 * This software consists of voluntary contributions made by many
56 * individuals on behalf of the Apache Software Foundation. For more
57 * information on the Apache Software Foundation, please see
58 * <http://www.apache.org/>.
59 *
60 * [Additional notices, if required by prior licensing conditions]
61 *
62 */
63
64 package org.apache.commons.httpclient;
65
66 /***
67 * <p>An HTTP header.</p>
68 *
69 * @author <a href="mailto:remm@apache.org">Remy Maucherat</a>
70 * @author <a href="mailto:mbowler@GargoyleSoftware.com">Mike Bowler</a>
71 * @version $Revision: 1.10.2.2 $ $Date: 2003/12/05 20:18:22 $
72 */
73 public class Header extends NameValuePair {
74
75 // ----------------------------------------------------------- Constructors
76
77 /***
78 * Default constructor.
79 */
80 public Header() {
81 this(null, null);
82 }
83
84 /***
85 * Constructor with name and value
86 *
87 * @param name the header name
88 * @param value the header value
89 */
90 public Header(String name, String value) {
91 super(name, value);
92 }
93
94 // --------------------------------------------------------- Public Methods
95
96 /***
97 * Returns a {@link String} representation of the header in the form:
98 * <pre>
99 * Name: valueCRLF
100 * </pre>
101 * The string is terminated by CRLF.
102 *
103 * @return stringHEAD
104 */
105 public String toExternalForm() {
106 return ((null == getName() ? "" : getName())
107 + ": "
108 + (null == getValue() ? "" : getValue())
109 + "\r\n");
110 }
111
112 /***
113 * Returns a {@link String} representation of the header.
114 *
115 * @return stringHEAD
116 */
117 public String toString() {
118 return toExternalForm();
119 }
120
121 /***
122 * Returns an array of {@link HeaderElement}s
123 * constructed from my value.
124 *
125 * @see HeaderElement#parse
126 * @throws HttpException if the header cannot be parsed
127 * @return an array of header elements
128 */
129 public HeaderElement[] getValues() throws HttpException {
130 return HeaderElement.parse(getValue());
131 }
132
133 }
This page was automatically generated by Maven