-
Notifications
You must be signed in to change notification settings - Fork 4.6k
/
Directory.java
93 lines (83 loc) · 3.31 KB
/
Directory.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
87
88
89
90
91
92
93
/*
* Copyright 2017 the original author or authors.
*
* 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 org.gradle.api.file;
import org.gradle.api.provider.Provider;
import java.io.File;
/**
* Represents a directory at some fixed location on the file system.
* <p>
* <b>Note:</b> This interface is not intended for implementation by build script or plugin authors. An instance of this class can be created
* using the {@link #dir(String)} method or using various methods on {@link ProjectLayout} such as {@link ProjectLayout#getProjectDirectory()}.
*
* @since 4.1
*/
public interface Directory extends FileSystemLocation {
/**
* Returns the location of this directory, as an absolute {@link File}.
*
* @since 4.2
*/
@Override
File getAsFile();
/**
* Returns a {@link FileTree} that allows the files and directories contained in this directory to be queried.
*/
FileTree getAsFileTree();
/**
* Returns a {@link Directory} whose location is the given path, resolved relative to this directory.
*
* @param path The path. Can be absolute.
* @return The directory.
*/
Directory dir(String path);
/**
* Returns a {@link Provider} whose value is a {@link Directory} whose location is the given path resolved relative to this directory.
*
* <p>The return value is live and the provided {@code path} is queried each time the return value is queried.
*
* @param path The path provider. Can have value that is an absolute path.
* @return The provider.
*/
Provider<Directory> dir(Provider<? extends CharSequence> path);
/**
* Returns a {@link RegularFile} whose location is the given path, resolved relative to this directory.
*
* @param path The path. Can be absolute.
* @return The file.
*/
RegularFile file(String path);
/**
* Returns a {@link Provider} whose value is a {@link RegularFile} whose location is the given path resolved relative to this directory.
*
* <p>The return value is live and the provided {@code path} is queried each time the return value is queried.
*
* @param path The path provider. Can have value that is an absolute path.
* @return The file.
*/
Provider<RegularFile> file(Provider<? extends CharSequence> path);
/**
* Returns a {@link FileCollection} containing the given files,
* whose locations are the given paths resolved relative to this directory,
* as defined by {@link org.gradle.api.Project#files(Object...)}.
*
* This method can also be used to create an empty collection, but the collection may not be mutated later.
*
* @param paths The paths to the files. May be empty.
* @return The file collection.
* @since 6.0
*/
FileCollection files(Object... paths);
}