-
Notifications
You must be signed in to change notification settings - Fork 39
/
Files.java
86 lines (79 loc) · 4.15 KB
/
Files.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
/*
* Copyright 2012 Adam Murdoch
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package net.rubygrapefruit.platform.file;
import net.rubygrapefruit.platform.NativeException;
import net.rubygrapefruit.platform.NativeIntegration;
import net.rubygrapefruit.platform.ThreadSafe;
import java.io.File;
import java.util.List;
/**
* Functions to query and modify files. There are several sub-types of this interface that allow access to
* platform specific file features.
*/
public interface Files extends NativeIntegration {
/**
* Returns basic information about the given file. Returns whatever file details can be efficiently calculated
* in a single system call, which is more efficient that querying these details separately.
*
* <p>When the file references a symlink, details about the symlink is returned, not the target of the symlink.
*
* @param file The path of the file to get details of. Follows symlinks to the parent directory of this file.
* @return Details of the file. Returns details with type {@link FileInfo.Type#Missing} for a file that does not
* exist.
* @throws NativeException On failure to query the file information.
* @throws FilePermissionException When the user has insufficient permissions to query the file information
*/
@ThreadSafe
FileInfo stat(File file) throws NativeException;
/**
* Returns basic information about the given file. Returns whatever file details can be efficiently calculated
* in a single system call, which is more efficient that querying these details separately.
*
* @param file The path of the file to get details of. Follows symlinks to the parent directory of this file.
* @param linkTarget When true and the file is a symlink, return details of the target of the symlink instead of details of the symlink itself.
* @return Details of the file. Returns details with type {@link FileInfo.Type#Missing} for a file that does not
* exist.
* @throws NativeException On failure to query the file information.
* @throws FilePermissionException When the user has insufficient permissions to query the file information
*/
@ThreadSafe
FileInfo stat(File file, boolean linkTarget) throws NativeException;
/**
* Lists the entries of the given directory.
*
* <p>When a directory entry is a symlink, details about the symlink is returned, not the target of the symlink.</p>
*
* @param dir The path of the directory to list. Follows symlinks to this directory.
* @throws NativeException On failure.
* @throws NoSuchFileException When the specified directory does not exist.
* @throws NotADirectoryException When the specified file is not a directory.
* @throws FilePermissionException When the user has insufficient permissions to list the entries
*/
@ThreadSafe
List<? extends DirEntry> listDir(File dir) throws NativeException;
/**
* Lists the entries of the given directory.
*
* @param dir The path of the directory to list. Follows symlinks to this directory.
* @param linkTarget When true and a directory entry is a symlink, return details of the target of the symlink instead of details of the symlink itself.
* @throws NativeException On failure.
* @throws NoSuchFileException When the specified directory does not exist.
* @throws NotADirectoryException When the specified file is not a directory.
* @throws FilePermissionException When the user has insufficient permissions to list the entries
*/
@ThreadSafe
List<? extends DirEntry> listDir(File dir, boolean linkTarget) throws NativeException;
}