Top Description Fields Constructors Methods
org.python.core

public Class PyJavaPackage

extends PyObject
implements Traverseproc
Class Inheritance
All Implemented Interfaces
org.python.core.Traverseproc
Imports
java.util.Collection, org.python.core.packagecache.PackageManager
A representation of java package.

Field Summary

Modifier and TypeField and Description
public PyStringMap
__dict__

public String
__file__

public PackageManager
__mgr__

(Control) package manager whose hierarchy contains this java pkg

public String
__name__

public PyStringMap
clsSet

Its keys are the names of statically known classes.

Inherited from org.python.core.PyObject:
attributesgcMonitorGlobalobjtypeTYPE

Constructor Summary

AccessConstructor and Description
public
PyJavaPackage(String name)

public
PyJavaPackage(String name, String jarfile)

public
PyJavaPackage(String name, PackageManager mgr)

public
PyJavaPackage(String name, PackageManager mgr, String jarfile)

Method Summary

Modifier and TypeMethod and Description
public PyObject
__dir__()

Overrides org.python.core.PyObject.__dir__.

Equivalent to the standard Python __dir__ method.

public PyObject
__findattr_ex__(String name)

Overrides org.python.core.PyObject.__findattr_ex__.

Attribute lookup hook.

public void
__setattr__(String
the name whose value will be set - must be an interned string .
attr, PyObject
the value to set this name to
value)

Overrides org.python.core.PyObject.__setattr__.

A variant of the __setattr__ method which accepts a String as the key.

public PyObject
addClass(String name, Class<?> c)

public PyJavaPackage
addPackage(String name)

public PyJavaPackage

Returns:

the PyJavaPackage of the package named
addPackage(String
a package name
name, String
becomes the __file__ attribute
jarfile)

From a dotted package name a.b.c interpreted relative to this package t, ensure that a is in the dictionary of t and then recursively process the remainder b.c relative to a, finally returning the PyJavaPackage of t.a.b.c.

public void
addPlaceholders(Collection<String>
the names as strings
classes)

Add the classes named to this package, but with only a placeholder value.

public PyObject

Returns:

list of member names
fillDir()

Used for 'from xyz import *', dynamically dir pkg filling up __dict__.

public boolean
refersDirectlyTo(PyObject ob)

Implements org.python.core.Traverseproc.refersDirectlyTo.

Optional operation.

public String
toString()

Overrides org.python.core.PyObject.toString.

Returns a string representation of the object.

public int
traverse(Visitproc visit, Object arg)

Implements org.python.core.Traverseproc.traverse.

Traverses all directly contained PyObjects.

Inherited from 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____contains____delattr____delattr____delete____delitem____delitem____delslice____delslice____div____divmod____ensure_finalizer____eq____findattr____findattr____finditem____finditem____finditem____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____iter____iternext____itruediv____ixor____le____len____long____lshift____lt____mod____mul____ne____neg____nonzero____not____oct____or____pos____pow____pow____radd____rand____rawdir____rdiv____rdivmod____reduce____reduce_ex____reduce_ex____repr____rfloordiv____rlshift____rmod____rmul____ror____rpow____rrshift____rshift____rsub____rtruediv____rxor____set____setattr____setitem____setitem____setitem____setslice____setslice____str____sub____tojava____truediv____trunc____unicode____xor___add_and_basic_add_basic_and_basic_div_basic_divmod_basic_floordiv_basic_iadd_basic_iand_basic_idiv_basic_idivmod_basic_ifloordiv_basic_ilshift_basic_imod_basic_imul_basic_ior_basic_ipow_basic_irshift_basic_isub_basic_itruediv_basic_ixor_basic_lshift_basic_mod_basic_mul_basic_or_basic_pow_basic_rshift_basic_sub_basic_truediv_basic_xor_callextra_cmp_coerce_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_xoradaptToCoerceTupleasDoubleasIndexasIndexasIntasIntasIterableasLongasLongasNameasNameasStringasStringasStringOrNullasStringOrNullbit_lengthconjugatedelDictdelTypedispatch__init__equalsfastGetClassfastGetDictfinalizegetDictgetJavaProxygetTypehashCodeimpAttrimplementsDescrDeleteimplementsDescrGetimplementsDescrSetinvokeinvokeinvokeinvokeinvokeinvokeisCallableisDataDescrisIndexisIntegerisMappingTypeisNumberTypeisSequenceTypejdontdelmergeClassDictmergeDictAttrmergeListAttrnoAttributeErrorobject___contains__object___delattr__object___delattr__object___findattr__object___format__object___getattribute__object___hash__object___init__object___new__object___reduce__object___reduce_ex__object___setattr__object___setattr__object___subclasshook__object_toStringproxyInitreadonlyAttributeErrorrunsupportedopMessagesetDictsetTypeunsupportedopMessage

Field Detail

__dict__back to summary
public PyStringMap __dict__
__file__back to summary
public String __file__
__mgr__back to summary
public PackageManager __mgr__

(Control) package manager whose hierarchy contains this java pkg

__name__back to summary
public String __name__
clsSetback to summary
public PyStringMap clsSet

Its keys are the names of statically known classes. E.g. from jars pre-scan.

Constructor Detail

PyJavaPackageback to summary
public PyJavaPackage(String name)
PyJavaPackageback to summary
public PyJavaPackage(String name, String jarfile)
PyJavaPackageback to summary
public PyJavaPackage(String name, PackageManager mgr)
PyJavaPackageback to summary
public PyJavaPackage(String name, PackageManager mgr, String jarfile)

Method Detail

__dir__back to summary
public PyObject __dir__()

Overrides org.python.core.PyObject.__dir__.

Doc from org.python.core.PyObject.__dir__.

Equivalent to the standard Python __dir__ method.

Returns:PyObject

a list of names defined by this object.

Annotations
@Override

__findattr_ex__back to summary
public PyObject __findattr_ex__(String name)

Overrides org.python.core.PyObject.__findattr_ex__.

Doc from org.python.core.PyObject.__findattr_ex__.

Attribute lookup hook. If the attribute is not found, null may be returned or a Py.AttributeError can be thrown, whatever is more correct, efficient and/or convenient for the implementing class. Client code should use __getattr__(String) or __findattr__(String). Both methods have a clear policy for failed lookups.

Returns:PyObject

The looked up value. May return null if the attribute is not found

Annotations
@Override

__setattr__back to summary
public void __setattr__(String attr, PyObject value)

Overrides org.python.core.PyObject.__setattr__.

Doc from org.python.core.PyObject.__setattr__.

A variant of the __setattr__ method which accepts a String as the key. This String must be interned.

Parameters
attr:String

the name whose value will be set - must be an interned string .

value:PyObject

the value to set this name to

Annotations
@Override
addClassback to summary
public PyObject addClass(String name, Class<?> c)
addPackageback to summary
public PyJavaPackage addPackage(String name)
addPackageback to summary
public PyJavaPackage addPackage(String name, String jarfile)

From a dotted package name a.b.c interpreted relative to this package t, ensure that a is in the dictionary of t and then recursively process the remainder b.c relative to a, finally returning the PyJavaPackage of t.a.b.c. In the case where the initial package name is just a, no dots, the method simply ensures a is entered in t, and returns the PyJavaPackage of t.a.

Parameters
name:String

a package name

jarfile:String

becomes the __file__ attribute

Returns:PyJavaPackage

the PyJavaPackage of the package named

addPlaceholdersback to summary
public void addPlaceholders(Collection<String> classes)

Add the classes named to this package, but with only a placeholder value. These names are statically known, typically from processing JAR files on the class path.

Parameters
classes:Collection<String>

the names as strings

fillDirback to summary
public PyObject fillDir()

Used for 'from xyz import *', dynamically dir pkg filling up __dict__. It uses PackageManager#doDir implementation furnished by the control package manager with instantiate true. The package manager should load classes with addClass in the package.

Returns:PyObject

list of member names

refersDirectlyToback to summary
public boolean refersDirectlyTo(PyObject ob)

Implements org.python.core.Traverseproc.refersDirectlyTo.

Doc from org.python.core.Traverseproc.refersDirectlyTo.

Optional operation. Should only be implemented if it is more efficient than calling traverse(Visitproc, Object) with a visitproc that just watches out for ob. Must return false if ob is null.

Annotations
@Override
toStringback to summary
public String toString()

Overrides org.python.core.PyObject.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations
@Override

traverseback to summary
public int traverse(Visitproc visit, Object arg)

Implements org.python.core.Traverseproc.traverse.

Doc from org.python.core.Traverseproc.traverse.

Traverses all directly contained PyObjects. Like in CPython, arg must be passed unmodified to visit as its second parameter. If Visitproc#visit(PyObject, Object) returns nonzero, this return value must be returned immediately by traverse. Visitproc#visit(PyObject, Object) must not be called with a null PyObject-argument.

Annotations
@Override