View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    *      http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  package org.apache.commons.vfs2.provider;
18  
19  import java.io.File;
20  
21  import org.apache.commons.vfs2.FileSystemException;
22  
23  /**
24   * Manages a repository of temporary local files.
25   */
26  public interface TemporaryFileStore {
27  
28      /**
29       * Allocates a new temporary file. The file (and all its descendants) will be deleted when this store is closed.
30       *
31       * @param basename The name of the file.
32       * @return The temporary file.
33       * @throws FileSystemException if an error occurs.
34       */
35      File allocateFile(String basename) throws FileSystemException;
36  }