Nested and Inner Type Summary

Modifier and Type	Class and Description
private static class	Platform.ArchHolder
public static enum	Platform.CPU The common names of cpu architectures Note The names of the enum values are used in other parts of the code to determine where to find the native stub library.
private static class	Platform.Darwin A `Platform` subclass representing the MacOS system.
private static class	Platform.Default
public static enum	Platform.OS The common names of operating systems Note The names of the enum values are used in other parts of the code to determine where to find the native stub library.
private static class	Platform.SingletonHolder Holds a single, lazily loaded instance of `Platform`
private static class	Platform.Windows A `Platform` subclass representing the Windows system.

Modifier and Type	Field and Description
private final int	javaVersionMajor
private static final Locale	LOCALE
private final Platform.OS	os

Access	Constructor and Description
private	Platform(Platform.OS The current operating system. os) Constructs a new `Platform` instance.

Method Summary

Modifier and Type	Method and Description
public final long	Returns: the size of a pointer in bits addressMask() Gets the 32/64bit mask of a C address/pointer on the native platform.
public final int	Returns: the size of a pointer in bits addressSize() Gets the size of a C address/pointer on the native platform.
private static final Platform.OS	Returns: An member of the `OS` enum. determineOS() Determines the operating system jffi is running on
private static final Platform	Returns: An instance of `Platform` determinePlatform(Platform.OS The operating system. os) Determines the `Platform` that best describes the `OS`
public final Platform.CPU	Returns: A `CPU` value representing the current processor architecture. getCPU() Gets the current processor architecture the JVM is running on.
public final int	Returns: A number representing the java version. e.g. 5 for java 1.5, 6 for java 1.6 getJavaMajorVersion() Gets the version of the Java Virtual Machine (JVM) jffi is running on.
public String	getLibraryNamePattern() Gets the regex string used to match platform-specific libraries
public String	Returns: The name of this platform. getName() Gets the name of this `Platform`.
public final Platform.OS	Returns: A `OS` value representing the current Operating System. getOS() Gets the current Operating System.
public static final Platform	Returns: The current platform. getPlatform() Gets the current `Platform`
public boolean	Returns: `true` if the platform is supported, else false. isSupported() Checks if the current platform is supported by JFFI.
public abstract int	Returns: the size of a long in bits longSize() Gets the size of a C 'long' on the native platform.
public String	Returns: The mapped library name. mapLibraryName(String The library name to map libName) Maps from a generic library name (e.g. "c") to the platform specific library name.
private static Platform	newDarwinPlatform()
private static Platform	newDefaultPlatform(Platform.OS os)
private static Platform	newWindowsPlatform()
private static boolean	startsWithIgnoreCase(String s1, String s2)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

javaVersionMajor	back to summary
private final int javaVersionMajor

LOCALE	back to summary
private static final Locale LOCALE

os	back to summary
private final Platform.OS os

Platform	back to summary
private Platform(Platform.OS os) Constructs a new `Platform` instance. Parameters os:Platform.OS The current operating system.

Method Detail

addressMask	back to summary
public final long addressMask() Gets the 32/64bit mask of a C address/pointer on the native platform. Returns:long the size of a pointer in bits

addressMask

back to summary

public final long addressMask()

Gets the 32/64bit mask of a C address/pointer on the native platform.

Returns:long: the size of a pointer in bits

addressSize	back to summary
public final int addressSize() Gets the size of a C address/pointer on the native platform. Returns:int the size of a pointer in bits

addressSize

back to summary

public final int addressSize()

Gets the size of a C address/pointer on the native platform.

Returns:int: the size of a pointer in bits

determineOS back to summary

determineOS	back to summary
private static final Platform.OS determineOS() Determines the operating system jffi is running on Returns:Platform.OS An member of the `OS` enum.

private static final Platform.OS determineOS()

Determines the operating system jffi is running on

Returns:Platform.OS: An member of the OS enum.

determinePlatform back to summary

determinePlatform	back to summary
private static final Platform determinePlatform(Platform.OS os) Determines the `Platform` that best describes the `OS` Parameters os:Platform.OS The operating system. Returns:Platform An instance of `Platform`

private static final Platform determinePlatform(Platform.OS os)

Determines the Platform that best describes the OS

Parameters

os:Platform.OS: The operating system.

Returns:Platform

An instance of Platform

getCPU back to summary

getCPU	back to summary
public final Platform.CPU getCPU() Gets the current processor architecture the JVM is running on. Returns:Platform.CPU A `CPU` value representing the current processor architecture.

public final Platform.CPU getCPU()

Gets the current processor architecture the JVM is running on.

Returns:Platform.CPU: A CPU value representing the current processor architecture.

getJavaMajorVersion	back to summary
public final int getJavaMajorVersion() Gets the version of the Java Virtual Machine (JVM) jffi is running on. Returns:int A number representing the java version. e.g. 5 for java 1.5, 6 for java 1.6

getJavaMajorVersion

back to summary

public final int getJavaMajorVersion()

Gets the version of the Java Virtual Machine (JVM) jffi is running on.

Returns:int: A number representing the java version. e.g. 5 for java 1.5, 6 for java 1.6

getLibraryNamePattern	back to summary
public String getLibraryNamePattern() Gets the regex string used to match platform-specific libraries

getName back to summary

getName	back to summary
public String getName() Gets the name of this `Platform`. Returns:String The name of this platform.

public String getName()

Gets the name of this Platform.

Returns:String: The name of this platform.

getOS back to summary

getOS	back to summary
public final Platform.OS getOS() Gets the current Operating System. Returns:Platform.OS A `OS` value representing the current Operating System.

public final Platform.OS getOS()

Gets the current Operating System.

Returns:Platform.OS: A OS value representing the current Operating System.

getPlatform back to summary

getPlatform	back to summary
public static final Platform getPlatform() Gets the current `Platform` Returns:Platform The current platform.

public static final Platform getPlatform()

Gets the current Platform

Returns:Platform: The current platform.

isSupported back to summary

isSupported	back to summary
public boolean isSupported() Checks if the current platform is supported by JFFI. Returns:boolean `true` if the platform is supported, else false.

public boolean isSupported()

Checks if the current platform is supported by JFFI.

Returns:boolean: true if the platform is supported, else false.

longSize	back to summary
public abstract int longSize() Gets the size of a C 'long' on the native platform. Returns:int the size of a long in bits

longSize

back to summary

public abstract int longSize()

Gets the size of a C 'long' on the native platform.

Returns:int: the size of a long in bits

mapLibraryName	back to summary
public String mapLibraryName(String libName) Maps from a generic library name (e.g. "c") to the platform specific library name. Parameters libName:String The library name to map Returns:String The mapped library name.

mapLibraryName

back to summary

public String mapLibraryName(String libName)

Maps from a generic library name (e.g. "c") to the platform specific library name.

Parameters

libName:String: The library name to map

Returns:String

The mapped library name.

newDarwinPlatform	back to summary
private static Platform newDarwinPlatform()

newDefaultPlatform	back to summary
private static Platform newDefaultPlatform(Platform.OS os)

newWindowsPlatform	back to summary
private static Platform newWindowsPlatform()

startsWithIgnoreCase	back to summary
private static boolean startsWithIgnoreCase(String s1, String s2)

com.kenai.jffi back to summary

private final Class Platform.ArchHolder

Class Inheritance

extends Object

java.lang.Object
com.kenai.jffi.Platform.ArchHolder

Field Summary

Modifier and Type	Field and Description
public static final Platform.CPU	cpu

Constructor Summary

Access	Constructor and Description
private	ArchHolder()

Method Summary

Modifier and Type	Method and Description
private static Platform.CPU	Returns: A member of the `CPU` enum. determineCPU() Determines the CPU architecture the JVM is running on.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

cpu	back to summary
public static final Platform.CPU cpu

Constructor Detail

ArchHolder	back to summary
private ArchHolder()

Method Detail

determineCPU back to summary

determineCPU	back to summary
private static Platform.CPU determineCPU() Determines the CPU architecture the JVM is running on. This normalizes all the variations that are equivalent (e.g. i386, x86, i86pc) into a common cpu type. Returns:Platform.CPU A member of the `CPU` enum.

private static Platform.CPU determineCPU()

Determines the CPU architecture the JVM is running on. This normalizes all the variations that are equivalent (e.g. i386, x86, i86pc) into a common cpu type.

Returns:Platform.CPU: A member of the CPU enum.

com.kenai.jffi back to summary

public final Enum Platform.CPU

Class Inheritance

extends Enum<Platform.CPU>

java.lang.Object
java.lang.Enum
com.kenai.jffi.Platform.CPU

The common names of cpu architectures

Note

The names of the enum values are used in other parts of the code to determine where to find the native stub library. Do not rename.

Field Summary

Modifier and Type	Field and Description
public static final Platform.CPU	AARCH64 AARCH64
public final long	addressMask
public static final Platform.CPU	ARM ARM
public final int	dataModel
public static final Platform.CPU	I386 Intel ia32
public static final Platform.CPU	MIPS64EL MIPS64EL
public static final Platform.CPU	PPC Power PC 32 bit
public static final Platform.CPU	PPC64 Power PC 64 bit
public static final Platform.CPU	PPC64LE Power PC 64 bit little endian
public static final Platform.CPU	S390X IBM zSeries S/390 64 bit
public static final Platform.CPU	SPARC Sun sparc 32 bit
public static final Platform.CPU	SPARCV9 Sun sparc 64 bit
public static final Platform.CPU	UNKNOWN Unknown CPU
public static final Platform.CPU	X86_64 AMD 64 bit (aka EM64T/X64)

Constructor Summary

Access	Constructor and Description
private	CPU(int dataModel)

Method Summary

Modifier and Type	Method and Description
public String	toString() Overrides java.lang.Enum.toString. Returns the name of this enum constant, as contained in the declaration.
public static Platform.CPU	valueOf(String name)
public static Platform.CPU[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal valueOf

Field Detail

AARCH64	back to summary
public static final Platform.CPU AARCH64 AARCH64

addressMask	back to summary
public final long addressMask

ARM	back to summary
public static final Platform.CPU ARM ARM

dataModel	back to summary
public final int dataModel

I386	back to summary
public static final Platform.CPU I386 Intel ia32

MIPS64EL	back to summary
public static final Platform.CPU MIPS64EL MIPS64EL

PPC	back to summary
public static final Platform.CPU PPC Power PC 32 bit

PPC64	back to summary
public static final Platform.CPU PPC64 Power PC 64 bit

PPC64LE	back to summary
public static final Platform.CPU PPC64LE Power PC 64 bit little endian

S390X	back to summary
public static final Platform.CPU S390X IBM zSeries S/390 64 bit

SPARC	back to summary
public static final Platform.CPU SPARC Sun sparc 32 bit

SPARCV9	back to summary
public static final Platform.CPU SPARCV9 Sun sparc 64 bit

UNKNOWN	back to summary
public static final Platform.CPU UNKNOWN Unknown CPU

X86_64	back to summary
public static final Platform.CPU X86_64 AMD 64 bit (aka EM64T/X64)

Constructor Detail

CPU	back to summary
private CPU(int dataModel)

Method Detail

toString	back to summary
public String toString() Overrides java.lang.Enum.toString. Doc from java.lang.Enum.toString. Returns the name of this enum constant, as contained in the declaration. This method may be overridden, though it typically isn't necessary or desirable. An enum class should override this method when a more "programmer-friendly" string form exists. Returns:String the name of this enum constant Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Enum.toString.

Doc from java.lang.Enum.toString.

Returns the name of this enum constant, as contained in the declaration. This method may be overridden, though it typically isn't necessary or desirable. An enum class should override this method when a more "programmer-friendly" string form exists.

Returns:String

the name of this enum constant

Annotations

@Override

valueOf	back to summary
public static Platform.CPU valueOf(String name)

values	back to summary
public static Platform.CPU[] values()

com.kenai.jffi back to summary

private final Class Platform.Darwin

Class Inheritance

extends Platform

java.lang.Object
com.kenai.jffi.Platform
com.kenai.jffi.Platform.Darwin

A Platform subclass representing the MacOS system.

Constructor Summary

Access	Constructor and Description
public	Darwin()

Method Summary

Modifier and Type	Method and Description
public String	getLibraryNamePattern() Overrides com.kenai.jffi.Platform.getLibraryNamePattern. Gets the regex string used to match platform-specific libraries
public String	getName() Overrides com.kenai.jffi.Platform.getName. Gets the name of this `Platform`.
public final int	longSize() Implements abstract com.kenai.jffi.Platform.longSize. Gets the size of a C 'long' on the native platform.
public String	mapLibraryName(String The library name to map libName) Overrides com.kenai.jffi.Platform.mapLibraryName. Maps from a generic library name (e.g. "c") to the platform specific library name.

Inherited from com.kenai.jffi.Platform:: addressMask addressSize getCPU getJavaMajorVersion getOS getPlatform isSupported

Constructor Detail

Darwin	back to summary
public Darwin()

Method Detail

getLibraryNamePattern

back to summary

public String getLibraryNamePattern()

Overrides com.kenai.jffi.Platform.getLibraryNamePattern.

Doc from com.kenai.jffi.Platform.getLibraryNamePattern.

Gets the regex string used to match platform-specific libraries

Annotations

@Override

getName back to summary

public String getName()

Overrides com.kenai.jffi.Platform.getName.

Doc from com.kenai.jffi.Platform.getName.

Gets the name of this Platform.

Returns:String

The name of this platform.

Annotations

@Override

longSize

back to summary

public final int longSize()

Implements abstract com.kenai.jffi.Platform.longSize.

Doc from com.kenai.jffi.Platform.longSize.

Gets the size of a C 'long' on the native platform.

Returns:int: the size of a long in bits

mapLibraryName

back to summary

public String mapLibraryName(String libName)

Overrides com.kenai.jffi.Platform.mapLibraryName.

Doc from com.kenai.jffi.Platform.mapLibraryName.

Maps from a generic library name (e.g. "c") to the platform specific library name.

Parameters

libName:String: The library name to map

Returns:String

The mapped library name.

Annotations

@Override

com.kenai.jffi back to summary

private final Class Platform.Default

Class Inheritance

extends Platform

java.lang.Object
com.kenai.jffi.Platform
com.kenai.jffi.Platform.Default

Constructor Summary

Access	Constructor and Description
public	Default(Platform.OS os)

Method Summary

Modifier and Type	Method and Description
public final int	longSize() Implements abstract com.kenai.jffi.Platform.longSize. Gets the size of a C 'long' on the native platform.

Inherited from com.kenai.jffi.Platform:: addressMask addressSize getCPU getJavaMajorVersion getLibraryNamePattern getName getOS getPlatform isSupported mapLibraryName

Constructor Detail

Default	back to summary
public Default(Platform.OS os)

Method Detail

longSize

back to summary

public final int longSize()

Implements abstract com.kenai.jffi.Platform.longSize.

Doc from com.kenai.jffi.Platform.longSize.

Gets the size of a C 'long' on the native platform.

Returns:int: the size of a long in bits

com.kenai.jffi back to summary

public final Enum Platform.OS

Class Inheritance

extends Enum<Platform.OS>

java.lang.Object
java.lang.Enum
com.kenai.jffi.Platform.OS

The common names of operating systems

Note

The names of the enum values are used in other parts of the code to determine where to find the native stub library. Do not rename.

Field Summary

Modifier and Type	Field and Description
public static final Platform.OS	AIX IBM AIX
public static final Platform.OS	DARWIN MacOSX
public static final Platform.OS	DRAGONFLY DragonFly
public static final Platform.OS	FREEBSD FreeBSD
public static final Platform.OS	IBMI IBM i
public static final Platform.OS	LINUX Linux
public static final Platform.OS	NETBSD NetBSD
public static final Platform.OS	OPENBSD OpenBSD
public static final Platform.OS	SOLARIS Solaris (and OpenSolaris)
public static final Platform.OS	UNKNOWN No idea what the operating system is
public static final Platform.OS	WINDOWS The evil borg operating system
public static final Platform.OS	ZLINUX IBM zOS

Constructor Summary

Access	Constructor and Description
private	OS()

Method Summary

Modifier and Type	Method and Description
public String	toString() Overrides java.lang.Enum.toString. Returns the name of this enum constant, as contained in the declaration.
public static Platform.OS	valueOf(String name)
public static Platform.OS[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal valueOf

Field Detail

AIX	back to summary
public static final Platform.OS AIX IBM AIX

DARWIN	back to summary
public static final Platform.OS DARWIN MacOSX

DRAGONFLY	back to summary
public static final Platform.OS DRAGONFLY DragonFly

FREEBSD	back to summary
public static final Platform.OS FREEBSD FreeBSD

IBMI	back to summary
public static final Platform.OS IBMI IBM i

LINUX	back to summary
public static final Platform.OS LINUX Linux

NETBSD	back to summary
public static final Platform.OS NETBSD NetBSD

OPENBSD	back to summary
public static final Platform.OS OPENBSD OpenBSD

SOLARIS	back to summary
public static final Platform.OS SOLARIS Solaris (and OpenSolaris)

UNKNOWN	back to summary
public static final Platform.OS UNKNOWN No idea what the operating system is

WINDOWS	back to summary
public static final Platform.OS WINDOWS The evil borg operating system

ZLINUX	back to summary
public static final Platform.OS ZLINUX IBM zOS

Constructor Detail

OS	back to summary
private OS()

Method Detail

toString

back to summary

public String toString()

Overrides java.lang.Enum.toString.

Doc from java.lang.Enum.toString.

Returns:String

the name of this enum constant

Annotations

@Override

valueOf	back to summary
public static Platform.OS valueOf(String name)

values	back to summary
public static Platform.OS[] values()

com.kenai.jffi back to summary

private final Class Platform.SingletonHolder

Class Inheritance

extends Object

java.lang.Object
com.kenai.jffi.Platform.SingletonHolder

Holds a single, lazily loaded instance of Platform

Field Summary

Modifier and Type	Field and Description
pack-priv static final Platform	PLATFORM

Constructor Summary

Access	Constructor and Description
private	SingletonHolder()

Method Summary

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

PLATFORM	back to summary
pack-priv static final Platform PLATFORM

Constructor Detail

SingletonHolder	back to summary
private SingletonHolder()

com.kenai.jffi back to summary

private final Class Platform.Windows

Class Inheritance

extends Platform

java.lang.Object
com.kenai.jffi.Platform
com.kenai.jffi.Platform.Windows

A Platform subclass representing the Windows system.

Constructor Summary

Access	Constructor and Description
public	Windows()

Method Summary

Modifier and Type	Method and Description
public String	getLibraryNamePattern() Overrides com.kenai.jffi.Platform.getLibraryNamePattern. Gets the regex string used to match platform-specific libraries
public final int	longSize() Implements abstract com.kenai.jffi.Platform.longSize. Gets the size of a C 'long' on the native platform.

Inherited from com.kenai.jffi.Platform:: addressMask addressSize getCPU getJavaMajorVersion getName getOS getPlatform isSupported mapLibraryName

Constructor Detail

Windows	back to summary
public Windows()

Method Detail

getLibraryNamePattern

back to summary

public String getLibraryNamePattern()

Overrides com.kenai.jffi.Platform.getLibraryNamePattern.

Doc from com.kenai.jffi.Platform.getLibraryNamePattern.

Gets the regex string used to match platform-specific libraries

Annotations

@Override

longSize

back to summary

public final int longSize()

Implements abstract com.kenai.jffi.Platform.longSize.

Doc from com.kenai.jffi.Platform.longSize.

Gets the size of a C 'long' on the native platform.

Returns:int: the size of a long in bits

public abstract Class Platform

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class Platform.ArchHolder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum Platform.CPU

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class Platform.Darwin

Constructor Summary

Method Summary

Constructor Detail

Method Detail

private final Class Platform.Default

Constructor Summary

Method Summary

Constructor Detail

Method Detail

public final Enum Platform.OS

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class Platform.SingletonHolder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

private final Class Platform.Windows

Constructor Summary

Method Summary

Constructor Detail

Method Detail