public final class BasicClientCookie extends Object implements SetCookie, Cloneable, Serializable
SetCookie.DOMAIN_ATTR, EXPIRES_ATTR, MAX_AGE_ATTR, PATH_ATTR, SECURE_ATTR| Constructor and Description |
|---|
BasicClientCookie(String name,
String value)
Default Constructor taking a name and a value.
|
| Modifier and Type | Method and Description |
|---|---|
Object |
clone()
Creates and returns a copy of this object.
|
boolean |
containsAttribute(String name) |
String |
getAttribute(String name) |
Date |
getCreationDate()
Returns creation time of the cookie.
|
String |
getDomain()
Returns domain attribute of the cookie.
|
Date |
getExpiryDate()
Returns the expiration
Date of the cookie, or null
if none exists. |
String |
getName()
Returns the name.
|
String |
getPath()
Returns the path attribute of the cookie
|
String |
getValue()
Returns the value.
|
boolean |
isExpired(Date date)
Returns true if this cookie has expired.
|
boolean |
isPersistent()
Returns
false if the cookie should be discarded at the end
of the "session"; true otherwise. |
boolean |
isSecure()
Indicates whether this cookie requires a secure connection.
|
boolean |
removeAttribute(String name) |
void |
setAttribute(String name,
String value) |
void |
setCreationDate(Date creationDate) |
void |
setDomain(String domain)
Sets the domain attribute.
|
void |
setExpiryDate(Date expiryDate)
Sets expiration date.
|
void |
setPath(String path)
Sets the path attribute.
|
void |
setSecure(boolean secure)
Sets the secure attribute of the cookie.
|
void |
setValue(String value)
Sets the value
|
String |
toString()
Returns a string representation of the object.
|
public Object clone() throws CloneNotSupportedException
Objectx, the expression: will be true, and that the expression:x.clone() != x
will bex.clone().getClass() == x.getClass()
true, but these are not absolute requirements. While it is
typically the case that: will bex.clone().equals(x)
true, this is not an absolute requirement.
By convention, the returned object should be obtained by calling super.clone. If a class
and all of its superclasses (except Object) obey this convention, it will be the case
that x.clone().getClass() == x.getClass().
By convention, the object returned by this method should be independent of this object (which is
being cloned). To achieve this independence, it may be necessary to modify one or more fields of
the object returned by super.clone before returning it. Typically, this means copying any
mutable objects that comprise the internal "deep structure" of the object being cloned and
replacing the references to these objects with references to the copies. If a class contains only
primitive fields or references to immutable objects, then it is usually the case that no fields
in the object returned by super.clone need to be modified.
The method clone for class Object performs a specific cloning operation. First,
if the class of this object does not implement the interface Cloneable, then a
CloneNotSupportedException is thrown. Note that all arrays are considered to implement
the interface Cloneable and that the return type of the clone method of an array
type T[] is T[] where T is any reference or primitive type. Otherwise, this
method creates a new instance of the class of this object and initializes all its fields with
exactly the contents of the corresponding fields of this object, as if by assignment; the
contents of the fields are not themselves cloned. Thus, this method performs a "shallow copy" of
this object, not a "deep copy" operation.
The class Object does not itself implement the interface Cloneable, so calling
the clone method on an object whose class is Object will result in throwing an
exception at run time.
clone in class ObjectCloneNotSupportedException - if the object's class does not support the Cloneable interface. Subclasses
that override the clone method can also throw this exception to indicate that
an instance cannot be cloned.Cloneablepublic boolean containsAttribute(String name)
containsAttribute in interface Cookiepublic String getAttribute(String name)
getAttribute in interface Cookiepublic Date getCreationDate()
CookiegetCreationDate in interface Cookiepublic String getDomain()
getDomain in interface CookiesetDomain(java.lang.String)public Date getExpiryDate()
Date of the cookie, or null
if none exists.
Note: the object returned by this method is considered immutable. Changing it (e.g. using setTime()) could result in undefined behaviour. Do so at your peril.
getExpiryDate in interface CookieDate, or null.setExpiryDate(java.util.Date)public String getName()
public String getPath()
getPath in interface CookiesetPath(java.lang.String)public String getValue()
public boolean isExpired(Date date)
public boolean isPersistent()
false if the cookie should be discarded at the end
of the "session"; true otherwise.isPersistent in interface Cookiefalse if the cookie should be discarded at the end
of the "session"; true otherwisepublic boolean isSecure()
CookieisSecure in interface Cookietrue if this cookie should only be sent over secure connections.setSecure(boolean)public boolean removeAttribute(String name)
public void setCreationDate(Date creationDate)
public void setDomain(String domain)
setDomain in interface SetCookiedomain - The value of the domain attributegetDomain()public void setExpiryDate(Date expiryDate)
Note: the object returned by this method is considered immutable. Changing it (e.g. using setTime()) could result in undefined behaviour. Do so at your peril.
setExpiryDate in interface SetCookieexpiryDate - the Date after which this cookie is no longer valid.getExpiryDate()public void setPath(String path)
public void setSecure(boolean secure)
When true the cookie should only be sent
using a secure protocol (https). This should only be set when
the cookie's originating server used a secure protocol to set the
cookie's value.
setSecure in interface SetCookiesecure - The value of the secure attributeisSecure()public void setValue(String value)
public String toString()
ObjecttoString method returns a
string that "textually represents" this object. The result should be a concise but informative
representation that is easy for a person to read. It is recommended that all subclasses override
this method.
The toString method for class Object returns a string consisting of the name of
the class of which the object is an instance, the at-sign character `@', and the unsigned
hexadecimal representation of the hash code of the object. In other words, this method returns a
string equal to the value of:
getClass().getName() + '@' + Integer.toHexString(hashCode())