com.sonalb.net.http.cookie
Class CookieJar

java.lang.Object
  |
  +--com.sonalb.net.http.cookie.CookieJar

All Implemented Interfaces:

Collection, Serializable

public class CookieJar

extends Object

implements Collection, Serializable

Container for Cookie objects. Each CookieJar is independent of any request. This means that a single CookieJar can hold all the cookies for a number of requests and servers.

Author:

Sonal Bansal

See Also:

Serialized Form

Constructor Summary

CookieJar()
Creates an empty CookieJar.

CookieJar(Collection c)
Creates a CookieJar, and populates it with Cookies from input Collection.

Method Summary

boolean	add(Object o) Ensures that this collection contains the specified element (optional operation).
boolean	addAll(Collection c) Adds all of the elements in the specified collection to this collection (optional operation).
void	clear() Removes all of the elements from this collection (optional operation).
boolean	contains(Object o) Returns true if this collection contains the specified element.
boolean	containsAll(Collection c) Returns true if this collection contains all of the elements in the specified collection.
CookieJar	getCookies(CookieMatcher cm) Gets all Cookies that match the given CookieMatcher.
CookieJar	getCookies(String cookieName) Gets all Cookies with the given name.
CookieJar	getVersionCookies(String ver) Gets all Cookies having given version.
boolean	isEmpty() Returns true if this collection contains no elements.
Iterator	iterator() Returns an iterator over the elements in this collection.
boolean	remove(Object o) Removes a single instance of the specified element from this collection, if it is present (optional operation).
boolean	removeAll(Collection c) Removes all this collection's elements that are also contained in the specified collection (optional operation).
void	removeCookies(CookieMatcher cm) Removes all cookies that match the given CookieMatcher.
boolean	retainAll(Collection c) Retains only the elements in this collection that are contained in the specified collection (optional operation).
int	size() Returns the number of elements in this collection.
Object[]	toArray() Returns an array containing all of the elements in this collection.
Object[]	toArray(Object[] array) Returns an array containing all of the elements in this collection whose runtime type is that of the specified array.
String	toString() Returns a string representation of the object.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Collection

equals, hashCode

Constructor Detail

CookieJar

public CookieJar()

Creates an empty CookieJar.

CookieJar

public CookieJar(Collection c)

Creates a CookieJar, and populates it with Cookies from input Collection. All the objects in the input Collection NEED NOT be Cookie objects.

Parameters:

c - the input Collection

Method Detail

add

public boolean add(Object o)

Description copied from interface: Collection

Ensures that this collection contains the specified element (optional operation). Returns true if this collection changed as a result of the call. (Returns false if this collection does not permit duplicates and already contains the specified element.)

Collections that support this operation may place limitations on what elements may be added to this collection. In particular, some collections will refuse to add null elements, and others will impose restrictions on the type of elements that may be added. Collection classes should clearly specify in their documentation any restrictions on what elements may be added.

If a collection refuses to add a particular element for any reason other than that it already contains the element, it must throw an exception (rather than returning false). This preserves the invariant that a collection always contains the specified element after this call returns.

Specified by:

add in interface Collection

Following copied from interface: java.util.Collection

Parameters:

o - element whose presence in this collection is to be ensured.

Returns:

true if this collection changed as a result of the call

Throws:

UnsupportedOperationException - add is not supported by this collection.

ClassCastException - class of the specified element prevents it from being added to this collection.

IllegalArgumentException - some aspect of this element prevents it from being added to this collection.

addAll

public boolean addAll(Collection c)

Description copied from interface: Collection

Adds all of the elements in the specified collection to this collection (optional operation). The behavior of this operation is undefined if the specified collection is modified while the operation is in progress. (This implies that the behavior of this call is undefined if the specified collection is this collection, and this collection is nonempty.)

Specified by:

addAll in interface Collection

Following copied from interface: java.util.Collection

Parameters:

c - elements to be inserted into this collection.

Returns:

true if this collection changed as a result of the call

Throws:

UnsupportedOperationException - if this collection does not support the addAll method.

ClassCastException - if the class of an element of the specified collection prevents it from being added to this collection.

IllegalArgumentException - some aspect of an element of the specified collection prevents it from being added to this collection.

See Also:

Collection.add(Object)

iterator

public Iterator iterator()

Description copied from interface: Collection

Returns an iterator over the elements in this collection. There are no guarantees concerning the order in which the elements are returned (unless this collection is an instance of some class that provides a guarantee).

Specified by:

iterator in interface Collection

Following copied from interface: java.util.Collection

Returns:

an Iterator over the elements in this collection

contains

public boolean contains(Object o)

Description copied from interface: Collection

Returns true if this collection contains the specified element. More formally, returns true if and only if this collection contains at least one element e such that (o==null ? e==null : o.equals(e)).

Specified by:

contains in interface Collection

Following copied from interface: java.util.Collection

Parameters:

o - element whose presence in this collection is to be tested.

Returns:

true if this collection contains the specified element

containsAll

public boolean containsAll(Collection c)

Description copied from interface: Collection

Returns true if this collection contains all of the elements in the specified collection.

Specified by:

containsAll in interface Collection

Following copied from interface: java.util.Collection

Parameters:

c - collection to be checked for containment in this collection.

Returns:

true if this collection contains all of the elements in the specified collection

See Also:

Collection.contains(Object)

toArray

public Object[] toArray()

Description copied from interface: Collection

Returns an array containing all of the elements in this collection. If the collection makes any guarantees as to what order its elements are returned by its iterator, this method must return the elements in the same order.

The returned array will be "safe" in that no references to it are maintained by this collection. (In other words, this method must allocate a new array even if this collection is backed by an array). The caller is thus free to modify the returned array.

This method acts as bridge between array-based and collection-based APIs.

Specified by:

toArray in interface Collection

Following copied from interface: java.util.Collection

Returns:

an array containing all of the elements in this collection

toArray

public Object[] toArray(Object[] array)

Description copied from interface: Collection

Returns an array containing all of the elements in this collection whose runtime type is that of the specified array. If the collection fits in the specified array, it is returned therein. Otherwise, a new array is allocated with the runtime type of the specified array and the size of this collection.

If this collection fits in the specified array with room to spare (i.e., the array has more elements than this collection), the element in the array immediately following the end of the collection is set to null. This is useful in determining the length of this collection only if the caller knows that this collection does not contain any null elements.)

If this collection makes any guarantees as to what order its elements are returned by its iterator, this method must return the elements in the same order.

Like the toArray method, this method acts as bridge between array-based and collection-based APIs. Further, this method allows precise control over the runtime type of the output array, and may, under certain circumstances, be used to save allocation costs

Suppose l is a List known to contain only strings. The following code can be used to dump the list into a newly allocated array of String:

     String[] x = (String[]) v.toArray(new String[0]);
 

Note that toArray(new Object[0]) is identical in function to toArray().

Specified by:

toArray in interface Collection

Following copied from interface: java.util.Collection

Parameters:

a - the array into which the elements of this collection are to be stored, if it is big enough; otherwise, a new array of the same runtime type is allocated for this purpose.

Returns:

an array containing the elements of this collection

Throws:

ArrayStoreException - the runtime type of the specified array is not a supertype of the runtime type of every element in this collection.

clear

public void clear()

Description copied from interface: Collection

Removes all of the elements from this collection (optional operation). This collection will be empty after this method returns unless it throws an exception.

Specified by:

clear in interface Collection

Following copied from interface: java.util.Collection

Throws:

UnsupportedOperationException - if the clear method is not supported by this collection.

removeAll

public boolean removeAll(Collection c)

Description copied from interface: Collection

Removes all this collection's elements that are also contained in the specified collection (optional operation). After this call returns, this collection will contain no elements in common with the specified collection.

Specified by:

removeAll in interface Collection

Following copied from interface: java.util.Collection

Parameters:

c - elements to be removed from this collection.

Returns:

true if this collection changed as a result of the call

Throws:

UnsupportedOperationException - if the removeAll method is not supported by this collection.

See Also:

Collection.remove(Object), Collection.contains(Object)

retainAll

public boolean retainAll(Collection c)

Description copied from interface: Collection

Retains only the elements in this collection that are contained in the specified collection (optional operation). In other words, removes from this collection all of its elements that are not contained in the specified collection.

Specified by:

retainAll in interface Collection

Following copied from interface: java.util.Collection

Parameters:

c - elements to be retained in this collection.

Returns:

true if this collection changed as a result of the call

Throws:

UnsupportedOperationException - if the retainAll method is not supported by this Collection.

See Also:

Collection.remove(Object), Collection.contains(Object)

remove

public boolean remove(Object o)

Description copied from interface: Collection

Removes a single instance of the specified element from this collection, if it is present (optional operation). More formally, removes an element e such that (o==null ? e==null : o.equals(e)), if this collection contains one or more such elements. Returns true if this collection contained the specified element (or equivalently, if this collection changed as a result of the call).

Specified by:

remove in interface Collection

Following copied from interface: java.util.Collection

Parameters:

o - element to be removed from this collection, if present.

Returns:

true if this collection changed as a result of the call

Throws:

UnsupportedOperationException - remove is not supported by this collection.

removeCookies

public void removeCookies(CookieMatcher cm)

Removes all cookies that match the given CookieMatcher.

Parameters:

cm - the CookieMatcher

size

public int size()

Description copied from interface: Collection

Returns the number of elements in this collection. If this collection contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.

Specified by:

size in interface Collection

Following copied from interface: java.util.Collection

Returns:

the number of elements in this collection

isEmpty

public boolean isEmpty()

Description copied from interface: Collection

Returns true if this collection contains no elements.

Specified by:

isEmpty in interface Collection

Following copied from interface: java.util.Collection

Returns:

true if this collection contains no elements

getCookies

public CookieJar getCookies(CookieMatcher cm)

Gets all Cookies that match the given CookieMatcher.

Parameters:

cm - the CookieMatcher

Returns:

the CookieJar with matching cookies; always non-null

getCookies

public CookieJar getCookies(String cookieName)

Gets all Cookies with the given name.

Parameters:

cookieName - the cookie name

Returns:

the CookieJar with matching cookies; always non-null

getVersionCookies

public CookieJar getVersionCookies(String ver)

Gets all Cookies having given version.

Parameters:

ver - the version

Returns:

the CookieJar with Cookies; always non-null

toString

public String toString()

Description copied from class: Object

Returns a string representation of the object. In general, the toString 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())
 

Overrides:

toString in class Object

Following copied from class: java.lang.Object

Returns:

a string representation of the object.