michael@0: /*
michael@0:  * ====================================================================
michael@0:  * Licensed to the Apache Software Foundation (ASF) under one
michael@0:  * or more contributor license agreements.  See the NOTICE file
michael@0:  * distributed with this work for additional information
michael@0:  * regarding copyright ownership.  The ASF licenses this file
michael@0:  * to you under the Apache License, Version 2.0 (the
michael@0:  * "License"); you may not use this file except in compliance
michael@0:  * with the License.  You may obtain a copy of the License at
michael@0:  *
michael@0:  *   http://www.apache.org/licenses/LICENSE-2.0
michael@0:  *
michael@0:  * Unless required by applicable law or agreed to in writing,
michael@0:  * software distributed under the License is distributed on an
michael@0:  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
michael@0:  * KIND, either express or implied.  See the License for the
michael@0:  * specific language governing permissions and limitations
michael@0:  * under the License.
michael@0:  * ====================================================================
michael@0:  *
michael@0:  * This software consists of voluntary contributions made by many
michael@0:  * individuals on behalf of the Apache Software Foundation.  For more
michael@0:  * information on the Apache Software Foundation, please see
michael@0:  * <http://www.apache.org/>.
michael@0:  *
michael@0:  */
michael@0: 
michael@0: package ch.boye.httpclientandroidlib.message;
michael@0: 
michael@0: import java.io.Serializable;
michael@0: 
michael@0: import ch.boye.httpclientandroidlib.FormattedHeader;
michael@0: import ch.boye.httpclientandroidlib.HeaderElement;
michael@0: import ch.boye.httpclientandroidlib.ParseException;
michael@0: import ch.boye.httpclientandroidlib.util.CharArrayBuffer;
michael@0: 
michael@0: /**
michael@0:  * This class represents a raw HTTP header whose content is parsed 'on demand'
michael@0:  * only when the header value needs to be consumed.
michael@0:  *
michael@0:  * @since 4.0
michael@0:  */
michael@0: public class BufferedHeader implements FormattedHeader, Cloneable, Serializable {
michael@0: 
michael@0:     private static final long serialVersionUID = -2768352615787625448L;
michael@0: 
michael@0:     /**
michael@0:      * Header name.
michael@0:      */
michael@0:     private final String name;
michael@0: 
michael@0:     /**
michael@0:      * The buffer containing the entire header line.
michael@0:      */
michael@0:     private final CharArrayBuffer buffer;
michael@0: 
michael@0:     /**
michael@0:      * The beginning of the header value in the buffer
michael@0:      */
michael@0:     private final int valuePos;
michael@0: 
michael@0: 
michael@0:     /**
michael@0:      * Creates a new header from a buffer.
michael@0:      * The name of the header will be parsed immediately,
michael@0:      * the value only if it is accessed.
michael@0:      *
michael@0:      * @param buffer    the buffer containing the header to represent
michael@0:      *
michael@0:      * @throws ParseException   in case of a parse error
michael@0:      */
michael@0:     public BufferedHeader(final CharArrayBuffer buffer)
michael@0:         throws ParseException {
michael@0: 
michael@0:         super();
michael@0:         if (buffer == null) {
michael@0:             throw new IllegalArgumentException
michael@0:                 ("Char array buffer may not be null");
michael@0:         }
michael@0:         int colon = buffer.indexOf(':');
michael@0:         if (colon == -1) {
michael@0:             throw new ParseException
michael@0:                 ("Invalid header: " + buffer.toString());
michael@0:         }
michael@0:         String s = buffer.substringTrimmed(0, colon);
michael@0:         if (s.length() == 0) {
michael@0:             throw new ParseException
michael@0:                 ("Invalid header: " + buffer.toString());
michael@0:         }
michael@0:         this.buffer = buffer;
michael@0:         this.name = s;
michael@0:         this.valuePos = colon + 1;
michael@0:     }
michael@0: 
michael@0: 
michael@0:     public String getName() {
michael@0:         return this.name;
michael@0:     }
michael@0: 
michael@0:     public String getValue() {
michael@0:         return this.buffer.substringTrimmed(this.valuePos, this.buffer.length());
michael@0:     }
michael@0: 
michael@0:     public HeaderElement[] getElements() throws ParseException {
michael@0:         ParserCursor cursor = new ParserCursor(0, this.buffer.length());
michael@0:         cursor.updatePos(this.valuePos);
michael@0:         return BasicHeaderValueParser.DEFAULT
michael@0:             .parseElements(this.buffer, cursor);
michael@0:     }
michael@0: 
michael@0:     public int getValuePos() {
michael@0:         return this.valuePos;
michael@0:     }
michael@0: 
michael@0:     public CharArrayBuffer getBuffer() {
michael@0:         return this.buffer;
michael@0:     }
michael@0: 
michael@0:     public String toString() {
michael@0:         return this.buffer.toString();
michael@0:     }
michael@0: 
michael@0:     public Object clone() throws CloneNotSupportedException {
michael@0:         // buffer is considered immutable
michael@0:         // no need to make a copy of it
michael@0:         return super.clone();
michael@0:     }
michael@0: 
michael@0: }