Package apple.foundation

Class NSByteCountFormatter

    • Constructor Detail

      • NSByteCountFormatter

        protected NSByteCountFormatter​(org.moe.natj.general.Pointer peer)

    • Method Detail

      • accessInstanceVariablesDirectly

        public static boolean accessInstanceVariablesDirectly()

      • allocWithZone

        public static NSByteCountFormatter allocWithZone​(org.moe.natj.general.ptr.VoidPtr zone)

      • automaticallyNotifiesObserversForKey

        public static boolean automaticallyNotifiesObserversForKey​(@NotNull
                                                           @NotNull java.lang.String key)

      • cancelPreviousPerformRequestsWithTarget

        public static void cancelPreviousPerformRequestsWithTarget​(@NotNull
                                                           @NotNull java.lang.Object aTarget)

      • cancelPreviousPerformRequestsWithTargetSelectorObject

        public static void cancelPreviousPerformRequestsWithTargetSelectorObject​(@NotNull
                                                                         @NotNull java.lang.Object aTarget,
                                                                         @NotNull
                                                                         @NotNull org.moe.natj.objc.SEL aSelector,
                                                                         @Nullable
                                                                         @Nullable java.lang.Object anArgument)

      • classFallbacksForKeyedArchiver

        @NotNull
public static @NotNull NSArray<java.lang.String> classFallbacksForKeyedArchiver()

      • classForKeyedUnarchiver

        @NotNull
public static @NotNull org.moe.natj.objc.Class classForKeyedUnarchiver()

      • debugDescription_static

        public static java.lang.String debugDescription_static()

      • description_static

        public static java.lang.String description_static()

      • hash_static

        public static long hash_static()

      • instanceMethodSignatureForSelector

        public static NSMethodSignature instanceMethodSignatureForSelector​(org.moe.natj.objc.SEL aSelector)

      • instancesRespondToSelector

        public static boolean instancesRespondToSelector​(org.moe.natj.objc.SEL aSelector)

      • isSubclassOfClass

        public static boolean isSubclassOfClass​(org.moe.natj.objc.Class aClass)

      • keyPathsForValuesAffectingValueForKey

        @NotNull
public static @NotNull NSSet<java.lang.String> keyPathsForValuesAffectingValueForKey​(@NotNull
                                                                                     @NotNull java.lang.String key)

      • resolveClassMethod

        public static boolean resolveClassMethod​(org.moe.natj.objc.SEL sel)

      • resolveInstanceMethod

        public static boolean resolveInstanceMethod​(org.moe.natj.objc.SEL sel)

      • setVersion_static

        public static void setVersion_static​(long aVersion)

      • stringFromByteCountCountStyle

        @NotNull
public static @NotNull java.lang.String stringFromByteCountCountStyle​(long byteCount,
                                                                      long countStyle)
        Shortcut for converting a byte count into a string without creating an NSByteCountFormatter and an NSNumber. If you need to specify options other than countStyle, create an instance of NSByteCountFormatter first.

      • superclass_static

        public static org.moe.natj.objc.Class superclass_static()

      • version_static

        public static long version_static()

      • allowedUnits

        public long allowedUnits()
        Specify the units that can be used in the output. If NSByteCountFormatterUseDefault, uses platform-appropriate settings; otherwise will only use the specified units. This is the default value. Note that ZB and YB cannot be covered by the range of possible values, but you can still choose to use these units to get fractional display ("0.0035 ZB" for instance).

      • allowsNonnumericFormatting

        public boolean allowsNonnumericFormatting()
        Choose whether to allow more natural display of some values, such as zero, where it may be displayed as "Zero KB," ignoring all other flags or options (with the exception of NSByteCountFormatterUseBytes, which would generate "Zero bytes"). The result is appropriate for standalone output. Default value is YES. Special handling of certain values such as zero is especially important in some languages, so it's highly recommended that this property be left in its default state.

      • countStyle

        public long countStyle()
        Specify how the count is displayed by indicating the number of bytes to be used for kilobyte. The default setting is NSByteCountFormatterFileCount, which is the system specific value for file and storage sizes.

      • formattingContext

        public long formattingContext()
        Specify the formatting context for the formatted string. Default is NSFormattingContextUnknown. API-Since: 8.0

      • includesActualByteCount

        public boolean includesActualByteCount()
        Choose whether to parenthetically (localized as appropriate) display the actual number of bytes as well, for instance "723 KB (722,842 bytes)". This will happen only if needed, that is, the first part is already not showing the exact byte count. If includesUnit or includesCount are NO, then this setting has no effect. Default value is NO.

      • includesCount

        public boolean includesCount()

      • includesUnit

        public boolean includesUnit()
        Choose whether to include the number or the units in the resulting formatted string. (For example, instead of 723 KB, returns "723" or "KB".) You can call the API twice to get both parts, separately. But note that putting them together yourself via string concatenation may be wrong for some locales; so use this functionality with care. Both of these values are YES by default. Setting both to NO will unsurprisingly result in an empty string.

      • isAdaptive

        public boolean isAdaptive()
        Choose the display style. The "adaptive" algorithm is platform specific and uses a different number of fraction digits based on the magnitude (in 10.8: 0 fraction digits for bytes and KB; 1 fraction digits for MB; 2 for GB and above). Otherwise the result always tries to show at least three significant digits, introducing fraction digits as necessary. Default is YES.

      • setAdaptive

        public void setAdaptive​(boolean value)
        Choose the display style. The "adaptive" algorithm is platform specific and uses a different number of fraction digits based on the magnitude (in 10.8: 0 fraction digits for bytes and KB; 1 fraction digits for MB; 2 for GB and above). Otherwise the result always tries to show at least three significant digits, introducing fraction digits as necessary. Default is YES.

      • setAllowedUnits

        public void setAllowedUnits​(long value)
        Specify the units that can be used in the output. If NSByteCountFormatterUseDefault, uses platform-appropriate settings; otherwise will only use the specified units. This is the default value. Note that ZB and YB cannot be covered by the range of possible values, but you can still choose to use these units to get fractional display ("0.0035 ZB" for instance).

      • setAllowsNonnumericFormatting

        public void setAllowsNonnumericFormatting​(boolean value)
        Choose whether to allow more natural display of some values, such as zero, where it may be displayed as "Zero KB," ignoring all other flags or options (with the exception of NSByteCountFormatterUseBytes, which would generate "Zero bytes"). The result is appropriate for standalone output. Default value is YES. Special handling of certain values such as zero is especially important in some languages, so it's highly recommended that this property be left in its default state.

      • setCountStyle

        public void setCountStyle​(long value)
        Specify how the count is displayed by indicating the number of bytes to be used for kilobyte. The default setting is NSByteCountFormatterFileCount, which is the system specific value for file and storage sizes.

      • setFormattingContext

        public void setFormattingContext​(long value)
        Specify the formatting context for the formatted string. Default is NSFormattingContextUnknown. API-Since: 8.0

      • setIncludesActualByteCount

        public void setIncludesActualByteCount​(boolean value)
        Choose whether to parenthetically (localized as appropriate) display the actual number of bytes as well, for instance "723 KB (722,842 bytes)". This will happen only if needed, that is, the first part is already not showing the exact byte count. If includesUnit or includesCount are NO, then this setting has no effect. Default value is NO.

      • setIncludesCount

        public void setIncludesCount​(boolean value)

      • setIncludesUnit

        public void setIncludesUnit​(boolean value)
        Choose whether to include the number or the units in the resulting formatted string. (For example, instead of 723 KB, returns "723" or "KB".) You can call the API twice to get both parts, separately. But note that putting them together yourself via string concatenation may be wrong for some locales; so use this functionality with care. Both of these values are YES by default. Setting both to NO will unsurprisingly result in an empty string.

      • setZeroPadsFractionDigits

        public void setZeroPadsFractionDigits​(boolean value)
        Choose whether to zero pad fraction digits so a consistent number of fraction digits are displayed, causing updating displays to remain more stable. For instance, if the adaptive algorithm is used, this option formats 1.19 and 1.2 GB as "1.19 GB" and "1.20 GB" respectively, while without the option the latter would be displayed as "1.2 GB". Default value is NO.

      • stringFromByteCount

        @NotNull
public @NotNull java.lang.String stringFromByteCount​(long byteCount)
        Convenience method on stringForObjectValue:. Convert a byte count into a string without creating an NSNumber.

      • zeroPadsFractionDigits

        public boolean zeroPadsFractionDigits()
        Choose whether to zero pad fraction digits so a consistent number of fraction digits are displayed, causing updating displays to remain more stable. For instance, if the adaptive algorithm is used, this option formats 1.19 and 1.2 GB as "1.19 GB" and "1.20 GB" respectively, while without the option the latter would be displayed as "1.2 GB". Default value is NO.

      • stringForObjectValue

        @Nullable
public @Nullable java.lang.String stringForObjectValue​(@Nullable
                                                       @Nullable java.lang.Object obj)
        Formats `obj` as a byte count (if `obj` is an `NSNumber`) or specific byte measurement (if `obj` is an `NSMeasurement`) using the receiver's settings. Returns `nil` if `obj` is not of the correct class (`NSNumber` or `NSMeasurement`). Throws an exception if `obj` is an `NSMeasurement` whose unit does not belong to the `NSUnitInformationStorage` dimension.
        Overrides:
        stringForObjectValue in class NSFormatter

      • stringFromMeasurement

        @NotNull
public @NotNull java.lang.String stringFromMeasurement​(@NotNull
                                                       @NotNull NSMeasurement<NSUnitInformationStorage> measurement)
        Formats the value of the given measurement using the receiver's `countStyle`. Converts the measurement to the units allowed by the receiver's `allowedUnits` before formatting; depending on the value of the measurement, this may result in a string which implies an approximate value (e.g. if the measurement is too large to represent in `allowedUnits`, like `1e20 YB` expressed in `NSByteCountFormatterUseBytes`). Throws an exception if the given measurement's unit does not belong to the `NSUnitInformationStorage` dimension. API-Since: 13.0

      • stringFromMeasurementCountStyle

        @NotNull
public static @NotNull java.lang.String stringFromMeasurementCountStyle​(@NotNull
                                                                        @NotNull NSMeasurement<NSUnitInformationStorage> measurement,
                                                                        long countStyle)
        Formats the value of the given measurement using the given `countStyle`. Throws an exception if the given measurement's unit does not belong to the `NSUnitInformationStorage` dimension. API-Since: 13.0

      • useStoredAccessor

        @Deprecated
public static boolean useStoredAccessor()
        Deprecated.