Nested and Inner Type Summary

Modifier and Type	Class and Description
private static class	Platform.AIX A `Platform` subclass representing the Linux operating system.
public static enum	Platform.CPU_TYPE
private static class	Platform.Darwin A `Platform` subclass representing the MacOS system.
private static class	Platform.Default
private static class	Platform.Linux A `Platform` subclass representing the Linux operating system.
public static enum	Platform.OS_TYPE
private static class	Platform.SingletonHolder
private static class	Platform.Supported
private static class	Platform.Unsupported
private static class	Platform.Windows A `Platform` subclass representing the Windows system.

Field Summary

Modifier and Type	Field and Description
private final long	addressMask
protected final int	addressSize
private static final int	ARCH_DATA_MODEL
public static final int	BIG_ENDIAN
public static final int	BYTE_ORDER
public static final Platform.CPU_TYPE	CPU
public static final String	LIBC
protected final Pattern	libPattern
public static final String	LIBPREFIX
public static final String	LIBSUFFIX
public static final int	LITTLE_ENDIAN
private static final Locale	LOCALE
protected final int	longSize
public static final String	NAME
public static final Platform.OS_TYPE	OS

Access	Constructor and Description
protected	Platform(Platform.OS_TYPE os)

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.
public static IRubyObject	bsd_p(ThreadContext context, IRubyObject recv)
public static void	createPlatformModule(ThreadContext context, RubyModule FFI)
private static int	determineArchDataModel()
private static final Platform.CPU_TYPE	determineCPU()
private static final String	determineLibC()
private static final String	determineLibExt()
private static final Platform.OS_TYPE	determineOS()
private static final Platform	determinePlatform(Platform.OS_TYPE os)
public final Platform.CPU_TYPE	Returns: A `CPU` value representing the current processor architecture. getCPU() Gets the current processor architecture the JVM is running on.
public final int	getJavaMajorVersion() Deprecated
public String	Returns: The name of this platform. getName() Gets the name of this `Platform`.
public final Platform.OS_TYPE	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 static String	Returns: The value of the system property, or the default value. getProperty(String The system property name. property, String The default value. defValue) An extension over `System.getProperty` method.
public final boolean	isBSD()
public final boolean	isSupported()
public final boolean	isUnix()
public static IRubyObject	linux_p(ThreadContext context, IRubyObject recv)
public final int	Returns: the size of a long in bits longSize() Gets the size of a C 'long' on the native platform.
public static IRubyObject	mac_p(ThreadContext context, IRubyObject recv)
public String	mapLibraryName(String libName)
public static IRubyObject	solaris_p(ThreadContext context, IRubyObject recv)
private static boolean	startsWithIgnoreCase(String s1, String s2)
public static IRubyObject	unix_p(ThreadContext context, IRubyObject recv)
public static IRubyObject	windows_p(ThreadContext context, IRubyObject recv)

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

Field Detail

addressMask	back to summary
private final long addressMask

addressSize	back to summary
protected final int addressSize

ARCH_DATA_MODEL	back to summary
private static final int ARCH_DATA_MODEL

BIG_ENDIAN	back to summary
public static final int BIG_ENDIAN

BYTE_ORDER	back to summary
public static final int BYTE_ORDER

CPU	back to summary
public static final Platform.CPU_TYPE CPU

LIBC	back to summary
public static final String LIBC

libPattern	back to summary
protected final Pattern libPattern

LIBPREFIX	back to summary
public static final String LIBPREFIX

LIBSUFFIX	back to summary
public static final String LIBSUFFIX

LITTLE_ENDIAN	back to summary
public static final int LITTLE_ENDIAN

LOCALE	back to summary
private static final Locale LOCALE

longSize	back to summary
protected final int longSize

NAME	back to summary
public static final String NAME

OS	back to summary
public static final Platform.OS_TYPE OS

Constructor Detail

Platform	back to summary
protected Platform(Platform.OS_TYPE os)

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

bsd_p	back to summary
public static IRubyObject bsd_p(ThreadContext context, IRubyObject recv) Annotations @JRubyMethod name:bsd? module:true

createPlatformModule	back to summary
public static void createPlatformModule(ThreadContext context, RubyModule FFI)

determineArchDataModel	back to summary
private static int determineArchDataModel()

determineCPU	back to summary
private static final Platform.CPU_TYPE determineCPU()

determineLibC	back to summary
private static final String determineLibC()

determineLibExt	back to summary
private static final String determineLibExt()

determineOS	back to summary
private static final Platform.OS_TYPE determineOS()

determinePlatform	back to summary
private static final Platform determinePlatform(Platform.OS_TYPE os)

getCPU back to summary

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

public final Platform.CPU_TYPE getCPU()

Gets the current processor architecture the JVM is running on.

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

getJavaMajorVersion	back to summary
public final int getJavaMajorVersion() Deprecated Annotations @Deprecated

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_TYPE getOS() Gets the current Operating System. Returns:Platform.OS_TYPE A `OS` value representing the current Operating System.

public final Platform.OS_TYPE getOS()

Gets the current Operating System.

Returns:Platform.OS_TYPE: 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.

getProperty back to summary

getProperty	back to summary
public static String getProperty(String property, String defValue) An extension over `System.getProperty` method. Handles security restrictions, and returns the default value if the access to the property is restricted. Parameters property:String The system property name. defValue:String The default value. Returns:String The value of the system property, or the default value.

public static String getProperty(String property, String defValue)

An extension over System.getProperty method. Handles security restrictions, and returns the default value if the access to the property is restricted.

Parameters

property:String: The system property name.
defValue:String: The default value.

Returns:String

The value of the system property, or the default value.

isBSD	back to summary
public final boolean isBSD()

isSupported	back to summary
public final boolean isSupported()

isUnix	back to summary
public final boolean isUnix()

linux_p	back to summary
public static IRubyObject linux_p(ThreadContext context, IRubyObject recv) Annotations @JRubyMethod name:linux? module:true

longSize	back to summary
public final 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 final int longSize()

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

Returns:int: the size of a long in bits

mac_p	back to summary
public static IRubyObject mac_p(ThreadContext context, IRubyObject recv) Annotations @JRubyMethod name:mac? module:true

mapLibraryName	back to summary
public String mapLibraryName(String libName)

solaris_p	back to summary
public static IRubyObject solaris_p(ThreadContext context, IRubyObject recv) Annotations @JRubyMethod name:solaris? module:true

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

unix_p	back to summary
public static IRubyObject unix_p(ThreadContext context, IRubyObject recv) Annotations @JRubyMethod name:unix? module:true

windows_p	back to summary
public static IRubyObject windows_p(ThreadContext context, IRubyObject recv) Annotations @JRubyMethod name:windows? module:true

org.jruby.ext.ffi back to summary

private final Class Platform.AIX

Class Inheritance

extends Supported

A Platform subclass representing the Linux operating system.

Constructor Summary

Access	Constructor and Description
public	AIX()

Method Summary

Modifier and Type	Method and Description
public String	mapLibraryName(String libName) Overrides org.jruby.ext.ffi.Platform.mapLibraryName.

Constructor Detail

AIX	back to summary
public AIX()

Method Detail

mapLibraryName

back to summary

public String mapLibraryName(String libName)

Overrides org.jruby.ext.ffi.Platform.mapLibraryName.

Annotations

@Override

org.jruby.ext.ffi back to summary

public final Enum Platform.CPU_TYPE

Class Inheritance

extends Enum<Platform.CPU_TYPE>

java.lang.Object
java.lang.Enum
org.jruby.ext.ffi.Platform.CPU_TYPE

Field Summary

Modifier and Type	Field and Description
public static final Platform.CPU_TYPE	AARCH64
public static final Platform.CPU_TYPE	ARM
public static final Platform.CPU_TYPE	I386
public static final Platform.CPU_TYPE	LOONGARCH64
public static final Platform.CPU_TYPE	POWERPC
public static final Platform.CPU_TYPE	POWERPC64
public static final Platform.CPU_TYPE	POWERPC64LE
public static final Platform.CPU_TYPE	S390X
public static final Platform.CPU_TYPE	SPARC
public static final Platform.CPU_TYPE	SPARCV9
public static final Platform.CPU_TYPE	UNKNOWN
public static final Platform.CPU_TYPE	X86_64

Constructor Summary

Access	Constructor and Description
private	CPU_TYPE()

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_TYPE	valueOf(String name)
public static Platform.CPU_TYPE[]	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_TYPE AARCH64

ARM	back to summary
public static final Platform.CPU_TYPE ARM

I386	back to summary
public static final Platform.CPU_TYPE I386

LOONGARCH64	back to summary
public static final Platform.CPU_TYPE LOONGARCH64

POWERPC	back to summary
public static final Platform.CPU_TYPE POWERPC

POWERPC64	back to summary
public static final Platform.CPU_TYPE POWERPC64

POWERPC64LE	back to summary
public static final Platform.CPU_TYPE POWERPC64LE

S390X	back to summary
public static final Platform.CPU_TYPE S390X

SPARC	back to summary
public static final Platform.CPU_TYPE SPARC

SPARCV9	back to summary
public static final Platform.CPU_TYPE SPARCV9

UNKNOWN	back to summary
public static final Platform.CPU_TYPE UNKNOWN

X86_64	back to summary
public static final Platform.CPU_TYPE X86_64

Constructor Detail

CPU_TYPE	back to summary
private CPU_TYPE()

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

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

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

org.jruby.ext.ffi back to summary

private final Class Platform.Darwin

Class Inheritance

extends Supported

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	mapLibraryName(String libName) Overrides org.jruby.ext.ffi.Platform.mapLibraryName.

Constructor Detail

Darwin	back to summary
public Darwin()

Method Detail

mapLibraryName

back to summary

public String mapLibraryName(String libName)

Overrides org.jruby.ext.ffi.Platform.mapLibraryName.

Annotations

@Override

org.jruby.ext.ffi back to summary

private final Class Platform.Default

Class Inheritance

extends Platform

java.lang.Object
org.jruby.ext.ffi.Platform
org.jruby.ext.ffi.Platform.Default

Field Summary

Inherited from org.jruby.ext.ffi.Platform:: addressSize BIG_ENDIAN BYTE_ORDER CPU LIBC libPattern LIBPREFIX LIBSUFFIX LITTLE_ENDIAN longSize NAME OS

Constructor Summary

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

Method Summary

Constructor Detail

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

org.jruby.ext.ffi back to summary

private final Class Platform.Linux

Class Inheritance

extends Supported

A Platform subclass representing the Linux operating system.

Constructor Summary

Access	Constructor and Description
public	Linux()

Method Summary

Modifier and Type	Method and Description
public String	mapLibraryName(String libName) Overrides org.jruby.ext.ffi.Platform.mapLibraryName.

Constructor Detail

Linux	back to summary
public Linux()

Method Detail

mapLibraryName

back to summary

public String mapLibraryName(String libName)

Overrides org.jruby.ext.ffi.Platform.mapLibraryName.

Annotations

@Override

org.jruby.ext.ffi back to summary

public final Enum Platform.OS_TYPE

Class Inheritance

extends Enum<Platform.OS_TYPE>

java.lang.Object
java.lang.Enum
org.jruby.ext.ffi.Platform.OS_TYPE

Field Summary

Modifier and Type	Field and Description
public static final Platform.OS_TYPE	AIX
public static final Platform.OS_TYPE	DARWIN
public static final Platform.OS_TYPE	DRAGONFLYBSD
public static final Platform.OS_TYPE	FREEBSD
public static final Platform.OS_TYPE	LINUX
public static final Platform.OS_TYPE	NETBSD
public static final Platform.OS_TYPE	OPENBSD
public static final Platform.OS_TYPE	SOLARIS
public static final Platform.OS_TYPE	UNKNOWN
public static final Platform.OS_TYPE	WINDOWS

Constructor Summary

Access	Constructor and Description
private	OS_TYPE()

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_TYPE	valueOf(String name)
public static Platform.OS_TYPE[]	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_TYPE AIX

DARWIN	back to summary
public static final Platform.OS_TYPE DARWIN

DRAGONFLYBSD	back to summary
public static final Platform.OS_TYPE DRAGONFLYBSD

FREEBSD	back to summary
public static final Platform.OS_TYPE FREEBSD

LINUX	back to summary
public static final Platform.OS_TYPE LINUX

NETBSD	back to summary
public static final Platform.OS_TYPE NETBSD

OPENBSD	back to summary
public static final Platform.OS_TYPE OPENBSD

SOLARIS	back to summary
public static final Platform.OS_TYPE SOLARIS

UNKNOWN	back to summary
public static final Platform.OS_TYPE UNKNOWN

WINDOWS	back to summary
public static final Platform.OS_TYPE WINDOWS

Constructor Detail

OS_TYPE	back to summary
private OS_TYPE()

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_TYPE valueOf(String name)

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

public Class Platform

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class Platform.AIX

Constructor Summary

Method Summary

Constructor Detail

Method Detail

public final Enum Platform.CPU_TYPE

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

Field Summary

Constructor Summary

Method Summary

Constructor Detail

private final Class Platform.Linux

Constructor Summary

Method Summary

Constructor Detail

Method Detail

public final Enum Platform.OS_TYPE

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 Class Platform.Supported

Field Summary

Constructor Summary

Method Summary

Constructor Detail

private Class Platform.Unsupported

Field Summary

Constructor Summary

Method Summary

Constructor Detail

private Class Platform.Windows

Constructor Summary

Constructor Detail