001/* 002 * SonarQube, open source software quality management tool. 003 * Copyright (C) 2008-2014 SonarSource 004 * mailto:contact AT sonarsource DOT com 005 * 006 * SonarQube 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 * SonarQube 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 org.sonar.api.batch.BatchSide; 023import org.sonar.api.server.ServerSide; 024 025import javax.annotation.Nullable; 026 027import java.io.File; 028 029/** 030 * Use this component to deal with temp files/folders. Root location of temp files/folders 031 * depends on situation: 032 * <ul> 033 * <li>${SONAR_HOME}/temp on server side</li> 034 * <li>${SONAR_HOME}/.sonartmp<rnd> on the batch side</li> 035 * </ul> 036 * @since 4.0 037 * 038 */ 039@BatchSide 040@ServerSide 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}