001/*
002 * JDrupes Builder
003 * Copyright (C) 2025 Michael N. Lipp
004 * 
005 * This program is free software: you can redistribute it and/or modify
006 * it under the terms of the GNU Affero General Public License as
007 * published by the Free Software Foundation, either version 3 of the
008 * License, or (at your option) any later version.
009 *
010 * This program is distributed in the hope that it will be useful,
011 * but WITHOUT ANY WARRANTY; without even the implied warranty of
012 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
013 * GNU Affero General Public License for more details.
014 *
015 * You should have received a copy of the GNU Affero General Public License
016 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
017 */
018
019package org.jdrupes.builder.api;
020
021import java.nio.file.Path;
022
023/// A resource that represents a file.
024///
025public interface FileResource extends IOResource {
026
027    /// Return the file's path.
028    ///
029    /// @return the path
030    ///
031    Path path();
032
033    /// Cleans up by deleting the file.
034    ///
035    @Override
036    default void cleanup() {
037        path().toFile().delete();
038    }
039
040    /// Creates a new file resource from the given path.
041    ///
042    /// @param path the absolute path
043    /// @return the file resource
044    ///
045    @SuppressWarnings({ "PMD.UseDiamondOperator", "PMD.ShortMethodName" })
046    static FileResource of(Path path) {
047        return ResourceFactory.create(new ResourceType<FileResource>() {},
048            path);
049    }
050}