FileAwareTrait.groovy
01 /*
02  * SPDX-License-Identifier: Apache-2.0
03  *
04  * Copyright 2019-2022 Andres Almiray.
05  *
06  * Licensed under the Apache License, Version 2.0 (the "License");
07  * you may not use this file except in compliance with the License.
08  * You may obtain a copy of the License at
09  *
10  *     http://www.apache.org/licenses/LICENSE-2.0
11  *
12  * Unless required by applicable law or agreed to in writing, software
13  * distributed under the License is distributed on an "AS IS" BASIS,
14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15  * See the License for the specific language governing permissions and
16  * limitations under the License.
17  */
18 package org.kordamp.gradle.plugin.oci.tasks.traits
19 
20 import groovy.transform.CompileStatic
21 import org.gradle.api.file.RegularFile
22 import org.gradle.api.file.RegularFileProperty
23 import org.gradle.api.provider.Provider
24 import org.gradle.api.tasks.InputFile
25 import org.gradle.api.tasks.Internal
26 import org.gradle.api.tasks.options.Option
27 import org.kordamp.gradle.plugin.oci.tasks.interfaces.ProjectAware
28 import org.kordamp.gradle.property.PathAware
29 import org.kordamp.gradle.property.RegularFileState
30 import org.kordamp.gradle.property.SimpleRegularFileState
31 
32 /**
33  @author Andres Almiray
34  @since 0.3.0
35  */
36 @CompileStatic
37 trait FileAwareTrait implements PathAware, ProjectAware {
38     private final RegularFileState state = SimpleRegularFileState.of(project, this, 'oci.file')
39 
40     @Internal
41     private RegularFileProperty getFile() {
42         state.property
43     }
44 
45     @InputFile
46     Provider<RegularFile> getResolvedFile() {
47         state.provider
48     }
49 
50     @Option(option = 'file', description = 'Location of the file to use (REQUIRED).')
51     void setFile(String file) {
52         setFile(project.file(file))
53     }
54 
55     void setFile(File file) {
56         getFile().set(file)
57     }
58 
59     void validateFile() {
60         if (!getResolvedFile().present) {
61             throw new IllegalStateException("Missing value for 'file' in $path")
62         }
63     }
64 }