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.vfs;
    18
    19
    20  /***
    21   * The fileCache interface
    22   *
    23   * @author <a href="mailto:imario@apache.org">Mario Ivankovits</a>
    24   * @version $Revision: 480428 $ $Date: 2006-11-29 07:15:24 +0100 (Mi, 29 Nov 2006) $
    25   */
    26  public interface FilesCache
    27  {
    28      /***
    29       * add a fileobject to the cache
    30       *
    31       * @param file the file
    32       */
    33      public void putFile(final FileObject file);
    34
    35      /***
    36       * retrieve a file from the cache by its name
    37       *
    38       * @param name the name
    39       * @return the fileobject or null if file is not cached
    40       */
    41      public FileObject getFile(final FileSystem filesystem, final FileName name);
    42
    43      /***
    44       * purge the entries corresponding to the filesystem
    45       */
    46      public void clear(final FileSystem filesystem);
    47
    48      /***
    49       * purge the whole cache
    50       */
    51      public void close();
    52
    53      /***
    54       * removes a file from cache
    55       *
    56       * @param filesystem filesystem
    57       * @param name       filename
    58       */
    59      public void removeFile(final FileSystem filesystem, final FileName name);
    60
    61      /***
    62       * if the cache uses timestamps it could use this method to handle
    63       * updates of them
    64       *
    65       * @param file filename
    66       */
    67      // public void touchFile(final FileObject file);
    68  }