All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.nd4j.common.util.ND4JFileUtils Maven / Gradle / Ivy

There is a newer version: 1.0.0-M2.1
Show newest version
/*******************************************************************************
 * Copyright (c) 2015-2018 Skymind, Inc.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Apache License, Version 2.0 which is available at
 * https://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.
 *
 * SPDX-License-Identifier: Apache-2.0
 ******************************************************************************/

package org.nd4j.common.util;

import org.nd4j.common.config.ND4JSystemProperties;

import java.io.File;
import java.io.IOException;

/**
 * Utilities for working with temporary files
 *
 * @author Alex Black
 */
public class ND4JFileUtils {

    private ND4JFileUtils(){ }

    /**
     * Create a temporary file in the location specified by {@link ND4JSystemProperties#ND4J_TEMP_DIR_PROPERTY} if set,
     * or the default temporary directory (usually specified by java.io.tmpdir system property)
     * @param prefix Prefix for generating file's name; must be at least 3 characeters
     * @param suffix Suffix for generating file's name; may be null (".tmp" will be used if null)
     * @return A temporary file
     */
    public static File createTempFile(String prefix, String suffix) {
        String p = System.getProperty(ND4JSystemProperties.ND4J_TEMP_DIR_PROPERTY);
        try {
            if (p == null || p.isEmpty()) {
                return File.createTempFile(prefix, suffix);
            } else {
                return File.createTempFile(prefix, suffix, new File(p));
            }
        } catch (IOException e){
            throw new RuntimeException("Error creating temporary file", e);
        }
    }

    /**
     * Get the temporary directory. This is the location specified by {@link ND4JSystemProperties#ND4J_TEMP_DIR_PROPERTY} if set,
     * or the default temporary directory (usually specified by java.io.tmpdir system property)
     * @return Temporary directory
     */
    public static File getTempDir(){
        String p = System.getProperty(ND4JSystemProperties.ND4J_TEMP_DIR_PROPERTY);
        if(p == null || p.isEmpty()){
            return new File(System.getProperty("java.io.tmpdir"));
        } else {
            return new File(p);
        }
    }

}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy