|
jCookie v0.8b | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.sonalb.net.http.cookie.CookieJar
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.
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 |
public CookieJar()
public CookieJar(Collection c)
c
- the input CollectionMethod Detail |
public boolean add(Object o)
Collection
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.
add
in interface Collection
java.util.Collection
o
- element whose presence in this collection is to be ensured.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.public boolean addAll(Collection c)
Collection
addAll
in interface Collection
java.util.Collection
c
- elements to be inserted into this collection.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.Collection.add(Object)
public Iterator iterator()
Collection
iterator
in interface Collection
java.util.Collection
public boolean contains(Object o)
Collection
contains
in interface Collection
java.util.Collection
o
- element whose presence in this collection is to be tested.public boolean containsAll(Collection c)
Collection
containsAll
in interface Collection
java.util.Collection
c
- collection to be checked for containment in this collection.Collection.contains(Object)
public Object[] toArray()
Collection
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.
toArray
in interface Collection
java.util.Collection
public Object[] toArray(Object[] array)
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().
toArray
in interface Collection
java.util.Collection
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.ArrayStoreException
- the runtime type of the specified array is
not a supertype of the runtime type of every element in this
collection.public void clear()
Collection
clear
in interface Collection
java.util.Collection
UnsupportedOperationException
- if the clear method is
not supported by this collection.public boolean removeAll(Collection c)
Collection
removeAll
in interface Collection
java.util.Collection
c
- elements to be removed from this collection.UnsupportedOperationException
- if the removeAll method
is not supported by this collection.Collection.remove(Object)
,
Collection.contains(Object)
public boolean retainAll(Collection c)
Collection
retainAll
in interface Collection
java.util.Collection
c
- elements to be retained in this collection.UnsupportedOperationException
- if the retainAll method
is not supported by this Collection.Collection.remove(Object)
,
Collection.contains(Object)
public boolean remove(Object o)
Collection
remove
in interface Collection
java.util.Collection
o
- element to be removed from this collection, if present.UnsupportedOperationException
- remove is not supported by this
collection.public void removeCookies(CookieMatcher cm)
cm
- the CookieMatcherpublic int size()
Collection
size
in interface Collection
java.util.Collection
public boolean isEmpty()
Collection
isEmpty
in interface Collection
java.util.Collection
public CookieJar getCookies(CookieMatcher cm)
cm
- the CookieMatcherpublic CookieJar getCookies(String cookieName)
cookieName
- the cookie namepublic CookieJar getVersionCookies(String ver)
ver
- the versionpublic String toString()
Object
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())
toString
in class Object
java.lang.Object
|
Copyright (c) 2001-2002 Sonal Bansal | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |