Top Description Fields Constructors Methods
org.apache.http.impl.cookie

public Class BasicClientCookie2

extends BasicClientCookie
implements SetCookie2
Class Inheritance
All Implemented Interfaces
org.apache.http.cookie.SetCookie2, org.apache.http.cookie.SetCookie, org.apache.http.cookie.Cookie
Imports
java.util.Date, org.apache.http.cookie.SetCookie2

Default implementation of SetCookie2.
Since
4.0

Field Summary

Modifier and TypeField and Description
private String
private boolean
private int[]
private static final long

Constructor Summary

AccessConstructor and Description
public
BasicClientCookie2(final String
The name.
name
,
final String
The value.
value
)

Default Constructor taking a name and a value.

Method Summary

Modifier and TypeMethod and Description
public Object
clone()

Overrides org.apache.http.impl.cookie.BasicClientCookie.clone.

Creates and returns a copy of this object.
public String
getCommentURL()

Overrides org.apache.http.impl.cookie.BasicClientCookie.getCommentURL.

Implements org.apache.http.cookie.Cookie.getCommentURL.

If a user agent (web browser) presents this cookie to a user, the cookie's purpose will be described by the information at this URL.
public int[]
public boolean
isExpired(final Date
Current time
date
)

Overrides org.apache.http.impl.cookie.BasicClientCookie.isExpired.

Implements org.apache.http.cookie.Cookie.isExpired.

Returns true if this cookie has expired.
public boolean
isPersistent()

Overrides org.apache.http.impl.cookie.BasicClientCookie.isPersistent.

Implements org.apache.http.cookie.Cookie.isPersistent.

Returns false if the cookie should be discarded at the end of the "session"; true otherwise.
public void
setCommentURL(final String commentURL)

Implements org.apache.http.cookie.SetCookie2.setCommentURL.

If a user agent (web browser) presents this cookie to a user, the cookie's purpose will be described by the information at this URL.
public void
setDiscard(final boolean discard)

Implements org.apache.http.cookie.SetCookie2.setDiscard.

Set the Discard attribute.
public void
setPorts(final int[] ports)

Implements org.apache.http.cookie.SetCookie2.setPorts.

Sets the Port attribute.
Inherited from org.apache.http.impl.cookie.BasicClientCookie:
containsAttributegetAttributegetCommentgetCreationDategetDomaingetExpiryDategetNamegetPathgetValuegetVersionisSecureremoveAttributesetAttributesetCommentsetCreationDatesetDomainsetExpiryDatesetPathsetSecuresetValuesetVersiontoString

Field Detail

commentURLback to summary
private String commentURL
discardback to summary
private boolean discard
portsback to summary
private int[] ports
serialVersionUIDback to summary
private static final long serialVersionUID

Hides org.apache.http.impl.cookie.BasicClientCookie.serialVersionUID.

Constructor Detail

BasicClientCookie2back to summary
public BasicClientCookie2(final String name, final String value)

Default Constructor taking a name and a value. The value may be null.

Parameters
name:String

The name.

value:String

The value.

Method Detail

cloneback to summary
public Object clone() throws CloneNotSupportedException

Overrides org.apache.http.impl.cookie.BasicClientCookie.clone.

Doc from java.lang.Object.clone.

Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object x, the expression:

x.clone() != x
will be true, and that the expression:
x.clone().getClass() == x.getClass()
will be true, but these are not absolute requirements. While it is typically the case that:
x.clone().equals(x)
will be 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.

Returns:Object

a clone of this instance.

Annotations
@Override
Exceptions
CloneNotSupportedException:
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.
getCommentURLback to summary
public String getCommentURL()

Overrides org.apache.http.impl.cookie.BasicClientCookie.getCommentURL.

Implements org.apache.http.cookie.Cookie.getCommentURL.

Doc from org.apache.http.cookie.Cookie.getCommentURL.

If a user agent (web browser) presents this cookie to a user, the cookie's purpose will be described by the information at this URL.

Annotations
@Override
getPortsback to summary
public int[] getPorts()

Overrides org.apache.http.impl.cookie.BasicClientCookie.getPorts.

Implements org.apache.http.cookie.Cookie.getPorts.

Doc from org.apache.http.cookie.Cookie.getPorts.

Get the Port attribute. It restricts the ports to which a cookie may be returned in a Cookie request header.

Annotations
@Override
isExpiredback to summary
public boolean isExpired(final Date date)

Overrides org.apache.http.impl.cookie.BasicClientCookie.isExpired.

Implements org.apache.http.cookie.Cookie.isExpired.

Doc from org.apache.http.cookie.Cookie.isExpired.

Returns true if this cookie has expired.

Parameters
date:Date

Current time

Returns:boolean

true if the cookie has expired.

Annotations
@Override
isPersistentback to summary
public boolean isPersistent()

Overrides org.apache.http.impl.cookie.BasicClientCookie.isPersistent.

Implements org.apache.http.cookie.Cookie.isPersistent.

Doc from org.apache.http.cookie.Cookie.isPersistent.

Returns false if the cookie should be discarded at the end of the "session"; true otherwise.

Returns:boolean

false if the cookie should be discarded at the end of the "session"; true otherwise

Annotations
@Override
setCommentURLback to summary
public void setCommentURL(final String commentURL)

Implements org.apache.http.cookie.SetCookie2.setCommentURL.

Doc from org.apache.http.cookie.SetCookie2.setCommentURL.

If a user agent (web browser) presents this cookie to a user, the cookie's purpose will be described by the information at this URL.

Annotations
@Override
setDiscardback to summary
public void setDiscard(final boolean discard)

Implements org.apache.http.cookie.SetCookie2.setDiscard.

Doc from org.apache.http.cookie.SetCookie2.setDiscard.

Set the Discard attribute.

Note

Discard attribute overrides Max-age.

Annotations
@Override
setPortsback to summary
public void setPorts(final int[] ports)

Implements org.apache.http.cookie.SetCookie2.setPorts.

Doc from org.apache.http.cookie.SetCookie2.setPorts.

Sets the Port attribute. It restricts the ports to which a cookie may be returned in a Cookie request header.

Annotations
@Override