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 ch.boye.httpclientandroidlib.HeaderElement;
michael@0: import ch.boye.httpclientandroidlib.NameValuePair;
michael@0: import ch.boye.httpclientandroidlib.util.CharArrayBuffer;
michael@0: import ch.boye.httpclientandroidlib.util.LangUtils;
michael@0: 
michael@0: /**
michael@0:  * Basic implementation of {@link HeaderElement}
michael@0:  *
michael@0:  * @since 4.0
michael@0:  */
michael@0: public class BasicHeaderElement implements HeaderElement, Cloneable {
michael@0: 
michael@0:     private final String name;
michael@0:     private final String value;
michael@0:     private final NameValuePair[] parameters;
michael@0: 
michael@0:     /**
michael@0:      * Constructor with name, value and parameters.
michael@0:      *
michael@0:      * @param name header element name
michael@0:      * @param value header element value. May be <tt>null</tt>
michael@0:      * @param parameters header element parameters. May be <tt>null</tt>.
michael@0:      *   Parameters are copied by reference, not by value
michael@0:      */
michael@0:     public BasicHeaderElement(
michael@0:             final String name,
michael@0:             final String value,
michael@0:             final NameValuePair[] parameters) {
michael@0:         super();
michael@0:         if (name == null) {
michael@0:             throw new IllegalArgumentException("Name may not be null");
michael@0:         }
michael@0:         this.name = name;
michael@0:         this.value = value;
michael@0:         if (parameters != null) {
michael@0:             this.parameters = parameters;
michael@0:         } else {
michael@0:             this.parameters = new NameValuePair[] {};
michael@0:         }
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * Constructor with name and value.
michael@0:      *
michael@0:      * @param name header element name
michael@0:      * @param value header element value. May be <tt>null</tt>
michael@0:      */
michael@0:     public BasicHeaderElement(final String name, final String value) {
michael@0:        this(name, value, null);
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.value;
michael@0:     }
michael@0: 
michael@0:     public NameValuePair[] getParameters() {
michael@0:         return (NameValuePair[])this.parameters.clone();
michael@0:     }
michael@0: 
michael@0:     public int getParameterCount() {
michael@0:         return this.parameters.length;
michael@0:     }
michael@0: 
michael@0:     public NameValuePair getParameter(int index) {
michael@0:         // ArrayIndexOutOfBoundsException is appropriate
michael@0:         return this.parameters[index];
michael@0:     }
michael@0: 
michael@0:     public NameValuePair getParameterByName(final String name) {
michael@0:         if (name == null) {
michael@0:             throw new IllegalArgumentException("Name may not be null");
michael@0:         }
michael@0:         NameValuePair found = null;
michael@0:         for (int i = 0; i < this.parameters.length; i++) {
michael@0:             NameValuePair current = this.parameters[ i ];
michael@0:             if (current.getName().equalsIgnoreCase(name)) {
michael@0:                 found = current;
michael@0:                 break;
michael@0:             }
michael@0:         }
michael@0:         return found;
michael@0:     }
michael@0: 
michael@0:     public boolean equals(final Object object) {
michael@0:         if (this == object) return true;
michael@0:         if (object instanceof HeaderElement) {
michael@0:             BasicHeaderElement that = (BasicHeaderElement) object;
michael@0:             return this.name.equals(that.name)
michael@0:                 && LangUtils.equals(this.value, that.value)
michael@0:                 && LangUtils.equals(this.parameters, that.parameters);
michael@0:         } else {
michael@0:             return false;
michael@0:         }
michael@0:     }
michael@0: 
michael@0:     public int hashCode() {
michael@0:         int hash = LangUtils.HASH_SEED;
michael@0:         hash = LangUtils.hashCode(hash, this.name);
michael@0:         hash = LangUtils.hashCode(hash, this.value);
michael@0:         for (int i = 0; i < this.parameters.length; i++) {
michael@0:             hash = LangUtils.hashCode(hash, this.parameters[i]);
michael@0:         }
michael@0:         return hash;
michael@0:     }
michael@0: 
michael@0:     public String toString() {
michael@0:         CharArrayBuffer buffer = new CharArrayBuffer(64);
michael@0:         buffer.append(this.name);
michael@0:         if (this.value != null) {
michael@0:             buffer.append("=");
michael@0:             buffer.append(this.value);
michael@0:         }
michael@0:         for (int i = 0; i < this.parameters.length; i++) {
michael@0:             buffer.append("; ");
michael@0:             buffer.append(this.parameters[i]);
michael@0:         }
michael@0:         return buffer.toString();
michael@0:     }
michael@0: 
michael@0:     public Object clone() throws CloneNotSupportedException {
michael@0:         // parameters array is considered immutable
michael@0:         // no need to make a copy of it
michael@0:         return super.clone();
michael@0:     }
michael@0: 
michael@0: }
michael@0: