BasicClientCookieHC4 (Apache HttpClient for Android 4.3.5.1 API)

java.lang.Object
- org.apache.http.impl.cookie.BasicClientCookieHC4

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, org.apache.http.cookie.ClientCookie, org.apache.http.cookie.Cookie, org.apache.http.cookie.SetCookie

Direct Known Subclasses:

BasicClientCookie2HC4
```
@NotThreadSafe
public class BasicClientCookieHC4
extends java.lang.Object
implements org.apache.http.cookie.SetCookie, org.apache.http.cookie.ClientCookie, java.lang.Cloneable, java.io.Serializable
```
Default implementation of SetCookie.

Since:

4.0

See Also:
Serialized Form

Field Summary
- Fields inherited from interface org.apache.http.cookie.ClientCookie
  COMMENT_ATTR, COMMENTURL_ATTR, DISCARD_ATTR, DOMAIN_ATTR, EXPIRES_ATTR, MAX_AGE_ATTR, PATH_ATTR, PORT_ATTR, SECURE_ATTR, VERSION_ATTR

Constructor Summary

Constructors
Constructor and Description

BasicClientCookieHC4(java.lang.String name, java.lang.String value)
Default Constructor taking a name and a value.

Constructors
Constructor and Description
`BasicClientCookieHC4(java.lang.String name, java.lang.String value)` Default Constructor taking a name and a value.

Method Summary

Methods
Modifier and Type	Method and Description
`java.lang.Object`	`clone()`
`boolean`	`containsAttribute(java.lang.String name)`
`java.lang.String`	`getAttribute(java.lang.String name)`
`java.lang.String`	`getComment()` Returns the comment describing the purpose of this cookie, or `null` if no such comment has been defined.
`java.lang.String`	`getCommentURL()` Returns null.
`java.lang.String`	`getDomain()` Returns domain attribute of the cookie.
`java.util.Date`	`getExpiryDate()` Returns the expiration `Date` of the cookie, or `null` if none exists.
`java.lang.String`	`getName()` Returns the name.
`java.lang.String`	`getPath()` Returns the path attribute of the cookie
`int[]`	`getPorts()` Returns null.
`java.lang.String`	`getValue()` Returns the value.
`int`	`getVersion()` Returns the version of the cookie specification to which this cookie conforms.
`boolean`	`isExpired(java.util.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()`
`void`	`setAttribute(java.lang.String name, java.lang.String value)`
`void`	`setComment(java.lang.String comment)` If a user agent (web browser) presents this cookie to a user, the cookie's purpose will be described using this comment.
`void`	`setDomain(java.lang.String domain)` Sets the domain attribute.
`void`	`setExpiryDate(java.util.Date expiryDate)` Sets expiration date.
`void`	`setPath(java.lang.String path)` Sets the path attribute.
`void`	`setSecure(boolean secure)` Sets the secure attribute of the cookie.
`void`	`setValue(java.lang.String value)` Sets the value
`void`	`setVersion(int version)` Sets the version of the cookie specification to which this cookie conforms.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - BasicClientCookieHC4
```
public BasicClientCookieHC4(java.lang.String name,
                    java.lang.String value)
```
    Default Constructor taking a name and a value. The value may be null.
    
    Parameters:
    name - The name.
    value - The value.
- Method Detail
  - getName
```
public java.lang.String getName()
```
    Returns the name.
    
    Specified by:
    
    getName in interface org.apache.http.cookie.Cookie
    
    Returns:
    String name The name
  - getValue
```
public java.lang.String getValue()
```
    Returns the value.
    
    Specified by:
    
    getValue in interface org.apache.http.cookie.Cookie
    
    Returns:
    String value The current value.
  - setValue
```
public void setValue(java.lang.String value)
```
    Sets the value
    
    Specified by:
    
    setValue in interface org.apache.http.cookie.SetCookie
    
    Parameters:
    value -
  - getComment
```
public java.lang.String getComment()
```
    Returns the comment describing the purpose of this cookie, or null if no such comment has been defined.
    
    Specified by:
    
    getComment in interface org.apache.http.cookie.Cookie
    
    Returns:
    comment
    See Also:
    setComment(String)
  - setComment
```
public void setComment(java.lang.String comment)
```
    If a user agent (web browser) presents this cookie to a user, the cookie's purpose will be described using this comment.
    
    Specified by:
    
    setComment in interface org.apache.http.cookie.SetCookie
    
    Parameters:
    comment -
    See Also:
    getComment()
  - getCommentURL
```
public java.lang.String getCommentURL()
```
    Returns null. Cookies prior to RFC2965 do not set this attribute
    
    Specified by:
    
    getCommentURL in interface org.apache.http.cookie.Cookie
  - getExpiryDate
```
public java.util.Date getExpiryDate()
```
    Returns the expiration 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.
    
    Specified by:
    
    getExpiryDate in interface org.apache.http.cookie.Cookie
    
    Returns:
    Expiration Date, or null.
    See Also:
    setExpiryDate(java.util.Date)
  - setExpiryDate
```
public void setExpiryDate(java.util.Date expiryDate)
```
    Sets expiration date.
    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.
    
    Specified by:
    
    setExpiryDate in interface org.apache.http.cookie.SetCookie
    
    Parameters:
    expiryDate - the Date after which this cookie is no longer valid.
    See Also:
    getExpiryDate()
  - isPersistent
```
public boolean isPersistent()
```
    Returns false if the cookie should be discarded at the end of the "session"; true otherwise.
    
    Specified by:
    
    isPersistent in interface org.apache.http.cookie.Cookie
    
    Returns:
    false if the cookie should be discarded at the end of the "session"; true otherwise
  - getDomain
```
public java.lang.String getDomain()
```
    Returns domain attribute of the cookie.
    
    Specified by:
    
    getDomain in interface org.apache.http.cookie.Cookie
    
    Returns:
    the value of the domain attribute
    See Also:
    setDomain(java.lang.String)
  - setDomain
```
public void setDomain(java.lang.String domain)
```
    Sets the domain attribute.
    
    Specified by:
    
    setDomain in interface org.apache.http.cookie.SetCookie
    
    Parameters:
    domain - The value of the domain attribute
    See Also:
    getDomain()
  - getPath
```
public java.lang.String getPath()
```
    Returns the path attribute of the cookie
    
    Specified by:
    
    getPath in interface org.apache.http.cookie.Cookie
    
    Returns:
    The value of the path attribute.
    See Also:
    setPath(java.lang.String)
  - setPath
```
public void setPath(java.lang.String path)
```
    Sets the path attribute.
    
    Specified by:
    
    setPath in interface org.apache.http.cookie.SetCookie
    
    Parameters:
    path - The value of the path attribute
    See Also:
    getPath()
  - isSecure
```
public boolean isSecure()
```
    Specified by:
    
    isSecure in interface org.apache.http.cookie.Cookie
    
    Returns:
    true if this cookie should only be sent over secure connections.
    See Also:
    setSecure(boolean)
  - setSecure
```
public void setSecure(boolean secure)
```
    Sets the secure attribute of the cookie.
    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.
    
    Specified by:
    
    setSecure in interface org.apache.http.cookie.SetCookie
    
    Parameters:
    secure - The value of the secure attribute
    See Also:
    isSecure()
  - getPorts
```
public int[] getPorts()
```
    Returns null. Cookies prior to RFC2965 do not set this attribute
    
    Specified by:
    
    getPorts in interface org.apache.http.cookie.Cookie
  - getVersion
```
public int getVersion()
```
    Returns the version of the cookie specification to which this cookie conforms.
    
    Specified by:
    
    getVersion in interface org.apache.http.cookie.Cookie
    
    Returns:
    the version of the cookie.
    See Also:
    setVersion(int)
  - setVersion
```
public void setVersion(int version)
```
    Sets the version of the cookie specification to which this cookie conforms.
    
    Specified by:
    
    setVersion in interface org.apache.http.cookie.SetCookie
    
    Parameters:
    version - the version of the cookie.
    See Also:
    getVersion()
  - isExpired
```
public boolean isExpired(java.util.Date date)
```
    Returns true if this cookie has expired.
    
    Specified by:
    
    isExpired in interface org.apache.http.cookie.Cookie
    
    Parameters:
    date - Current time
    
    Returns:
    true if the cookie has expired.
  - setAttribute
```
public void setAttribute(java.lang.String name,
                java.lang.String value)
```
  - getAttribute
```
public java.lang.String getAttribute(java.lang.String name)
```
    Specified by:
    
    getAttribute in interface org.apache.http.cookie.ClientCookie
  - containsAttribute
```
public boolean containsAttribute(java.lang.String name)
```
    Specified by:
    
    containsAttribute in interface org.apache.http.cookie.ClientCookie
  - clone
```
public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException
```
    Overrides:
    
    clone in class java.lang.Object
    
    Throws:
    
    java.lang.CloneNotSupportedException
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class BasicClientCookieHC4

Field Summary

Fields inherited from interface org.apache.http.cookie.ClientCookie

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BasicClientCookieHC4

Method Detail

getName

getValue

setValue

getComment

setComment

getCommentURL

getExpiryDate

setExpiryDate

isPersistent

getDomain

setDomain

getPath

setPath

isSecure

setSecure

getPorts

getVersion

setVersion

isExpired

setAttribute

getAttribute

containsAttribute

clone

toString