/*
* $HeadURL: http://svn.apache.org/repos/asf/jakarta/httpcomponents/httpcore/tags/4.0-alpha6/module-main/src/main/java/org/apache/http/message/BufferedHeader.java $
* $Revision: 569781 $
* $Date: 2007-08-26 11:05:06 +0200 (Sun, 26 Aug 2007) $
*
* ====================================================================
* 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.
* ====================================================================
*
* 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/>.
*
*/
package org.apache.http.message;
import org.apache.http.FormattedHeader;
import org.apache.http.HeaderElement;
import org.apache.http.ParseException;
import org.apache.http.util.CharArrayBuffer;
/**
* This class represents a raw HTTP header whose content is parsed 'on demand'
* only when the header value needs to be consumed.
*
* @author <a href="mailto:oleg at ural.ru">Oleg Kalnichevski</a>
*
*
* <!-- empty lines above to avoid 'svn diff' context problems -->
* @version $Revision: 569781 $ $Date: 2007-08-26 11:05:06 +0200 (Sun, 26 Aug 2007) $
*/
public class BufferedHeader implements FormattedHeader {
/**
* Header name.
*/
private final String name;
/**
* The buffer containing the entire header line.
*/
private final CharArrayBuffer buffer;
/**
* The beginning of the header value in the buffer
*/
private final int valuePos;
/**
* The parser for the header value, or <code>null</code>.
*/
private HeaderValueParser parser;
/**
* Creates a new header from a buffer.
* The name of the header will be parsed immediately,
* the value only if it is accessed.
*
* @param buffer the buffer containing the header to represent
* @param parser the header value parser, or <code>null</code>
*
* @throws ParseException in case of a parse error
*/
public BufferedHeader(final CharArrayBuffer buffer,
final HeaderValueParser parser)
throws ParseException {
super();
if (buffer == null) {
throw new IllegalArgumentException
("Char array buffer may not be null");
}
int colon = buffer.indexOf(':');
if (colon == -1) {
throw new ParseException
("Invalid header: " + buffer.toString());
}
String s = buffer.substringTrimmed(0, colon);
if (s.length() == 0) {
throw new ParseException
("Invalid header: " + buffer.toString());
}
this.buffer = buffer;
this.name = s;
this.valuePos = colon + 1;
this.parser = parser;
}
public BufferedHeader(final CharArrayBuffer buffer)
throws ParseException {
this(buffer, null);
}
public String getName() {
return this.name;
}
public String getValue() {
return this.buffer.substringTrimmed(this.valuePos, this.buffer.length());
}
public HeaderValueParser getParser() {
return this.parser;
}
public void setParser(HeaderValueParser parser) {
this.parser = parser;
}
public HeaderElement[] getElements() throws ParseException {
HeaderValueParser hvp = this.parser;
if (hvp == null)
hvp = BasicHeaderValueParser.DEFAULT;
return hvp.parseElements(this.buffer,
this.valuePos, this.buffer.length());
}
public int getValuePos() {
return this.valuePos;
}
public CharArrayBuffer getBuffer() {
return this.buffer;
}
public String toString() {
return this.buffer.toString();
}
}