|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.python.core.PyObject
org.python.core.PyDictionary
public class PyDictionary
A builtin python dictionary.
Nested Class Summary |
---|
Nested classes/interfaces inherited from class org.python.core.PyObject |
---|
PyObject.ConversionException |
Nested classes/interfaces inherited from interface java.util.Map |
---|
java.util.Map.Entry<K,V> |
Field Summary | |
---|---|
static PyType |
TYPE
|
Constructor Summary | |
---|---|
PyDictionary()
Create an empty dictionary. |
|
PyDictionary(java.util.Map<PyObject,PyObject> t)
Create an new dictionary which is based on the hashtable. |
|
PyDictionary(PyObject[] elements)
Create a new dictionary with the element as content. |
|
PyDictionary(PyType subtype)
For derived types |
|
PyDictionary(PyType subtype,
java.util.Map<PyObject,PyObject> t)
Create an new dictionary which is based on the map and for derived types. |
Method Summary | |
---|---|
int |
__cmp__(PyObject ob_other)
Equivalent to the standard Python __cmp__ method. |
boolean |
__contains__(PyObject o)
Equivalent to the standard Python __contains__ method. |
void |
__delitem__(PyObject key)
Equivalent to the standard Python __delitem__ method. |
PyObject |
__eq__(PyObject ob_other)
Equivalent to the standard Python __eq__ method. |
PyObject |
__finditem__(int index)
A variant of the __finditem__ method which accepts a primitive int as the key. |
PyObject |
__finditem__(PyObject key)
Very similar to the standard Python __getitem__ method. |
PyObject |
__iter__()
Return an iterator that is used to iterate the element of this sequence. |
int |
__len__()
Equivalent to the standard Python __len__ method. |
PyObject |
__ne__(PyObject ob_other)
Equivalent to the standard Python __ne__ method. |
boolean |
__nonzero__()
Equivalent to the standard Python __nonzero__ method. |
void |
__setitem__(PyObject key,
PyObject value)
Equivalent to the standard Python __setitem__ method. |
void |
clear()
Remove all items from the dictionary. |
boolean |
containsKey(java.lang.Object key)
|
boolean |
containsValue(java.lang.Object value)
|
PyDictionary |
copy()
Return a shallow copy of the dictionary. |
java.util.Set |
entrySet()
|
static PyObject |
fromkeys(PyObject keys)
|
static PyObject |
fromkeys(PyObject keys,
PyObject value)
|
java.lang.Object |
get(java.lang.Object key)
|
PyObject |
get(PyObject key)
Return this[key] if the key exists in the mapping, None is returned otherwise. |
PyObject |
get(PyObject key,
PyObject default_object)
Return this[key] if the key exists in the mapping, default_object is returned otherwise. |
boolean |
has_key(PyObject key)
Return true if the key exist in the dictionary. |
int |
hashCode()
|
boolean |
isEmpty()
|
boolean |
isSequenceType()
|
PyList |
items()
Return a copy of the dictionarys list of (key, value) tuple pairs. |
PyObject |
iteritems()
Return an interator over (key, value) pairs. |
PyObject |
iterkeys()
Return an interator over (key, value) pairs. |
PyObject |
itervalues()
Return an interator over (key, value) pairs. |
PyList |
keys()
Return a copy of the dictionarys list of keys. |
java.util.Set |
keySet()
|
PyObject |
pop(PyObject key)
Return a value based on key from the dictionary. |
PyObject |
pop(PyObject key,
PyObject defaultValue)
Return a value based on key from the dictionary or default if that key is not found. |
PyObject |
popitem()
Return a random (key, value) tuple pair and remove the pair from the dictionary. |
java.lang.Object |
put(java.lang.Object key,
java.lang.Object value)
|
void |
putAll(java.util.Map map)
|
java.lang.Object |
putIfAbsent(java.lang.Object key,
java.lang.Object value)
|
java.lang.Object |
remove(java.lang.Object key)
|
boolean |
remove(java.lang.Object key,
java.lang.Object value)
|
java.lang.Object |
replace(java.lang.Object key,
java.lang.Object value)
|
boolean |
replace(java.lang.Object key,
java.lang.Object oldValue,
java.lang.Object newValue)
|
PyObject |
setdefault(PyObject key)
Return this[key] if the key exist, otherwise insert key with a None value and return None. |
PyObject |
setdefault(PyObject key,
PyObject failobj)
Return this[key] if the key exist, otherwise insert key with the value of failobj and return failobj |
int |
size()
|
java.lang.String |
toString()
|
void |
update(PyObject other)
Insert all the key:value pairs from d into
this dictionary. |
java.util.Collection |
values()
Return a copy of the dictionarys list of values. |
Methods inherited from class java.lang.Object |
---|
getClass, notify, notifyAll, wait, wait, wait |
Methods inherited from interface java.util.Map |
---|
equals |
Field Detail |
---|
public static final PyType TYPE
Constructor Detail |
---|
public PyDictionary()
public PyDictionary(PyType subtype)
subtype
- public PyDictionary(java.util.Map<PyObject,PyObject> t)
t
- the hashtable used. The supplied hashtable is used as
is and must only contain PyObject key:value pairs.public PyDictionary(PyType subtype, java.util.Map<PyObject,PyObject> t)
subtype
- t
- the hashtable used. The supplied hashtable is used as
is and must only contain PyObject key:value pairs.public PyDictionary(PyObject[] elements)
elements
- The initial elements that is inserted in the
dictionary. Even numbered elements are keys,
odd numbered elements are values.Method Detail |
---|
public static PyObject fromkeys(PyObject keys)
public static PyObject fromkeys(PyObject keys, PyObject value)
public int __len__()
PyObject
__len__
in class PyObject
public boolean __nonzero__()
PyObject
PyObject
is considered true.
__nonzero__
in class PyObject
public PyObject __finditem__(int index)
PyObject
int
as the key. By default, this method will call
__finditem__(PyObject key)
with the appropriate args.
The only reason to override this method is for performance.
__finditem__
in class PyObject
index
- the key to lookup in this sequence.
PyObject.__finditem__(PyObject)
public PyObject __finditem__(PyObject key)
PyObject
__finditem__
in class PyObject
key
- the key to lookup in this container
public void __setitem__(PyObject key, PyObject value)
PyObject
__setitem__
in class PyObject
key
- the key whose value will be setvalue
- the value to set this key topublic void __delitem__(PyObject key)
PyObject
__delitem__
in class PyObject
key
- the key to be removed from the containerpublic PyObject __iter__()
PyObject
If a PyObject subclass should support iteration based in the __finditem__() method, it must supply an implementation of __iter__() like this:
public PyObject __iter__() { return new PySequenceIter(this); }When iterating over a python sequence from java code, it should be done with code like this:
for (PyObject item : seq.asIterable()) { // Do somting with item }
__iter__
in class PyObject
public java.lang.String toString()
toString
in class PyObject
public PyObject __eq__(PyObject ob_other)
PyObject
__eq__
in class PyObject
ob_other
- the object to compare this with.
public PyObject __ne__(PyObject ob_other)
PyObject
__ne__
in class PyObject
ob_other
- the object to compare this with.
public int __cmp__(PyObject ob_other)
PyObject
__cmp__
in class PyObject
ob_other
- the object to compare this with.
public boolean has_key(PyObject key)
public boolean __contains__(PyObject o)
PyObject
__contains__
in class PyObject
o
- the element to search for in this container.
public PyObject get(PyObject key, PyObject default_object)
key
- the key to lookup in the dictionary.default_object
- the value to return if the key does not
exists in the mapping.public PyObject get(PyObject key)
key
- the key to lookup in the dictionary.public PyDictionary copy()
public void clear()
clear
in interface java.util.Map
public void update(PyObject other)
d
into
this dictionary.
public PyObject setdefault(PyObject key)
key
- the key to lookup in the dictionary.public PyObject setdefault(PyObject key, PyObject failobj)
key
- the key to lookup in the dictionary.failobj
- the default value to insert in the dictionary
if key does not already exist.public PyObject pop(PyObject key)
public PyObject pop(PyObject key, PyObject defaultValue)
public PyObject popitem()
public PyList items()
public PyList keys()
public PyObject iteritems()
public PyObject iterkeys()
public PyObject itervalues()
public int hashCode()
hashCode
in interface java.util.Map
hashCode
in class PyObject
public boolean isSequenceType()
isSequenceType
in class PyObject
public java.util.Set entrySet()
entrySet
in interface java.util.Map
Map.entrySet()
public java.util.Set keySet()
keySet
in interface java.util.Map
Map.keySet()
public java.util.Collection values()
values
in interface java.util.Map
public void putAll(java.util.Map map)
putAll
in interface java.util.Map
Map.putAll(Map map)
public java.lang.Object remove(java.lang.Object key)
remove
in interface java.util.Map
Map.remove(Object key)
public java.lang.Object put(java.lang.Object key, java.lang.Object value)
put
in interface java.util.Map
Map.put(Object key, Object value)
public java.lang.Object get(java.lang.Object key)
get
in interface java.util.Map
Map.get(Object key)
public boolean containsValue(java.lang.Object value)
containsValue
in interface java.util.Map
Map.containsValue(Object key)
public boolean containsKey(java.lang.Object key)
containsKey
in interface java.util.Map
Map.containsValue(Object key)
public boolean isEmpty()
isEmpty
in interface java.util.Map
java.util.Map#isEmpty(Object key)
public int size()
size
in interface java.util.Map
java.util.Map#size(Object key)
public java.lang.Object putIfAbsent(java.lang.Object key, java.lang.Object value)
putIfAbsent
in interface java.util.concurrent.ConcurrentMap
public boolean remove(java.lang.Object key, java.lang.Object value)
remove
in interface java.util.concurrent.ConcurrentMap
public boolean replace(java.lang.Object key, java.lang.Object oldValue, java.lang.Object newValue)
replace
in interface java.util.concurrent.ConcurrentMap
public java.lang.Object replace(java.lang.Object key, java.lang.Object value)
replace
in interface java.util.concurrent.ConcurrentMap
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |