001/* 002 * SonarQube 003 * Copyright (C) 2009-2016 SonarSource SA 004 * mailto:contact AT sonarsource DOT com 005 * 006 * This program is free software; you can redistribute it and/or 007 * modify it under the terms of the GNU Lesser General Public 008 * License as published by the Free Software Foundation; either 009 * version 3 of the License, or (at your option) any later version. 010 * 011 * This program is distributed in the hope that it will be useful, 012 * but WITHOUT ANY WARRANTY; without even the implied warranty of 013 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 014 * Lesser General Public License for more details. 015 * 016 * You should have received a copy of the GNU Lesser General Public License 017 * along with this program; if not, write to the Free Software Foundation, 018 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. 019 */ 020package org.sonar.api.utils; 021 022import java.io.File; 023import javax.annotation.Nullable; 024import org.sonar.api.batch.ScannerSide; 025import org.sonar.api.ce.ComputeEngineSide; 026import org.sonar.api.server.ServerSide; 027 028/** 029 * Use this component to deal with temp files/folders. Root location of temp files/folders 030 * depends on situation: 031 * <ul> 032 * <li>${SONAR_HOME}/temp on server side</li> 033 * <li>${SONAR_HOME}/.sonartmp on scanner side</li> 034 * </ul> 035 * @since 4.0 036 * 037 */ 038@ScannerSide 039@ServerSide 040@ComputeEngineSide 041public interface TempFolder { 042 043 /** 044 * Create a directory in temp folder with a random unique name. 045 */ 046 File newDir(); 047 048 /** 049 * Create a directory in temp folder using provided name. 050 */ 051 File newDir(String name); 052 053 File newFile(); 054 055 File newFile(@Nullable String prefix, @Nullable String suffix); 056 057}