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 org.apache.commons.vfs2.FileSystemOptions;
20  
21  /**
22   * Used to identify a file system
23   */
24  class FileSystemKey implements Comparable<FileSystemKey> {
25  
26      private static final FileSystemOptionstml#FileSystemOptions">FileSystemOptions EMPTY_OPTIONS = new FileSystemOptions();
27  
28      private final Comparable<?> key;
29      private final FileSystemOptions fileSystemOptions;
30  
31      /**
32       * Create the FS key.
33       *
34       * @param key must implement Comparable, and must be self-comparable
35       * @param fileSystemOptions the required options
36       */
37      FileSystemKey(final Comparable<?> key, final FileSystemOptions fileSystemOptions) {
38          this.key = key;
39          if (fileSystemOptions != null) {
40              this.fileSystemOptions = fileSystemOptions;
41          } else {
42              this.fileSystemOptions = EMPTY_OPTIONS;
43          }
44      }
45  
46      @Override
47      public int compareTo(final FileSystemKey o) {
48          @SuppressWarnings("unchecked") // Keys must implement comparable, and be comparable to themselves
49          final Comparable<Comparable<?>> comparable = (Comparable<Comparable<?>>) key;
50          final int ret = comparable.compareTo(o.key);
51          if (ret != 0) {
52              // other filesystem
53              return ret;
54          }
55  
56          return fileSystemOptions.compareTo(o.fileSystemOptions);
57      }
58  
59      @Override
60      public String toString() {
61          return super.toString() + " [key=" + key + ", fileSystemOptions=" + fileSystemOptions + "]";
62      }
63  }