public class

Cookie

extends Object
java.lang.Object
   ↳ org.json.Cookie

Class Overview

Convert a web browser cookie specification to a JSONObject and back. JSON and Cookies are both notations for name/value pairs.

Summary

Public Constructors
Cookie()
Public Methods
static String escape(String string)
Produce a copy of a string in which the characters '+', '%', '=', ';' and control characters are replaced with "%hh".
static JSONObject toJSONObject(String string)
Convert a cookie specification string into a JSONObject.
static String toString(JSONObject jo)
Convert a JSONObject into a cookie specification string.
static String unescape(String string)
Convert %hh sequences to single characters, and convert plus to space.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public Cookie ()

Public Methods

public static String escape (String string)

Produce a copy of a string in which the characters '+', '%', '=', ';' and control characters are replaced with "%hh". This is a gentle form of URL encoding, attempting to cause as little distortion to the string as possible. The characters '=' and ';' are meta characters in cookies. By convention, they are escaped using the URL-encoding. This is only a convention, not a standard. Often, cookies are expected to have encoded values. We encode '=' and ';' because we must. We encode '%' and '+' because they are meta characters in URL encoding.

Parameters
string The source string.
Returns
  • The escaped result.

public static JSONObject toJSONObject (String string)

Convert a cookie specification string into a JSONObject. The string will contain a name value pair separated by '='. The name and the value will be unescaped, possibly converting '+' and '%' sequences. The cookie properties may follow, separated by ';', also represented as name=value (except the secure property, which does not have a value). The name will be stored under the key "name", and the value will be stored under the key "value". This method does not do checking or validation of the parameters. It only converts the cookie string into a JSONObject.

Parameters
string The cookie specification string.
Returns
  • A JSONObject containing "name", "value", and possibly other members.
Throws
JSONException

public static String toString (JSONObject jo)

Convert a JSONObject into a cookie specification string. The JSONObject must contain "name" and "value" members. If the JSONObject contains "expires", "domain", "path", or "secure" members, they will be appended to the cookie specification string. All other members are ignored.

Parameters
jo A JSONObject
Returns
  • A cookie specification string
Throws
JSONException

public static String unescape (String string)

Convert %hh sequences to single characters, and convert plus to space.

Parameters
string A string that may contain + (plus) and %hh sequences.
Returns
  • The unescaped string.