Package org.robovm.apple.foundation

Class NSFileHandle

java.lang.Object

org.robovm.rt.bro.NativeObject

org.robovm.objc.ObjCObject

org.robovm.apple.foundation.NSObject

org.robovm.apple.foundation.NSFileHandle

All Implemented Interfaces:

NSCoding, NSObjectProtocol, NSSecureCoding, ObjCProtocol

public class NSFileHandle
extends NSObject
implements NSSecureCoding

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	NSFileHandle.Notifications
static class	NSFileHandle.NSFileHandlePtr

Nested classes/interfaces inherited from class org.robovm.apple.foundation.NSObject

NSObject.Handle, NSObject.Marshaler, NSObject.NoRetainMarshaler, NSObject.NSKeyValueObserver, NSObject.NSObjectPtr, NSObject.SkipInit

Nested classes/interfaces inherited from class org.robovm.objc.ObjCObject

ObjCObject.ObjCObjectPtr, ObjCObject.Super

Field Summary

Fields inherited from class org.robovm.apple.foundation.NSObject

FLAG_NO_RETAIN

Fields inherited from class org.robovm.objc.ObjCObject

customClass

Constructor Summary

Constructors

Modifier	Constructor	Description
	NSFileHandle()
	NSFileHandle(int fd)
	NSFileHandle(int fd, boolean closeopt)
	NSFileHandle(NSCoder coder)
protected	NSFileHandle(NSObject.Handle h, long handle)
protected	NSFileHandle(NSObject.SkipInit skipInit)

Method Summary

Modifier and Type	Method	Description
void	acceptConnectionInBackgroundAndNotify()
void	acceptConnectionInBackgroundAndNotify(List<String> modes)
void	acceptConnectionInBackgroundAndNotify(NSRunLoopMode... modes)
boolean	closeAndReturnError(NSError.NSErrorPtr error)
void	closeFile()	Deprecated. Use closeAndReturnError:
static NSString	ConnectionAcceptedNotification()
static NSFileHandle	createForReading(String path)
static NSFileHandle	createForReading(NSURL url)
static NSFileHandle	createForUpdating(String path)
static NSFileHandle	createForUpdating(NSURL url)
static NSFileHandle	createForWriting(String path)
static NSFileHandle	createForWriting(NSURL url)
static NSString	DataAvailableNotification()
void	encode(NSCoder coder)
NSData	getAvailableData()
int	getFileDescriptor()
static NSFileHandle	getNullDevice()
boolean	getOffsetEx(LongPtr offsetInFile)
long	getOffsetInFile()	Deprecated. Use getOffset:error:
VoidBlock1<NSFileHandle>	getReadabilityHandler()
static NSFileHandle	getStandardError()
static NSFileHandle	getStandardInput()
static NSFileHandle	getStandardOutput()
VoidBlock1<NSFileHandle>	getWriteabilityHandler()
protected long	init(int fd)
protected long	init(int fd, boolean closeopt)
protected long	init(NSCoder coder)
protected static NSString	NotificationDataItem()
protected static NSString	NotificationFileHandleItem()
static NSString	ReadCompletionNotification()
NSData	readData(long length)	Deprecated. Use readDataUpToLength:error:
NSData	readDataToEndOfFile()	Deprecated. Use readDataToEndOfFileAndReturnError:
NSData	readDataToEndOfFileEx()
NSData	readDataUpToLengthEx(long length)
void	readInBackgroundAndNotify()
void	readInBackgroundAndNotify(List<String> modes)
void	readInBackgroundAndNotify(NSRunLoopMode... modes)
static NSString	ReadToEndOfFileCompletionNotification()
void	readToEndOfFileInBackgroundAndNotify()
void	readToEndOfFileInBackgroundAndNotify(List<String> modes)
void	readToEndOfFileInBackgroundAndNotify(NSRunLoopMode... modes)
long	seekToEndOfFile()	Deprecated. Use seekToEndReturningOffset:error:
boolean	seekToEndReturningOffsetEx(LongPtr offsetInFile)
void	seekToFileOffset(long offset)	Deprecated. Use seekToOffset:error:
boolean	seekToOffsetEx(long offset)
void	setReadabilityHandler(VoidBlock1<NSFileHandle> v)
void	setWriteabilityHandler(VoidBlock1<NSFileHandle> v)
static boolean	supportsSecureCoding()
boolean	synchronizeAndReturnError(NSError.NSErrorPtr error)
void	synchronizeFile()	Deprecated. Use synchronizeAndReturnError:
boolean	truncateAtOffsetEx(long offset)
void	truncateFile(long offset)	Deprecated. Use truncateAtOffset:error:
void	waitForDataInBackgroundAndNotify()
void	waitForDataInBackgroundAndNotify(List<String> modes)
void	waitForDataInBackgroundAndNotify(NSRunLoopMode... modes)
void	writeData(NSData data)	Deprecated. Use writeData:error:
boolean	writeDataEx(NSData data)

Methods inherited from class org.robovm.apple.foundation.NSObject

addKeyValueObserver, addKeyValueObserver, afterMarshaled, alloc, autorelease, autorelease, awakeFromNib, conformsToProtocol, copy, description, didChangeValue, didChangeValue, didChangeValues, doDispose, equals, forceSkipInit, getAutoContentAccessingProxy, getClassForCoder, getClassForKeyedArchiver, getKeyValueCoder, getObservationInfo, hash, hashCode, init, isEqual, isKindOfClass, isMemberOfClass, mutableCopy, performSelector, performSelector, performSelector, performSelector, performSelector, performSelector, performSelector, performSelectorInBackground, performSelectorOnMainThread, performSelectorOnMainThread, performSelectorV, performSelectorV, performSelectorV, release, release, removeKeyValueObserver, removeKeyValueObservers, respondsToSelector, retain, retain, retainCount, setObservationInfo, toString, willChangeValue, willChangeValue, willChangeValues

Methods inherited from class org.robovm.objc.ObjCObject

addStrongRef, dispose, dispose, finalize, getAssociatedObject, getObjCClass, getPeerObject, getSuper, initObject, logRetainRelease, removeStrongRef, retainCustomObjectFromCb, setAssociatedObject, toObjCObject, toObjCObject, updateStrongRef

Methods inherited from class org.robovm.rt.bro.NativeObject

as, getHandle, setHandle

Methods inherited from class java.lang.Object

clone, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

NSFileHandle

public NSFileHandle()

NSFileHandle

protected NSFileHandle(NSObject.Handle h,
long handle)

NSFileHandle

protected NSFileHandle(NSObject.SkipInit skipInit)

NSFileHandle

public NSFileHandle(int fd,
boolean closeopt)

NSFileHandle

public NSFileHandle(NSCoder coder)

NSFileHandle

public NSFileHandle(int fd)

Method Details

getAvailableData

public NSData getAvailableData()

getStandardInput

public static NSFileHandle getStandardInput()

getStandardOutput

public static NSFileHandle getStandardOutput()

getStandardError

public static NSFileHandle getStandardError()

getNullDevice

public static NSFileHandle getNullDevice()

getReadabilityHandler

public VoidBlock1<NSFileHandle> getReadabilityHandler()

setReadabilityHandler

public void setReadabilityHandler(VoidBlock1<NSFileHandle> v)

getWriteabilityHandler

public VoidBlock1<NSFileHandle> getWriteabilityHandler()

setWriteabilityHandler

public void setWriteabilityHandler(VoidBlock1<NSFileHandle> v)

getFileDescriptor

public int getFileDescriptor()

getOffsetInFile

@Deprecated
public long getOffsetInFile()

Deprecated.

Use getOffset:error:

supportsSecureCoding

public static boolean supportsSecureCoding()

readInBackgroundAndNotify

public void readInBackgroundAndNotify(NSRunLoopMode... modes)

readToEndOfFileInBackgroundAndNotify

public void readToEndOfFileInBackgroundAndNotify(NSRunLoopMode... modes)

acceptConnectionInBackgroundAndNotify

public void acceptConnectionInBackgroundAndNotify(NSRunLoopMode... modes)

waitForDataInBackgroundAndNotify

public void waitForDataInBackgroundAndNotify(NSRunLoopMode... modes)

ReadCompletionNotification

public static NSString ReadCompletionNotification()

ReadToEndOfFileCompletionNotification

public static NSString ReadToEndOfFileCompletionNotification()

ConnectionAcceptedNotification

public static NSString ConnectionAcceptedNotification()

DataAvailableNotification

public static NSString DataAvailableNotification()

NotificationDataItem

protected static NSString NotificationDataItem()

NotificationFileHandleItem

protected static NSString NotificationFileHandleItem()

init

protected long init(int fd,
boolean closeopt)

init

protected long init(NSCoder coder)

readDataToEndOfFileEx

public NSData readDataToEndOfFileEx()
                             throws NSErrorException

Throws:

NSErrorException

Since:

Available in iOS 13.0 and later.

readDataUpToLengthEx

public NSData readDataUpToLengthEx(long length)
                            throws NSErrorException

Throws:

NSErrorException

Since:

Available in iOS 13.0 and later.

writeDataEx

public boolean writeDataEx(NSData data)
                    throws NSErrorException

Throws:

NSErrorException

Since:

Available in iOS 13.0 and later.

getOffsetEx

public boolean getOffsetEx(LongPtr offsetInFile)
                    throws NSErrorException

Throws:

NSErrorException

Since:

Available in iOS 13.0 and later.

seekToEndReturningOffsetEx

public boolean seekToEndReturningOffsetEx(LongPtr offsetInFile)
                                   throws NSErrorException

Throws:

NSErrorException

Since:

Available in iOS 13.0 and later.

seekToOffsetEx

public boolean seekToOffsetEx(long offset)
                       throws NSErrorException

Throws:

NSErrorException

Since:

Available in iOS 13.0 and later.

truncateAtOffsetEx

public boolean truncateAtOffsetEx(long offset)
                           throws NSErrorException

Throws:

NSErrorException

Since:

Available in iOS 13.0 and later.

synchronizeAndReturnError

public boolean synchronizeAndReturnError(NSError.NSErrorPtr error)

Since:

Available in iOS 13.0 and later.

closeAndReturnError

public boolean closeAndReturnError(NSError.NSErrorPtr error)

Since:

Available in iOS 13.0 and later.

createForReading

public static NSFileHandle createForReading(String path)

createForWriting

public static NSFileHandle createForWriting(String path)

createForUpdating

public static NSFileHandle createForUpdating(String path)

createForReading

public static NSFileHandle createForReading(NSURL url)
                                     throws NSErrorException

Throws:

NSErrorException

createForWriting

public static NSFileHandle createForWriting(NSURL url)
                                     throws NSErrorException

Throws:

NSErrorException

createForUpdating

public static NSFileHandle createForUpdating(NSURL url)
                                      throws NSErrorException

Throws:

NSErrorException

readInBackgroundAndNotify

public void readInBackgroundAndNotify(List<String> modes)

readInBackgroundAndNotify

public void readInBackgroundAndNotify()

readToEndOfFileInBackgroundAndNotify

public void readToEndOfFileInBackgroundAndNotify(List<String> modes)

readToEndOfFileInBackgroundAndNotify

public void readToEndOfFileInBackgroundAndNotify()

acceptConnectionInBackgroundAndNotify

public void acceptConnectionInBackgroundAndNotify(List<String> modes)

acceptConnectionInBackgroundAndNotify

public void acceptConnectionInBackgroundAndNotify()

waitForDataInBackgroundAndNotify

public void waitForDataInBackgroundAndNotify(List<String> modes)

waitForDataInBackgroundAndNotify

public void waitForDataInBackgroundAndNotify()

init

protected long init(int fd)

readDataToEndOfFile

@Deprecated
public NSData readDataToEndOfFile()

Deprecated.

Use readDataToEndOfFileAndReturnError:

readData

@Deprecated
public NSData readData(long length)

Deprecated.

Use readDataUpToLength:error:

writeData

@Deprecated
public void writeData(NSData data)

Deprecated.

Use writeData:error:

seekToEndOfFile

@Deprecated
public long seekToEndOfFile()

Deprecated.

Use seekToEndReturningOffset:error:

seekToFileOffset

@Deprecated
public void seekToFileOffset(long offset)

Deprecated.

Use seekToOffset:error:

truncateFile

@Deprecated
public void truncateFile(long offset)

Deprecated.

Use truncateAtOffset:error:

synchronizeFile

@Deprecated
public void synchronizeFile()

Deprecated.

Use synchronizeAndReturnError:

closeFile

@Deprecated
public void closeFile()

Deprecated.

Use closeAndReturnError:

encode

public void encode(NSCoder coder)

Specified by:

encode in interface NSCoding