org.richfaces.json.CookieList Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of richfaces-components-ui Show documentation
The newest version!
package org.richfaces.json;

/*
 Copyright (c) 2002 JSON.org

 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
 in the Software without restriction, including without limitation the rights
 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 copies of the Software, and to permit persons to whom the Software is
 furnished to do so, subject to the following conditions:

 The above copyright notice and this permission notice shall be included in all
 copies or substantial portions of the Software.

 The Software shall be used for Good, not Evil.

 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
 */

import java.util.Iterator;

/**
 * Convert a web browser cookie list string to a JSONObject and back.
 *
 * @author JSON.org
 * @version 2
 */
public final class CookieList {
    private CookieList() {
    }

    /**
     * Convert a cookie list into a JSONObject. A cookie list is a sequence of name/value pairs. The names are separated from
     * the values by '='. The pairs are separated by ';'. The names and the values will be unescaped, possibly converting '+'
     * and '%' sequences.
     * 
     * To add a cookie to a cooklist, cookielistJSONObject.put(cookieJSONObject.getString("name"),
     * cookieJSONObject.getString("value"));
     *
     * @param string A cookie list string
     * @return A JSONObject
     * @throws JSONException
     */
    public static JSONObject toJSONObject(String string) throws JSONException {
        JSONObject o = new JSONObject();
        JSONTokener x = new JSONTokener(string);

        while (x.more()) {
            String name = Cookie.unescape(x.nextTo('='));

            x.next('=');
            o.put(name, Cookie.unescape(x.nextTo(';')));
            x.next();
        }

        return o;
    }

    /**
     * Convert a JSONObject into a cookie list. A cookie list is a sequence of name/value pairs. The names are separated from
     * the values by '='. The pairs are separated by ';'. The characters '%', '+', '=', and ';' in the names and values are
     * replaced by "%hh".
     *
     * @param o A JSONObject
     * @return A cookie list string
     * @throws JSONException
     */
    public static String toString(JSONObject o) throws JSONException {
        boolean b = false;
        Iterator keys = o.keys();
        String s;
        StringBuffer sb = new StringBuffer();

        while (keys.hasNext()) {
            s = keys.next().toString();

            if (!o.isNull(s)) {
                if (b) {
                    sb.append(';');
                }

                sb.append(Cookie.escape(s));
                sb.append("=");
                sb.append(Cookie.escape(o.getString(s)));
                b = true;
            }
        }

        return sb.toString();
    }
}