Package apple.foundation

Class NSFileWrapper

    • Constructor Detail

      • NSFileWrapper

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

    • Method Detail

      • accessInstanceVariablesDirectly

        public static boolean accessInstanceVariablesDirectly()

      • allocWithZone

        public static NSFileWrapper 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)

      • superclass_static

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

      • version_static

        public static long version_static()

      • addFileWrapper

        @NotNull
public @NotNull java.lang.String addFileWrapper​(@NotNull
                                                @NotNull NSFileWrapper child)
        Add a file wrapper to the receiver's children and return the file name that uniquely identifies it among the receiver's children. The unique file name will be the same as the passed-in file wrapper's preferred file name unless that name is already in use as a key into the receiver's dictionary of children. Beware of the fact that -initDirectoryWithFileWrappers:, -initRegularFileWithContents:, and -initSymbolicLinkWithDestinationURL: do not automatically set the preferred file name.

      • addRegularFileWithContentsPreferredFilename

        @NotNull
public @NotNull java.lang.String addRegularFileWithContentsPreferredFilename​(@NotNull
                                                                             @NotNull NSData data,
                                                                             @NotNull
                                                                             @NotNull java.lang.String fileName)
        A convenience method. The default implementation merely allocates a new file wrapper, initializes it with -initRegularFileWithContents:, sends it -setPreferredFileName:fileName, adds it to the receiver with -addFileWrapper:, and returns what -addFileWrapper: returned.

      • fileAttributes

        @NotNull
public @NotNull NSDictionary<java.lang.String,​?> fileAttributes()
        The file attributes, in a dictionary of the same sort as those returned by -[NSFileManager attributesOfItemAtPath:error:].

      • fileWrappers

        @Nullable
public @Nullable NSDictionary<java.lang.String,​? extends NSFileWrapper> fileWrappers()
        Return a dictionary whose values are the receiver's children and whose keys are the unique file name that has been assigned to each one. This method may return nil if the receiver is the result of reading a parent from the file system (use NSFileWrapperReadingImmediately if appropriate to prevent that).

      • filename

        @Nullable
public @Nullable java.lang.String filename()
        The actual file name. Often it will be the same as the preferred file name but might instead be a name derived from the preferred file name. You can use this method to find out the name of a child that's just been read but you should not use it to find out the name of a child that's about to be written, because the name might be about to change. Send -keyForFileWrapper: to the parent instead.

      • initDirectoryWithFileWrappers

        public NSFileWrapper initDirectoryWithFileWrappers​(@NotNull
                                                   @NotNull NSDictionary<java.lang.String,​? extends NSFileWrapper> childrenByPreferredName)
        A designated initializer for creating an instance for which -isDirectory returns YES. The passed-in dictionary must contain entries whose values are the file wrappers that are to become children and whose keys are file names. Each file wrapper that does not already have a preferred file name is sent -setPreferredFilename: with the corresponding key as the argument.

      • initRegularFileWithContents

        public NSFileWrapper initRegularFileWithContents​(@NotNull
                                                 @NotNull NSData contents)
        A designated initializer for creating an instance for which -isRegularFile returns YES.

      • initSymbolicLinkWithDestinationURL

        public NSFileWrapper initSymbolicLinkWithDestinationURL​(@NotNull
                                                        @NotNull NSURL url)
        A designated initializer for creating an instance for which -isSymbolicLink returns YES. -writeToURL:options:originalContentsURL:error: uses the result of sending -relativePath to this URL when creating a symbolic link. (An NSURL initialized by -initFileURLWithPath: returns that entire path when sent -relativePath though.) API-Since: 4.0

      • initWithSerializedRepresentation

        public NSFileWrapper initWithSerializedRepresentation​(@NotNull
                                                      @NotNull NSData serializeRepresentation)
        A designated initializer. The data must be in the same format as that returned by -serializedRepresentation.

      • initWithURLOptionsError

        public NSFileWrapper initWithURLOptionsError​(@NotNull
                                             @NotNull NSURL url,
                                             long options,
                                             @Nullable
                                             @Nullable org.moe.natj.general.ptr.Ptr<NSError> outError)
        A designated initializer for creating an instance whose kind (directory, regular file, or symbolic link) is determined based on what the URL locates. If reading is not successful return nil after setting *outError to an NSError that encapsulates the reason why the file wrapper could not be read. API-Since: 4.0

      • isDirectory

        public boolean isDirectory()
        What kind of file wrapper it is. Invocations of -readFromURL:options:error: may change what subsequent invocations of these methods return.

      • isRegularFile

        public boolean isRegularFile()

      • isSymbolicLink

        public boolean isSymbolicLink()

      • keyForFileWrapper

        @Nullable
public @Nullable java.lang.String keyForFileWrapper​(@NotNull
                                                    @NotNull NSFileWrapper child)
        Return the unique file name that has been assigned to a child or nil if it is not a child of the receiver.

      • matchesContentsOfURL

        public boolean matchesContentsOfURL​(@NotNull
                                    @NotNull NSURL url)
        Whether the receiver matches the directory, regular file, or symbolic link that is located by the URL. For a directory, children are compared against the files in the directory, recursively. The contents of files are not compared; matching of regular files is based on file modification dates. Because children of directory file wrappers are not read immediately by -initWithURL:options:error: or -readFromURL:options:error: unless NSFileWrapperReadingImmediate is used, creating a file wrapper and then later sending it this message is not a reliable way to simply check whether anything in a directory has changed. You can use this method to determine whether the receiver's contents in memory are out of date relative to the file system. API-Since: 4.0

      • preferredFilename

        @Nullable
public @Nullable java.lang.String preferredFilename()
        The file name that is "preferred." When the receiver is added to a parent directory file wrapper the parent will attempt to use this name as the key into its dictionary of children. Usually the preferred file name will actually get used in this situation but it won't be if that key is already in use. The default implementation of this method causes existing parents to remove and re-add the child to accommodate the change. Preferred file names of children are not effectively preserved when you write a file wrapper to disk and then later instantiate another file wrapper by reading. If your application needs to preserve the user-visible names of attachments it has to make its own arrangements for their storage. Some instances of NSFileWrapper may be created without a preferredFilename (e.g. -initDirectoryWithFileWrappers: or -initRegularFileWithContents:), meaning preferredFilename may be nil. However, setting nil is never allowed and will result in an exception.

      • readFromURLOptionsError

        public boolean readFromURLOptionsError​(@NotNull
                                       @NotNull NSURL url,
                                       long options,
                                       @Nullable
                                       @Nullable org.moe.natj.general.ptr.Ptr<NSError> outError)
        Recursively reread the entire contents of the receiver from the specified location, and return YES if successful. If not successful, return NO after setting *outError to an NSError that encapsulates the reason why the file wrapper could not be reread. When reading a directory children are added and removed as necessary to match the file system. API-Since: 4.0

      • regularFileContents

        @Nullable
public @Nullable NSData regularFileContents()
        Return the receiver's contents. This may return nil if the receiver is the result of reading a parent from the file system (use NSFileWrapperReadingImmediately if appropriate to prevent that).

      • removeFileWrapper

        public void removeFileWrapper​(@NotNull
                              @NotNull NSFileWrapper child)
        Remove a file wrapper from the receiver's children.

      • serializedRepresentation

        @Nullable
public @Nullable NSData serializedRepresentation()
        Return an NSData suitable for passing to -initWithSerializedRepresentation:. This method may return nil if the receiver is the result of reading from the file system (use NSFileWrapperReadingImmediately if appropriate to prevent that).

      • setFileAttributes

        public void setFileAttributes​(@NotNull
                              @NotNull NSDictionary<java.lang.String,​?> value)
        The file attributes, in a dictionary of the same sort as those returned by -[NSFileManager attributesOfItemAtPath:error:].

      • setFilename

        public void setFilename​(@Nullable
                        @Nullable java.lang.String value)
        The actual file name. Often it will be the same as the preferred file name but might instead be a name derived from the preferred file name. You can use this method to find out the name of a child that's just been read but you should not use it to find out the name of a child that's about to be written, because the name might be about to change. Send -keyForFileWrapper: to the parent instead.

      • setPreferredFilename

        public void setPreferredFilename​(@Nullable
                                 @Nullable java.lang.String value)
        The file name that is "preferred." When the receiver is added to a parent directory file wrapper the parent will attempt to use this name as the key into its dictionary of children. Usually the preferred file name will actually get used in this situation but it won't be if that key is already in use. The default implementation of this method causes existing parents to remove and re-add the child to accommodate the change. Preferred file names of children are not effectively preserved when you write a file wrapper to disk and then later instantiate another file wrapper by reading. If your application needs to preserve the user-visible names of attachments it has to make its own arrangements for their storage. Some instances of NSFileWrapper may be created without a preferredFilename (e.g. -initDirectoryWithFileWrappers: or -initRegularFileWithContents:), meaning preferredFilename may be nil. However, setting nil is never allowed and will result in an exception.

      • symbolicLinkDestinationURL

        @Nullable
public @Nullable NSURL symbolicLinkDestinationURL()
        Return the destination link of the receiver. This may return nil if the receiver is the result of reading a parent from the file system (use NSFileWrapperReadingImmediately if appropriate to prevent that). API-Since: 4.0

      • writeToURLOptionsOriginalContentsURLError

        public boolean writeToURLOptionsOriginalContentsURLError​(@NotNull
                                                         @NotNull NSURL url,
                                                         long options,
                                                         @Nullable
                                                         @Nullable NSURL originalContentsURL,
                                                         @Nullable
                                                         @Nullable org.moe.natj.general.ptr.Ptr<NSError> outError)
        Recursively write the entire contents of the receiver at the specified location, and return YES if successful. If not successful, return NO after setting *outError to an NSError that encapsulates the reason why the file wrapper could not be written. originalContentsURL may be nil or it may be the location of a previous revision of what is being written. If it is not nil the default implementation of this method attempts to avoid unnecessary I/O by merely writing hard links to regular files instead of actually writing out their contents. The descendant file wrappers must return accurate values when sent -filename for this to work (use NSFileWrapperWritingWithNameUpdating to increase the likelihood of that). API-Since: 4.0

      • supportsSecureCoding

        public static boolean supportsSecureCoding()

      • _supportsSecureCoding

        public boolean _supportsSecureCoding()
        Description copied from interface: NSSecureCoding
        This property must return YES on all classes that allow secure coding. Subclasses of classes that adopt NSSecureCoding and override initWithCoder: must also override this method and return YES. The Secure Coding Guide should be consulted when writing methods that decode data.
        Specified by:
        _supportsSecureCoding in interface NSSecureCoding

      • useStoredAccessor

        @Deprecated
public static boolean useStoredAccessor()
        Deprecated.