Class AbstractMutableJythonMap
- java.lang.Object
-
- org.python.core.PyObject
-
- com.inductiveautomation.ignition.common.script.abc.AbstractJythonMap
-
- com.inductiveautomation.ignition.common.script.abc.AbstractMutableJythonMap
-
- All Implemented Interfaces:
JythonMap
,MutableJythonMap
,java.io.Serializable
public abstract class AbstractMutableJythonMap extends AbstractJythonMap implements MutableJythonMap
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description AbstractMutableJythonMap()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description abstract void
__delitem__(org.python.core.PyObject key)
RemovepyKey
from the map.abstract void
__setitem__(org.python.core.PyObject key, org.python.core.PyObject value)
Update the map atpyKey
with new valuepyValue
abstract void
clear()
Set every value in this mapping to null.abstract org.python.core.PyObject
pop(org.python.core.PyObject pyKey)
Returns the value specified bypyKey
in the mapping, and deletes that entry.org.python.core.PyObject
pop(org.python.core.PyObject pyKey, org.python.core.PyObject def)
Returns the value specified bypyKey
in the mapping, and deletes that entry.abstract org.python.core.PyObject
popitem()
Returns an arbitrary (not guaranteed random, nor guaranteed last) item (PyTuple key: value pair) from the dictionary, and removes that item from the mapping.org.python.core.PyObject
setdefault(org.python.core.PyObject pyKey)
Returns the value ofpyKey
if it is already present in the map.abstract org.python.core.PyObject
setdefault(org.python.core.PyObject pyKey, org.python.core.PyObject def)
Returns the value ofpyKey
if it is already present in the map.abstract void
update(org.python.core.PyObject[] args, java.lang.String[] keywords)
Updates this mapping, one of three possible ways: with a set of keyword arguments; eg{"a": 1}.update(b=2, c=3) == {"a": 1, "b": 2, * "c": 3}
with another dictionary directly with an iterable sequence of key:value pairs-
Methods inherited from class com.inductiveautomation.ignition.common.script.abc.AbstractJythonMap
__contains__, __finditem__, __finditem__, __finditem__, __iter__, __len__, __repr__, get, get, has_key, isMappingType, isNumberType, isSequenceType, items, iteritems, iterkeys, itervalues, keys, toString, values
-
Methods inherited from class org.python.core.PyObject
__abs__, __add__, __and__, __call__, __call__, __call__, __call__, __call__, __call__, __call__, __call__, __call__, __call__, __call__, __call__, __call__, __call__, __call__, __call__, __cmp__, __coerce__, __coerce_ex__, __complex__, __delattr__, __delattr__, __delete__, __delitem__, __delslice__, __delslice__, __dir__, __div__, __divmod__, __ensure_finalizer__, __eq__, __findattr__, __findattr__, __findattr_ex__, __float__, __floordiv__, __format__, __ge__, __get__, __getattr__, __getattr__, __getitem__, __getitem__, __getnewargs__, __getslice__, __getslice__, __gt__, __hash__, __hex__, __iadd__, __iand__, __idiv__, __idivmod__, __ifloordiv__, __ilshift__, __imod__, __imul__, __index__, __int__, __invert__, __ior__, __ipow__, __irshift__, __isub__, __iternext__, __itruediv__, __ixor__, __le__, __long__, __lshift__, __lt__, __mod__, __mul__, __ne__, __neg__, __nonzero__, __not__, __oct__, __or__, __pos__, __pow__, __pow__, __radd__, __rand__, __rawdir__, __rdiv__, __rdivmod__, __reduce__, __reduce_ex__, __reduce_ex__, __rfloordiv__, __rlshift__, __rmod__, __rmul__, __ror__, __rpow__, __rrshift__, __rshift__, __rsub__, __rtruediv__, __rxor__, __set__, __setattr__, __setattr__, __setitem__, __setitem__, __setslice__, __setslice__, __str__, __sub__, __tojava__, __truediv__, __trunc__, __unicode__, __xor__, _add, _and, _callextra, _cmp, _div, _divmod, _doget, _doget, _doset, _eq, _floordiv, _ge, _gt, _iadd, _iand, _idiv, _idivmod, _ifloordiv, _ilshift, _imod, _imul, _in, _ior, _ipow, _irshift, _is, _isnot, _isub, _itruediv, _ixor, _jcall, _jcallexc, _jthrow, _le, _lshift, _lt, _mod, _mul, _ne, _notin, _or, _pow, _rshift, _sub, _truediv, _unsupportedop, _xor, adaptToCoerceTuple, asDouble, asIndex, asIndex, asInt, asInt, asIterable, asLong, asLong, asName, asName, asString, asString, asStringOrNull, asStringOrNull, bit_length, conjugate, delDict, delType, dispatch__init__, equals, fastGetClass, fastGetDict, finalize, getDict, getJavaProxy, getType, hashCode, impAttr, implementsDescrDelete, implementsDescrGet, implementsDescrSet, invoke, invoke, invoke, invoke, invoke, invoke, isCallable, isDataDescr, isIndex, isInteger, mergeClassDict, mergeDictAttr, mergeListAttr, noAttributeError, object___subclasshook__, readonlyAttributeError, runsupportedopMessage, setDict, setType, unsupportedopMessage
-
-
-
-
Method Detail
-
clear
public abstract void clear() throws org.python.core.PyIgnoreMethodTag
Description copied from interface:MutableJythonMap
Set every value in this mapping to null.- Specified by:
clear
in interfaceMutableJythonMap
- Throws:
org.python.core.PyIgnoreMethodTag
-
pop
public abstract org.python.core.PyObject pop(org.python.core.PyObject pyKey) throws org.python.core.PyException, org.python.core.PyIgnoreMethodTag
Description copied from interface:MutableJythonMap
Returns the value specified bypyKey
in the mapping, and deletes that entry.- Specified by:
pop
in interfaceMutableJythonMap
- Throws:
org.python.core.PyException
-Py.KeyError
if the pyKey is not present in the map.org.python.core.PyIgnoreMethodTag
-
pop
public org.python.core.PyObject pop(org.python.core.PyObject pyKey, org.python.core.PyObject def) throws org.python.core.PyIgnoreMethodTag
Description copied from interface:MutableJythonMap
Returns the value specified bypyKey
in the mapping, and deletes that entry. If the entry is not present, returnsdef
.- Specified by:
pop
in interfaceMutableJythonMap
- Throws:
org.python.core.PyIgnoreMethodTag
-
popitem
public abstract org.python.core.PyObject popitem() throws org.python.core.PyIgnoreMethodTag
Description copied from interface:MutableJythonMap
Returns an arbitrary (not guaranteed random, nor guaranteed last) item (PyTuple key: value pair) from the dictionary, and removes that item from the mapping.- Specified by:
popitem
in interfaceMutableJythonMap
- Throws:
org.python.core.PyIgnoreMethodTag
-
setdefault
public org.python.core.PyObject setdefault(org.python.core.PyObject pyKey) throws org.python.core.PyIgnoreMethodTag
Description copied from interface:MutableJythonMap
Returns the value ofpyKey
if it is already present in the map. If it is not, the value is added to the map with a default value ofPy.None
, and returns the value added to the map.- Specified by:
setdefault
in interfaceMutableJythonMap
- Throws:
org.python.core.PyIgnoreMethodTag
-
setdefault
public abstract org.python.core.PyObject setdefault(org.python.core.PyObject pyKey, org.python.core.PyObject def) throws org.python.core.PyIgnoreMethodTag
Description copied from interface:MutableJythonMap
Returns the value ofpyKey
if it is already present in the map. If it is not, the value is added to the map withdef
, and returns the value added to the map.- Specified by:
setdefault
in interfaceMutableJythonMap
- Throws:
org.python.core.PyIgnoreMethodTag
-
update
public abstract void update(org.python.core.PyObject[] args, java.lang.String[] keywords) throws org.python.core.PyIgnoreMethodTag
Description copied from interface:MutableJythonMap
Updates this mapping, one of three possible ways:- with a set of keyword arguments; eg
{"a": 1}.update(b=2, c=3) == {"a": 1, "b": 2, * "c": 3}
- with another dictionary directly
- with an iterable sequence of key:value pairs
- Specified by:
update
in interfaceMutableJythonMap
- Parameters:
args
- arguments passed to this object. The second and third methods described above will pass a single PyObject in argskeywords
- 1:1 with arguments- Throws:
org.python.core.PyIgnoreMethodTag
- with a set of keyword arguments; eg
-
__setitem__
public abstract void __setitem__(org.python.core.PyObject key, org.python.core.PyObject value) throws org.python.core.PyIgnoreMethodTag
Description copied from interface:MutableJythonMap
Update the map atpyKey
with new valuepyValue
- Specified by:
__setitem__
in interfaceMutableJythonMap
- Overrides:
__setitem__
in classorg.python.core.PyObject
- Throws:
org.python.core.PyIgnoreMethodTag
-
__delitem__
public abstract void __delitem__(org.python.core.PyObject key) throws org.python.core.PyIgnoreMethodTag
Description copied from interface:MutableJythonMap
RemovepyKey
from the map.- Specified by:
__delitem__
in interfaceMutableJythonMap
- Overrides:
__delitem__
in classorg.python.core.PyObject
- Throws:
org.python.core.PyIgnoreMethodTag
-
-