Package oshi.jna.platform.mac

Interface CoreFoundation

All Superinterfaces:

com.sun.jna.platform.mac.CoreFoundation, com.sun.jna.Library

public interface CoreFoundation
extends com.sun.jna.platform.mac.CoreFoundation

CoreFoundation class. This class should be considered non-API as it may be removed if/when its code is incorporated into the JNA project.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	CoreFoundation.CFDateFormatter	CFDateFormatter objects format the textual representations of CFDate and CFAbsoluteTime objects, and convert textual representations of dates and times into CFDate and CFAbsoluteTime objects.
static enum	CoreFoundation.CFDateFormatterStyle	Enum of values used for CoreFoundation.CFDateFormatterStyle in CFDateFormatterCreate(com.sun.jna.platform.mac.CoreFoundation.CFAllocatorRef, oshi.jna.platform.mac.CoreFoundation.CFLocale, com.sun.jna.platform.mac.CoreFoundation.CFIndex, com.sun.jna.platform.mac.CoreFoundation.CFIndex).
static class	CoreFoundation.CFLocale	The CFLocale opaque type provides support for obtaining available locales, obtaining localized locale names, and converting among locale data formats.

Nested classes/interfaces inherited from interface com.sun.jna.platform.mac.CoreFoundation

com.sun.jna.platform.mac.CoreFoundation.CFAllocatorRef, com.sun.jna.platform.mac.CoreFoundation.CFArrayRef, com.sun.jna.platform.mac.CoreFoundation.CFBooleanRef, com.sun.jna.platform.mac.CoreFoundation.CFDataRef, com.sun.jna.platform.mac.CoreFoundation.CFDictionaryRef, com.sun.jna.platform.mac.CoreFoundation.CFIndex, com.sun.jna.platform.mac.CoreFoundation.CFMutableDictionaryRef, com.sun.jna.platform.mac.CoreFoundation.CFNumberRef, com.sun.jna.platform.mac.CoreFoundation.CFNumberType, com.sun.jna.platform.mac.CoreFoundation.CFStringRef, com.sun.jna.platform.mac.CoreFoundation.CFTypeID, com.sun.jna.platform.mac.CoreFoundation.CFTypeRef

Nested classes/interfaces inherited from interface com.sun.jna.Library

com.sun.jna.Library.Handler

Field Summary

Fields

Modifier and Type	Field	Description
static final CoreFoundation	INSTANCE

Fields inherited from interface com.sun.jna.platform.mac.CoreFoundation

ARRAY_TYPE_ID, BOOLEAN_TYPE_ID, DATA_TYPE_ID, DATE_TYPE_ID, DICTIONARY_TYPE_ID, kCFNotFound, kCFStringEncodingASCII, kCFStringEncodingUTF8, NUMBER_TYPE_ID, STRING_TYPE_ID

Fields inherited from interface com.sun.jna.Library

OPTION_ALLOW_OBJECTS, OPTION_CALLING_CONVENTION, OPTION_CLASSLOADER, OPTION_FUNCTION_MAPPER, OPTION_INVOCATION_MAPPER, OPTION_OPEN_FLAGS, OPTION_STRING_ENCODING, OPTION_STRUCTURE_ALIGNMENT, OPTION_SYMBOL_PROVIDER, OPTION_TYPE_MAPPER

Method Summary

Modifier and Type	Method	Description
CoreFoundation.CFDateFormatter	CFDateFormatterCreate(com.sun.jna.platform.mac.CoreFoundation.CFAllocatorRef allocator, CoreFoundation.CFLocale locale, com.sun.jna.platform.mac.CoreFoundation.CFIndex dateStyle, com.sun.jna.platform.mac.CoreFoundation.CFIndex timeStyle)	Creates a new CFDateFormatter object, localized to the given locale, which will format dates to the given date and time styles.
com.sun.jna.platform.mac.CoreFoundation.CFStringRef	CFDateFormatterGetFormat(CoreFoundation.CFDateFormatter formatter)	Returns a format string for the given date formatter object.
CoreFoundation.CFLocale	CFLocaleCopyCurrent()	Returns a copy of the logical locale for the current user.

Methods inherited from interface com.sun.jna.platform.mac.CoreFoundation

CFAllocatorGetDefault, CFArrayCreate, CFArrayGetCount, CFArrayGetTypeID, CFArrayGetValueAtIndex, CFBooleanGetTypeID, CFBooleanGetValue, CFCopyDescription, CFDataCreate, CFDataGetBytePtr, CFDataGetLength, CFDataGetTypeID, CFDateGetTypeID, CFDictionaryCreateMutable, CFDictionaryGetCount, CFDictionaryGetTypeID, CFDictionaryGetValue, CFDictionaryGetValueIfPresent, CFDictionarySetValue, CFEqual, CFGetRetainCount, CFGetTypeID, CFGetTypeID, CFNumberCreate, CFNumberGetType, CFNumberGetTypeID, CFNumberGetValue, CFRelease, CFRetain, CFStringCreateWithCharacters, CFStringGetCString, CFStringGetLength, CFStringGetMaximumSizeForEncoding, CFStringGetTypeID

Field Details

INSTANCE

static final CoreFoundation INSTANCE

Method Details

CFLocaleCopyCurrent

CoreFoundation.CFLocale CFLocaleCopyCurrent()

Returns a copy of the logical locale for the current user.

Returns:

The logical locale for the current user that is formed from the settings for the current user’s chosen system locale overlaid with any custom settings the user has specified in System Preferences. May return a retained cached object, not a new object.

This reference must be released with CoreFoundation.CFRelease(com.sun.jna.platform.mac.CoreFoundation.CFTypeRef) to avoid leaking references.

CFDateFormatterCreate

CoreFoundation.CFDateFormatter CFDateFormatterCreate(com.sun.jna.platform.mac.CoreFoundation.CFAllocatorRef allocator,
 CoreFoundation.CFLocale locale,
 com.sun.jna.platform.mac.CoreFoundation.CFIndex dateStyle,
 com.sun.jna.platform.mac.CoreFoundation.CFIndex timeStyle)

Creates a new CFDateFormatter object, localized to the given locale, which will format dates to the given date and time styles.

Parameters:

allocator - The allocator to use to allocate memory for the new object. Pass null or kCFAllocatorDefault to use the current default allocator.

locale - The locale to use for localization. If null uses the default system locale. Use CFLocaleCopyCurrent() to specify the locale of the current user.

dateStyle - The date style to use when formatting dates.

timeStyle - The time style to use when formatting times.

Returns:

A new date formatter, localized to the given locale, which will format dates to the given date and time styles. Returns null if there was a problem creating the object.

This reference must be released with CoreFoundation.CFRelease(com.sun.jna.platform.mac.CoreFoundation.CFTypeRef) to avoid leaking references.

CFDateFormatterGetFormat

com.sun.jna.platform.mac.CoreFoundation.CFStringRef CFDateFormatterGetFormat(CoreFoundation.CFDateFormatter formatter)

Returns a format string for the given date formatter object.

Parameters:

formatter - The date formatter to examine.

Returns:

The format string for formatter.