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.cookie;
michael@0: 
michael@0: import java.io.Serializable;
michael@0: import java.util.Comparator;
michael@0: 
michael@0: import ch.boye.httpclientandroidlib.annotation.Immutable;
michael@0: 
michael@0: /**
michael@0:  * This cookie comparator ensures that multiple cookies satisfying
michael@0:  * a common criteria are ordered in the <tt>Cookie</tt> header such
michael@0:  * that those with more specific Path attributes precede those with
michael@0:  * less specific.
michael@0:  *
michael@0:  * <p>
michael@0:  * This comparator assumes that Path attributes of two cookies
michael@0:  * path-match a commmon request-URI. Otherwise, the result of the
michael@0:  * comparison is undefined.
michael@0:  * </p>
michael@0:  *
michael@0:  *
michael@0:  * @since 4.0
michael@0:  */
michael@0: @Immutable
michael@0: public class CookiePathComparator implements Serializable, Comparator<Cookie> {
michael@0: 
michael@0:     private static final long serialVersionUID = 7523645369616405818L;
michael@0: 
michael@0:     private String normalizePath(final Cookie cookie) {
michael@0:         String path = cookie.getPath();
michael@0:         if (path == null) {
michael@0:             path = "/";
michael@0:         }
michael@0:         if (!path.endsWith("/")) {
michael@0:             path = path + '/';
michael@0:         }
michael@0:         return path;
michael@0:     }
michael@0: 
michael@0:     public int compare(final Cookie c1, final Cookie c2) {
michael@0:         String path1 = normalizePath(c1);
michael@0:         String path2 = normalizePath(c2);
michael@0:         if (path1.equals(path2)) {
michael@0:             return 0;
michael@0:         } else if (path1.startsWith(path2)) {
michael@0:             return -1;
michael@0:         } else if (path2.startsWith(path1)) {
michael@0:             return 1;
michael@0:         } else {
michael@0:             // Does not really matter
michael@0:             return 0;
michael@0:         }
michael@0:     }
michael@0: 
michael@0: }