001: /*
002: * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//httpclient/src/java/org/apache/commons/httpclient/Header.java,v 1.17 2004/09/15 20:42:17 olegk Exp $
003: * $Revision: 480424 $
004: * $Date: 2006-11-29 06:56:49 +0100 (Wed, 29 Nov 2006) $
005: *
006: * ====================================================================
007: *
008: * Licensed to the Apache Software Foundation (ASF) under one or more
009: * contributor license agreements. See the NOTICE file distributed with
010: * this work for additional information regarding copyright ownership.
011: * The ASF licenses this file to You under the Apache License, Version 2.0
012: * (the "License"); you may not use this file except in compliance with
013: * the License. You may obtain a copy of the License at
014: *
015: * http://www.apache.org/licenses/LICENSE-2.0
016: *
017: * Unless required by applicable law or agreed to in writing, software
018: * distributed under the License is distributed on an "AS IS" BASIS,
019: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
020: * See the License for the specific language governing permissions and
021: * limitations under the License.
022: * ====================================================================
023: *
024: * This software consists of voluntary contributions made by many
025: * individuals on behalf of the Apache Software Foundation. For more
026: * information on the Apache Software Foundation, please see
027: * <http://www.apache.org/>.
028: *
029: */
030:
031: package org.apache.commons.httpclient;
032:
033: /**
034: * <p>An HTTP header.</p>
035: *
036: * @author <a href="mailto:remm@apache.org">Remy Maucherat</a>
037: * @author <a href="mailto:mbowler@GargoyleSoftware.com">Mike Bowler</a>
038: * @author <a href="mailto:oleg@ural.ru">Oleg Kalnichevski</a>
039: * @version $Revision: 480424 $ $Date: 2006-11-29 06:56:49 +0100 (Wed, 29 Nov 2006) $
040: */
041: public class Header extends NameValuePair {
042:
043: // ----------------------------------------------------------- Constructors
044:
045: /**
046: * Autogenerated header flag.
047: */
048: private boolean isAutogenerated = false;
049:
050: /**
051: * Default constructor.
052: */
053: public Header() {
054: this (null, null);
055: }
056:
057: /**
058: * Constructor with name and value
059: *
060: * @param name the header name
061: * @param value the header value
062: */
063: public Header(String name, String value) {
064: super (name, value);
065: }
066:
067: /**
068: * Constructor with name and value
069: *
070: * @param name the header name
071: * @param value the header value
072: * @param isAutogenerated <tt>true</tt> if the header is autogenerated,
073: * <tt>false</tt> otherwise.
074: *
075: * @since 3.0
076: */
077: public Header(String name, String value, boolean isAutogenerated) {
078: super (name, value);
079: this .isAutogenerated = isAutogenerated;
080: }
081:
082: // --------------------------------------------------------- Public Methods
083:
084: /**
085: * Returns a {@link String} representation of the header.
086: *
087: * @return stringHEAD
088: */
089: public String toExternalForm() {
090: return ((null == getName() ? "" : getName()) + ": "
091: + (null == getValue() ? "" : getValue()) + "\r\n");
092: }
093:
094: /**
095: * Returns a {@link String} representation of the header.
096: *
097: * @return stringHEAD
098: */
099: public String toString() {
100: return toExternalForm();
101: }
102:
103: /**
104: * Returns an array of {@link HeaderElement}s
105: * constructed from my value.
106: *
107: * @see HeaderElement#parse
108: * @throws HttpException if the header cannot be parsed
109: * @return an array of header elements
110: *
111: * @deprecated Use #getElements
112: */
113: public HeaderElement[] getValues() throws HttpException {
114: return HeaderElement.parse(getValue());
115: }
116:
117: /**
118: * Returns an array of {@link HeaderElement}s
119: * constructed from my value.
120: *
121: * @see HeaderElement#parseElements(String)
122: *
123: * @return an array of header elements
124: *
125: * @since 3.0
126: */
127: public HeaderElement[] getElements() {
128: return HeaderElement.parseElements(getValue());
129: }
130:
131: /**
132: * Returns the value of the auto-generated header flag.
133: *
134: * @return <tt>true</tt> if the header is autogenerated,
135: * <tt>false</tt> otherwise.
136: *
137: * @since 3.0
138: */
139: public boolean isAutogenerated() {
140: return isAutogenerated;
141: }
142:
143: }
|