/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://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.
 */
package org.apache.commons.vfs2;


/**
 * The fileCache interface. Implementations of this interface are expected to be thread safe.
 */
public interface FilesCache
{
    /**
     * add a fileobject to the cache.
     *
     * @param file the file
     */
    void putFile(final FileObject file);

    /**
     * add a fileobject to the cache if it isn't already present.
     *
     * @param file the file
     * @return true if the file was stored, false otherwise.
     */
    boolean putFileIfAbsent(final FileObject file);

    /**
     * retrieve a file from the cache by its name.
     *
     * @param filesystem The FileSystem.
     * @param name the name
     * @return the fileobject or null if file is not cached
     */
    FileObject getFile(final FileSystem filesystem, final FileName name);

    /**
     * purge the entries corresponding to the filesystem.
     * @param filesystem The FileSystem.
     */
    void clear(final FileSystem filesystem);

    /**
     * purge the whole cache.
     */
    void close();

    /**
     * removes a file from cache.
     *
     * @param filesystem filesystem
     * @param name       filename
     */
    void removeFile(final FileSystem filesystem, final FileName name);

    /**
     * if the cache uses timestamps it could use this method to handle
     * updates of them.
     *
     * @param file filename
     */
    // public void touchFile(final FileObject file);
}

@@ -974,35 +974,36 @@
  /**%0A     * 
-a
+A
 dd
+s
  a 
-fileo
+FileO
 bject to the
@@ -1114,19 +1114,19 @@
   * 
-a
+A
 dd a 
-fileo
+FileO
 bjec
@@ -1341,17 +1341,17 @@
 %0A     * 
-r
+R
 etrieve 
@@ -1352,20 +1352,26 @@
 rieve a 
-f
+F
 ile
+Object
  from th
@@ -1385,12 +1385,8 @@
  by 
-its 
 name
@@ -1617,29 +1617,30 @@
  /**%0A     * 
-p
+P
 urge
+s
  the entries
@@ -1661,21 +1661,21 @@
  to the 
-files
+FileS
 ystem.%0A 
@@ -1683,33 +1683,33 @@
    * @param file
-s
+S
 ystem The FileSy
@@ -1754,25 +1754,25 @@
 eSystem file
-s
+S
 ystem);%0A%0A   
@@ -1787,13 +1787,14 @@
   * 
-p
+P
 urge
+s
  the
@@ -1849,17 +1849,17 @@
 %0A     * 
-r
+R
 emoves a
@@ -2048,17 +2048,17 @@
 %0A     * 
-i
+I
 f the ca

Use the active voice.