org.rococoa.cocoa.carboncore
Class FSEventStreamContext

java.lang.Object
  com.sun.jna.Structure
      com.ochafik.lang.jnaerator.runtime.Structure<FSEventStreamContext,FSEventStreamContext.ByValue,FSEventStreamContext.ByReference>
          org.rococoa.cocoa.carboncore.FSEventStreamContext

All Implemented Interfaces:

StructureType, StructureTypeDependent, Comparable<Structure<FSEventStreamContext,FSEventStreamContext.ByValue,FSEventStreamContext.ByReference>>

Direct Known Subclasses:

FSEventStreamContext.ByReference, FSEventStreamContext.ByValue

public class FSEventStreamContext
extends Structure<FSEventStreamContext,FSEventStreamContext.ByValue,FSEventStreamContext.ByReference>

FSEventStreamContext

Discussion:
Structure containing client-supplied data (and callbacks to
manage it) that should be associated with a newly-created stream.
native declaration : /System/Library/Frameworks/CoreServices.framework/Versions/Current/Frameworks/CarbonCore.framework/Headers/FSEvents.h:410
This file was autogenerated by JNAerator,
a tool written by Olivier Chafik that uses a few opensource projects..
For help, please visit NativeLibs4Java, Rococoa, or JNA.

Nested Class Summary

static class	FSEventStreamContext.ByReference
static class	FSEventStreamContext.ByValue

Field Summary

CoreFoundationLibrary.CFAllocatorCopyDescriptionCallBack	copyDescription The callback used to create a descriptive string representation of the info pointer (or the data pointed to by the info pointer) for debugging purposes.
Pointer	info An arbitrary client-defined value (for instance, a pointer) to be associated with the stream and passed to the callback when it is invoked.
CoreFoundationLibrary.CFAllocatorReleaseCallBack	release The callback used release a retain on the info pointer.
CoreFoundationLibrary.CFAllocatorRetainCallBack	retain The callback used retain the info pointer.
NativeLong	version Currently the only valid value is zero.

Fields inherited from class com.sun.jna.Structure

ALIGN_DEFAULT, ALIGN_GNUC, ALIGN_MSVC, ALIGN_NONE

Constructor Summary

FSEventStreamContext()

FSEventStreamContext(NativeLong version, Pointer info, CoreFoundationLibrary.CFAllocatorRetainCallBack retain, CoreFoundationLibrary.CFAllocatorReleaseCallBack release, CoreFoundationLibrary.CFAllocatorCopyDescriptionCallBack copyDescription)

Method Summary

static FSEventStreamContext[]

newArray(int arrayLength)

Methods inherited from class com.ochafik.lang.jnaerator.runtime.Structure

byReference, byValue, castToArray, castToArray, castToArray, castToReferenceArray, castToReferenceArray, castToValueArray, castToValueArray, clone, compareTo, newArray, read, setDependency, toArray, toArray, toArray, toReferenceArray, toReferenceArray, toValueArray, toValueArray, use, use, use, use, write

Methods inherited from class com.sun.jna.Structure

autoRead, autoRead, autoWrite, autoWrite, clear, equals, getAutoRead, getAutoWrite, getPointer, hashCode, newInstance, readField, setAutoRead, setAutoSynch, setAutoWrite, size, toString, writeField, writeField

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.ochafik.lang.jnaerator.runtime.StructureType

getPointer, size

Field Detail

version

public NativeLong version

Currently the only valid value is zero.
C type : CFIndex

info

public Pointer info

An arbitrary client-defined value (for instance, a pointer) to be
associated with the stream and passed to the callback when it is
invoked. If a non-NULL value is supplied for the retain callback
the framework will use it to retain this value. If a non-NULL
value is supplied for the release callback then when the stream is
deallocated it will be used to release this value. This can be
NULL.
C type : void*

retain

public CoreFoundationLibrary.CFAllocatorRetainCallBack retain

The callback used retain the info pointer. This can be NULL.
C type : CFAllocatorRetainCallBack

release

public CoreFoundationLibrary.CFAllocatorReleaseCallBack release

The callback used release a retain on the info pointer. This can
be NULL.
C type : CFAllocatorReleaseCallBack

copyDescription

public CoreFoundationLibrary.CFAllocatorCopyDescriptionCallBack copyDescription

The callback used to create a descriptive string representation of
the info pointer (or the data pointed to by the info pointer) for
debugging purposes. This can be NULL.
C type : CFAllocatorCopyDescriptionCallBack

Constructor Detail

FSEventStreamContext

public FSEventStreamContext()

FSEventStreamContext

public FSEventStreamContext(NativeLong version,
                            Pointer info,
                            CoreFoundationLibrary.CFAllocatorRetainCallBack retain,
                            CoreFoundationLibrary.CFAllocatorReleaseCallBack release,
                            CoreFoundationLibrary.CFAllocatorCopyDescriptionCallBack copyDescription)

Parameters:

version - Currently the only valid value is zero.
C type : CFIndex

info - An arbitrary client-defined value (for instance, a pointer) to be
associated with the stream and passed to the callback when it is
invoked. If a non-NULL value is supplied for the retain callback
the framework will use it to retain this value. If a non-NULL
value is supplied for the release callback then when the stream is
deallocated it will be used to release this value. This can be
NULL.
C type : void*

retain - The callback used retain the info pointer. This can be NULL.
C type : CFAllocatorRetainCallBack

release - The callback used release a retain on the info pointer. This can
be NULL.
C type : CFAllocatorReleaseCallBack

copyDescription - The callback used to create a descriptive string representation of
the info pointer (or the data pointed to by the info pointer) for
debugging purposes. This can be NULL.
C type : CFAllocatorCopyDescriptionCallBack

Method Detail

newArray

public static FSEventStreamContext[] newArray(int arrayLength)