001/*
002 * (C) Copyright 2015 Nuxeo SA (http://nuxeo.com/) and others.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 *
016 * Contributors:
017 *     Florent Guillaume
018 */
019package org.nuxeo.ecm.core.api;
020
021import java.io.Closeable;
022import java.io.File;
023import java.io.IOException;
024
025/**
026 * A wrapper for a {@link File}, which must be closed when done with it in order to release resources.
027 *
028 * @since 7.2
029 */
030public class CloseableFile implements Closeable {
031
032    public final File file;
033
034    public final boolean deleteOnClose;
035
036    public CloseableFile(File file, boolean deleteOnClose) {
037        this.file = file;
038        this.deleteOnClose = deleteOnClose;
039    }
040
041    public File getFile() {
042        return file;
043    }
044
045    @Override
046    public void close() throws IOException {
047        if (deleteOnClose) {
048            file.delete();
049        }
050    }
051}