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.cache;
18  
19  import org.apache.commons.vfs2.FileName;
20  import org.apache.commons.vfs2.FileSystem;
21  
22  /**
23   * Key for various cache implementations.
24   * <p>
25   * It compares the fileSystem (by hashCode) and the file name.
26   * </p>
27   */
28  final class FileSystemAndNameKey implements Comparable<FileSystemAndNameKey> {
29  
30      /** The FileSystem */
31      private final FileSystem fileSystem;
32  
33      /** The FileName */
34      private final FileName fileName;
35  
36      /** Hash code to identify this object */
37      private final int fileSystemId;
38  
39      FileSystemAndNameKey(final FileSystem fileSystem, final FileName fileName) {
40          this.fileSystem = fileSystem;
41          this.fileSystemId = System.identityHashCode(fileSystem);
42          this.fileName = fileName;
43      }
44  
45      @Override
46      public int compareTo(final FileSystemAndNameKey other) {
47          if (fileSystemId < other.fileSystemId) {
48              return -1;
49          }
50          if (fileSystemId > other.fileSystemId) {
51              return 1;
52          }
53          return fileName.compareTo(other.fileName);
54      }
55  
56      FileName getFileName() {
57          return fileName;
58      }
59  
60      FileSystem getFileSystem() {
61          return fileSystem;
62      }
63  }