java.lang.Object
- org.python.core.PyObject
- - org.python.core.PyFile

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

PyFileDerived
```
public class PyFile
extends PyObject
```
A python file wrapper around a java stream, reader/writer or file.

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class org.python.core.PyObject
  PyObject.ConversionException

Field Summary

Fields
Modifier and Type	Field	Description
`boolean`	`closed`
`static java.lang.Class`	`exposed_base`
`static java.lang.String`	`exposed_name`
`java.lang.String`	`mode`
`java.lang.String`	`name`
`boolean`	`softspace`

Constructor Summary

Constructors
Constructor	Description
`PyFile()`
`PyFile(java.io.InputStream istream)`
`PyFile(java.io.InputStream istream, java.io.OutputStream ostream)`
`PyFile(java.io.InputStream istream, java.io.OutputStream ostream, java.lang.String name)`
`PyFile(java.io.InputStream istream, java.io.OutputStream ostream, java.lang.String name, java.lang.String mode)`
`PyFile(java.io.InputStream istream, java.lang.String name)`
`PyFile(java.io.InputStream istream, java.lang.String name, java.lang.String mode)`
`PyFile(java.io.OutputStream ostream)`
`PyFile(java.io.OutputStream ostream, java.lang.String name)`
`PyFile(java.io.OutputStream ostream, java.lang.String name, java.lang.String mode)`
`PyFile(java.io.RandomAccessFile file)`
`PyFile(java.io.RandomAccessFile file, java.lang.String name)`
`PyFile(java.io.RandomAccessFile file, java.lang.String name, java.lang.String mode)`
`PyFile(java.io.Writer ostream)`
`PyFile(java.io.Writer ostream, java.lang.String name)`
`PyFile(java.io.Writer ostream, java.lang.String name, java.lang.String mode)`
`PyFile(java.lang.String name, java.lang.String mode, int bufsize)`
`PyFile(org.python.core.PyFile.FileWrapper file, java.lang.String name, java.lang.String mode)`
`PyFile(PyType subType)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`PyObject`	`__iter__()`	Return an iterator that is used to iterate the element of this sequence.
`PyObject`	`__iternext__()`	Return the next element of the sequence that this is an iterator for.
`void`	`__setattr__(java.lang.String name, PyObject value)`	A variant of the __setattr__ method which accepts a String as the key.
`java.lang.Object`	`__tojava__(java.lang.Class cls)`	Equivalent to the Jython __tojava__ method.
`void`	`close()`
`PyObject`	`fileno()`
`void`	`flush()`
`boolean`	`getClosed()`
`java.lang.String`	`getMode()`
`java.lang.String`	`getName()`
`PyObject`	`next()`
`java.lang.String`	`read()`
`java.lang.String`	`read(int n)`
`java.lang.String`	`readline()`
`java.lang.String`	`readline(int max)`
`PyObject`	`readlines()`
`PyObject`	`readlines(int sizehint)`
`void`	`seek(long pos)`
`void`	`seek(long pos, int how)`
`long`	`tell()`
`java.lang.String`	`toString()`
`void`	`truncate()`
`void`	`truncate(long position)`
`static void`	`typeSetup(PyObject dict, PyType.Newstyle marker)`
`void`	`write(java.lang.String s)`
`void`	`writelines(PyObject a)`
`PyObject`	`xreadlines()`

Methods inherited from class org.python.core.PyObject
__abs__, __add__, __and__, __call__, __call__, __call__, __call__, __call__, __call__, __call__, __call__, __cmp__, __coerce__, __coerce_ex__, __complex__, __contains__, __delattr__, __delattr__, __delete__, __delitem__, __delitem__, __delslice__, __delslice__, __dir__, __div__, __divmod__, __eq__, __findattr__, __findattr__, __finditem__, __finditem__, __finditem__, __float__, __floordiv__, __ge__, __get__, __getattr__, __getattr__, __getitem__, __getitem__, __getnewargs__, __getslice__, __getslice__, __gt__, __hash__, __hex__, __iadd__, __iand__, __idiv__, __idivmod__, __ifloordiv__, __ilshift__, __imod__, __imul__, __int__, __invert__, __ior__, __ipow__, __irshift__, __isub__, __itruediv__, __ixor__, __le__, __len__, __long__, __lshift__, __lt__, __mod__, __mul__, __ne__, __neg__, __nonzero__, __not__, __oct__, __or__, __pos__, __pow__, __pow__, __radd__, __rand__, __rdiv__, __rdivmod__, __reduce__, __repr__, __rfloordiv__, __rlshift__, __rmod__, __rmul__, __ror__, __rpow__, __rrshift__, __rshift__, __rsub__, __rtruediv__, __rxor__, __set__, __setattr__, __setitem__, __setitem__, __setitem__, __setslice__, __setslice__, __str__, __sub__, __truediv__, __unicode__, __xor__, _add, _and, _callextra, _cmp, _div, _divmod, _doget, _doget, _doset, _eq, _floordiv, _ge, _gt, _in, _is, _isnot, _jcall, _jcallexc, _jthrow, _le, _lshift, _lt, _mod, _mul, _ne, _notin, _or, _pow, _rshift, _sub, _truediv, _xor, asInt, asLong, asName, asString, asStringOrNull, delDict, delType, dispatch__init__, equals, fastGetClass, fastGetDict, getDict, getDoc, getType, hashCode, implementsDescrDelete, implementsDescrSet, invoke, invoke, invoke, invoke, invoke, isCallable, isDataDescr, isMappingType, isNumberType, isSequenceType, noAttributeError, readonlyAttributeError, safeRepr, setDict, setType

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Field Detail

exposed_name

public static final java.lang.String exposed_name

See Also:: Constant Field Values

exposed_base

public static final java.lang.Class exposed_base

name
```
public java.lang.String name
```

mode
```
public java.lang.String mode
```

softspace
```
public boolean softspace
```

closed
```
public boolean closed
```

Constructor Detail

PyFile
```
public PyFile()
```

PyFile
```
public PyFile(PyType subType)
```

PyFile

public PyFile(org.python.core.PyFile.FileWrapper file,
              java.lang.String name,
              java.lang.String mode)

PyFile

public PyFile(java.io.InputStream istream,
              java.io.OutputStream ostream,
              java.lang.String name,
              java.lang.String mode)

PyFile

public PyFile(java.io.InputStream istream,
              java.io.OutputStream ostream,
              java.lang.String name)

PyFile

public PyFile(java.io.InputStream istream,
              java.io.OutputStream ostream)

PyFile

public PyFile(java.io.InputStream istream,
              java.lang.String name,
              java.lang.String mode)

PyFile

public PyFile(java.io.InputStream istream,
              java.lang.String name)

PyFile

public PyFile(java.io.InputStream istream)

PyFile

public PyFile(java.io.OutputStream ostream,
              java.lang.String name,
              java.lang.String mode)

PyFile

public PyFile(java.io.OutputStream ostream,
              java.lang.String name)

PyFile

public PyFile(java.io.OutputStream ostream)

PyFile

public PyFile(java.io.Writer ostream,
              java.lang.String name,
              java.lang.String mode)

PyFile

public PyFile(java.io.Writer ostream,
              java.lang.String name)

PyFile

public PyFile(java.io.Writer ostream)

PyFile

public PyFile(java.io.RandomAccessFile file,
              java.lang.String name,
              java.lang.String mode)

PyFile

public PyFile(java.io.RandomAccessFile file,
              java.lang.String name)

PyFile

public PyFile(java.io.RandomAccessFile file)

PyFile

public PyFile(java.lang.String name,
              java.lang.String mode,
              int bufsize)

Method Detail
- typeSetup
```
public static void typeSetup(PyObject dict,
                             PyType.Newstyle marker)
```
- __setattr__
```
public void __setattr__(java.lang.String name,
                        PyObject value)
```
  Description copied from class: PyObject
  
  A variant of the __setattr__ method which accepts a String as the key. This String must be interned.
  
  Overrides:
  
  __setattr__ in class PyObject
  
  Parameters:
  
  name - the name whose value will be set - must be an interned string .
  
  value - the value to set this name to
  
  See Also:
  
  PyObject.__setattr__(PyString, PyObject)
- __tojava__
```
public java.lang.Object __tojava__(java.lang.Class cls)
```
  Description copied from class: PyObject
  
  Equivalent to the Jython __tojava__ method. Tries to coerce this object to an instance of the requested Java class. Returns the special object Py.NoConversion if this PyObject can not be converted to the desired Java class.
  
  Overrides:
  
  __tojava__ in class PyObject
  
  Parameters:
  
  cls - the Class to convert this PyObject to.
- read
```
public java.lang.String read(int n)
```
- read
```
public java.lang.String read()
```
- readline
```
public java.lang.String readline(int max)
```
- readline
```
public java.lang.String readline()
```
- readlines
```
public PyObject readlines(int sizehint)
```
- readlines
```
public PyObject readlines()
```
- __iter__
```
public PyObject __iter__()
```
  Description copied from class: PyObject
  Return an iterator that is used to iterate the element of this sequence. From version 2.2, this method is the primary protocol for looping over sequences.
  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:
```
    PyObject iter = seq.__iter__();
    for (PyObject item; (item = iter.__iternext__()) != null;)  {
        // Do somting with item
    }
 
```
  Overrides:
  
  __iter__ in class PyObject
- __iternext__
```
public PyObject __iternext__()
```
  Description copied from class: PyObject
  
  Return the next element of the sequence that this is an iterator for. Returns null when the end of the sequence is reached.
  
  Overrides:
  
  __iternext__ in class PyObject
- next
```
public PyObject next()
```
- xreadlines
```
public PyObject xreadlines()
```
- write
```
public void write(java.lang.String s)
```
- writelines
```
public void writelines(PyObject a)
```
- tell
```
public long tell()
```
- seek
```
public void seek(long pos,
                 int how)
```
- seek
```
public void seek(long pos)
```
- flush
```
public void flush()
```
- close
```
public void close()
```
- truncate
```
public void truncate()
```
- truncate
```
public void truncate(long position)
```
- fileno
```
public PyObject fileno()
```
- toString
```
public java.lang.String toString()
```
  Overrides:
  
  toString in class PyObject
- getMode
```
public java.lang.String getMode()
```
- getName
```
public java.lang.String getName()
```
- getClosed
```
public boolean getClosed()
```

Class PyFile

Nested Class Summary

Nested classes/interfaces inherited from class org.python.core.PyObject

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.python.core.PyObject

Methods inherited from class java.lang.Object

Field Detail

exposed_name

exposed_base

name

mode

softspace

closed

Constructor Detail

PyFile

PyFile

PyFile

PyFile

PyFile

PyFile

PyFile

PyFile

PyFile

PyFile

PyFile

PyFile

PyFile

PyFile

PyFile

PyFile

PyFile

PyFile

PyFile

Method Detail

typeSetup

__setattr__

__tojava__

read

read

readline

readline

readlines

readlines

__iter__

__iternext__

next

xreadlines

write

writelines

tell

seek

seek

flush

close

truncate

truncate

fileno

toString

getMode

getName

getClosed

setattr

tojava

iter

iternext