mirror of
https://github.com/IntellectualSites/PlotSquared.git
synced 2024-11-30 00:56:45 +01:00
411 lines
21 KiB
HTML
411 lines
21 KiB
HTML
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
||
|
|
<!-- NewPage -->
|
||
|
|
<html lang="sv">
|
||
|
|
<head>
|
||
|
|
<!-- Generated by javadoc (version 1.7.0_67) on Sun Nov 16 11:09:54 CET 2014 -->
|
||
|
|
<title>Cookie</title>
|
||
|
|
<meta name="date" content="2014-11-16">
|
||
|
|
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
|
||
|
|
</head>
|
||
|
|
<body>
|
||
|
|
<script type="text/javascript"><!--
|
||
|
|
if (location.href.indexOf('is-external=true') == -1) {
|
||
|
|
parent.document.title = "Cookie";
|
||
|
|
}
|
||
|
|
//-->
|
||
|
|
</script>
|
||
|
|
<noscript>
|
||
|
|
<div>JavaScript is disabled on your browser.</div>
|
||
|
|
</noscript>
|
||
|
|
<!-- ========= START OF TOP NAVBAR ======= -->
|
||
|
|
<div class="topNav"><a name="navbar_top">
|
||
|
|
<!-- -->
|
||
|
|
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="navList" title="Navigation">
|
||
|
|
<li><a href="../../../overview-summary.html">Overview</a></li>
|
||
|
|
<li><a href="package-summary.html">Package</a></li>
|
||
|
|
<li class="navBarCell1Rev">Class</li>
|
||
|
|
<li><a href="package-tree.html">Tree</a></li>
|
||
|
|
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
|
||
|
|
<li><a href="../../../index-files/index-1.html">Index</a></li>
|
||
|
|
<li><a href="../../../help-doc.html">Help</a></li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
<div class="subNav">
|
||
|
|
<ul class="navList">
|
||
|
|
<li><a href="../../../com/intellectualcrafters/json/CDL.html"
|
||
|
|
title="class in com.intellectualcrafters.json"><span class="strong">Prev Class</span></a></li>
|
||
|
|
<li><a href="../../../com/intellectualcrafters/json/CookieList.html"
|
||
|
|
title="class in com.intellectualcrafters.json"><span class="strong">Next Class</span></a></li>
|
||
|
|
</ul>
|
||
|
|
<ul class="navList">
|
||
|
|
<li><a href="../../../index.html?com/intellectualcrafters/json/Cookie.html" target="_top">Frames</a></li>
|
||
|
|
<li><a href="Cookie.html" target="_top">No Frames</a></li>
|
||
|
|
</ul>
|
||
|
|
<ul class="navList" id="allclasses_navbar_top">
|
||
|
|
<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
|
||
|
|
</ul>
|
||
|
|
<div>
|
||
|
|
<script type="text/javascript"><!--
|
||
|
|
allClassesLink = document.getElementById("allclasses_navbar_top");
|
||
|
|
if (window == top) {
|
||
|
|
allClassesLink.style.display = "block";
|
||
|
|
}
|
||
|
|
else {
|
||
|
|
allClassesLink.style.display = "none";
|
||
|
|
}
|
||
|
|
//-->
|
||
|
|
</script>
|
||
|
|
</div>
|
||
|
|
<div>
|
||
|
|
<ul class="subNavList">
|
||
|
|
<li>Summary: </li>
|
||
|
|
<li>Nested | </li>
|
||
|
|
<li>Field | </li>
|
||
|
|
<li><a href="#constructor_summary">Constr</a> | </li>
|
||
|
|
<li><a href="#method_summary">Method</a></li>
|
||
|
|
</ul>
|
||
|
|
<ul class="subNavList">
|
||
|
|
<li>Detail: </li>
|
||
|
|
<li>Field | </li>
|
||
|
|
<li><a href="#constructor_detail">Constr</a> | </li>
|
||
|
|
<li><a href="#method_detail">Method</a></li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
<a name="skip-navbar_top">
|
||
|
|
<!-- -->
|
||
|
|
</a></div>
|
||
|
|
<!-- ========= END OF TOP NAVBAR ========= -->
|
||
|
|
<!-- ======== START OF CLASS DATA ======== -->
|
||
|
|
<div class="header">
|
||
|
|
<div class="subTitle">com.intellectualcrafters.json</div>
|
||
|
|
<h2 title="Class Cookie" class="title">Class Cookie</h2>
|
||
|
|
</div>
|
||
|
|
<div class="contentContainer">
|
||
|
|
<ul class="inheritance">
|
||
|
|
<li>java.lang.Object</li>
|
||
|
|
<li>
|
||
|
|
<ul class="inheritance">
|
||
|
|
<li>com.intellectualcrafters.json.Cookie</li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<div class="description">
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<hr>
|
||
|
|
<br>
|
||
|
|
<pre>public class <span class="strong">Cookie</span>
|
||
|
|
extends java.lang.Object</pre>
|
||
|
|
<div class="block">Convert a web browser cookie specification to a JSONObject and back.
|
||
|
|
JSON and Cookies are both notations for name/value pairs.
|
||
|
|
</div>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
<div class="summary">
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList"><a name="constructor_summary">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
|
||
|
|
<h3>Constructor Summary</h3>
|
||
|
|
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0"
|
||
|
|
summary="Constructor Summary table, listing constructors, and an explanation">
|
||
|
|
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
|
||
|
|
<tr>
|
||
|
|
<th class="colOne" scope="col">Constructor and Description</th>
|
||
|
|
</tr>
|
||
|
|
<tr class="altColor">
|
||
|
|
<td class="colOne"><code><strong><a
|
||
|
|
href="../../../com/intellectualcrafters/json/Cookie.html#Cookie()">Cookie</a></strong>()</code>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<!-- ========== METHOD SUMMARY =========== -->
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList"><a name="method_summary">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
|
||
|
|
<h3>Method Summary</h3>
|
||
|
|
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0"
|
||
|
|
summary="Method Summary table, listing methods, and an explanation">
|
||
|
|
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
|
||
|
|
<tr>
|
||
|
|
<th class="colFirst" scope="col">Modifier and Type</th>
|
||
|
|
<th class="colLast" scope="col">Method and Description</th>
|
||
|
|
</tr>
|
||
|
|
<tr class="altColor">
|
||
|
|
<td class="colFirst"><code>static java.lang.String</code></td>
|
||
|
|
<td class="colLast"><code><strong><a
|
||
|
|
href="../../../com/intellectualcrafters/json/Cookie.html#escape(java.lang.String)">escape</a></strong>(java.lang.String string)</code>
|
||
|
|
|
||
|
|
<div class="block">Produce a copy of a string in which the characters '+', '%', '=',
|
||
|
|
';'
|
||
|
|
and control characters are replaced with "%hh".
|
||
|
|
</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="rowColor">
|
||
|
|
<td class="colFirst"><code>static <a
|
||
|
|
href="../../../com/intellectualcrafters/json/JSONObject.html"
|
||
|
|
title="class in com.intellectualcrafters.json">JSONObject</a></code></td>
|
||
|
|
<td class="colLast"><code><strong><a
|
||
|
|
href="../../../com/intellectualcrafters/json/Cookie.html#toJSONObject(java.lang.String)">toJSONObject</a></strong>(java.lang.String string)</code>
|
||
|
|
|
||
|
|
<div class="block">Convert a cookie specification string into a JSONObject.</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="altColor">
|
||
|
|
<td class="colFirst"><code>static java.lang.String</code></td>
|
||
|
|
<td class="colLast"><code><strong><a
|
||
|
|
href="../../../com/intellectualcrafters/json/Cookie.html#toString(com.intellectualcrafters.json.JSONObject)">toString</a></strong>(<a
|
||
|
|
href="../../../com/intellectualcrafters/json/JSONObject.html"
|
||
|
|
title="class in com.intellectualcrafters.json">JSONObject</a> jo)</code>
|
||
|
|
|
||
|
|
<div class="block">Convert a JSONObject into a cookie specification string.</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="rowColor">
|
||
|
|
<td class="colFirst"><code>static java.lang.String</code></td>
|
||
|
|
<td class="colLast"><code><strong><a
|
||
|
|
href="../../../com/intellectualcrafters/json/Cookie.html#unescape(java.lang.String)">unescape</a></strong>(java.lang.String string)</code>
|
||
|
|
|
||
|
|
<div class="block">Convert <code>%</code><i>hh</i> sequences to single characters,
|
||
|
|
and
|
||
|
|
convert plus to space.
|
||
|
|
</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
|
||
|
|
<h3>Methods inherited from class java.lang.Object</h3>
|
||
|
|
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait,
|
||
|
|
wait, wait</code></li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
<div class="details">
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList"><a name="constructor_detail">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
|
||
|
|
<h3>Constructor Detail</h3>
|
||
|
|
<a name="Cookie()">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockListLast">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>Cookie</h4>
|
||
|
|
<pre>public Cookie()</pre>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<!-- ============ METHOD DETAIL ========== -->
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList"><a name="method_detail">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
|
||
|
|
<h3>Method Detail</h3>
|
||
|
|
<a name="escape(java.lang.String)">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>escape</h4>
|
||
|
|
<pre>public static java.lang.String escape(java.lang.String string)</pre>
|
||
|
|
<div class="block">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.
|
||
|
|
</div>
|
||
|
|
<dl>
|
||
|
|
<dt><span class="strong">Parameters:</span></dt>
|
||
|
|
<dd><code>string</code> - The source string.</dd>
|
||
|
|
<dt><span class="strong">Returns:</span></dt>
|
||
|
|
<dd>The escaped result.</dd>
|
||
|
|
</dl>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<a name="toJSONObject(java.lang.String)">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>toJSONObject</h4>
|
||
|
|
<pre>public static <a href="../../../com/intellectualcrafters/json/JSONObject.html"
|
||
|
|
title="class in com.intellectualcrafters.json">JSONObject</a> toJSONObject(java.lang.String string)
|
||
|
|
throws <a href="../../../com/intellectualcrafters/json/JSONException.html"
|
||
|
|
title="class in com.intellectualcrafters.json">JSONException</a></pre>
|
||
|
|
<div class="block">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.
|
||
|
|
</div>
|
||
|
|
<dl>
|
||
|
|
<dt><span class="strong">Parameters:</span></dt>
|
||
|
|
<dd><code>string</code> - The cookie specification string.</dd>
|
||
|
|
<dt><span class="strong">Returns:</span></dt>
|
||
|
|
<dd>A JSONObject containing "name", "value", and possibly other
|
||
|
|
members.
|
||
|
|
</dd>
|
||
|
|
<dt><span class="strong">Throws:</span></dt>
|
||
|
|
<dd><code><a href="../../../com/intellectualcrafters/json/JSONException.html"
|
||
|
|
title="class in com.intellectualcrafters.json">JSONException</a></code>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<a name="toString(com.intellectualcrafters.json.JSONObject)">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>toString</h4>
|
||
|
|
<pre>public static java.lang.String toString(<a href="../../../com/intellectualcrafters/json/JSONObject.html"
|
||
|
|
title="class in com.intellectualcrafters.json">JSONObject</a> jo)
|
||
|
|
throws <a href="../../../com/intellectualcrafters/json/JSONException.html"
|
||
|
|
title="class in com.intellectualcrafters.json">JSONException</a></pre>
|
||
|
|
<div class="block">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.
|
||
|
|
</div>
|
||
|
|
<dl>
|
||
|
|
<dt><span class="strong">Parameters:</span></dt>
|
||
|
|
<dd><code>jo</code> - A JSONObject</dd>
|
||
|
|
<dt><span class="strong">Returns:</span></dt>
|
||
|
|
<dd>A cookie specification string</dd>
|
||
|
|
<dt><span class="strong">Throws:</span></dt>
|
||
|
|
<dd><code><a href="../../../com/intellectualcrafters/json/JSONException.html"
|
||
|
|
title="class in com.intellectualcrafters.json">JSONException</a></code>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<a name="unescape(java.lang.String)">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockListLast">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>unescape</h4>
|
||
|
|
<pre>public static java.lang.String unescape(java.lang.String string)</pre>
|
||
|
|
<div class="block">Convert <code>%</code><i>hh</i> sequences to single characters, and
|
||
|
|
convert plus to space.
|
||
|
|
</div>
|
||
|
|
<dl>
|
||
|
|
<dt><span class="strong">Parameters:</span></dt>
|
||
|
|
<dd><code>string</code> - A string that may contain <code>+</code>
|
||
|
|
|
||
|
|
<small>(plus)</small>
|
||
|
|
and <code>%</code><i>hh</i>
|
||
|
|
sequences.
|
||
|
|
</dd>
|
||
|
|
<dt><span class="strong">Returns:</span></dt>
|
||
|
|
<dd>The unescaped string.</dd>
|
||
|
|
</dl>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<!-- ========= END OF CLASS DATA ========= -->
|
||
|
|
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
||
|
|
<div class="bottomNav"><a name="navbar_bottom">
|
||
|
|
<!-- -->
|
||
|
|
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="navList" title="Navigation">
|
||
|
|
<li><a href="../../../overview-summary.html">Overview</a></li>
|
||
|
|
<li><a href="package-summary.html">Package</a></li>
|
||
|
|
<li class="navBarCell1Rev">Class</li>
|
||
|
|
<li><a href="package-tree.html">Tree</a></li>
|
||
|
|
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
|
||
|
|
<li><a href="../../../index-files/index-1.html">Index</a></li>
|
||
|
|
<li><a href="../../../help-doc.html">Help</a></li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
<div class="subNav">
|
||
|
|
<ul class="navList">
|
||
|
|
<li><a href="../../../com/intellectualcrafters/json/CDL.html"
|
||
|
|
title="class in com.intellectualcrafters.json"><span class="strong">Prev Class</span></a></li>
|
||
|
|
<li><a href="../../../com/intellectualcrafters/json/CookieList.html"
|
||
|
|
title="class in com.intellectualcrafters.json"><span class="strong">Next Class</span></a></li>
|
||
|
|
</ul>
|
||
|
|
<ul class="navList">
|
||
|
|
<li><a href="../../../index.html?com/intellectualcrafters/json/Cookie.html" target="_top">Frames</a></li>
|
||
|
|
<li><a href="Cookie.html" target="_top">No Frames</a></li>
|
||
|
|
</ul>
|
||
|
|
<ul class="navList" id="allclasses_navbar_bottom">
|
||
|
|
<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
|
||
|
|
</ul>
|
||
|
|
<div>
|
||
|
|
<script type="text/javascript"><!--
|
||
|
|
allClassesLink = document.getElementById("allclasses_navbar_bottom");
|
||
|
|
if (window == top) {
|
||
|
|
allClassesLink.style.display = "block";
|
||
|
|
}
|
||
|
|
else {
|
||
|
|
allClassesLink.style.display = "none";
|
||
|
|
}
|
||
|
|
//-->
|
||
|
|
</script>
|
||
|
|
</div>
|
||
|
|
<div>
|
||
|
|
<ul class="subNavList">
|
||
|
|
<li>Summary: </li>
|
||
|
|
<li>Nested | </li>
|
||
|
|
<li>Field | </li>
|
||
|
|
<li><a href="#constructor_summary">Constr</a> | </li>
|
||
|
|
<li><a href="#method_summary">Method</a></li>
|
||
|
|
</ul>
|
||
|
|
<ul class="subNavList">
|
||
|
|
<li>Detail: </li>
|
||
|
|
<li>Field | </li>
|
||
|
|
<li><a href="#constructor_detail">Constr</a> | </li>
|
||
|
|
<li><a href="#method_detail">Method</a></li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
<a name="skip-navbar_bottom">
|
||
|
|
<!-- -->
|
||
|
|
</a></div>
|
||
|
|
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
||
|
|
</body>
|
||
|
|
</html>
|