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   * Identifies 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  
30      /** Never null as the ctor sets it to EMPTY_OPTIONS if input is null. */
31      private final FileSystemOptions fileSystemOptions;
32  
33      /**
34       * Creates the FS key.
35       *
36       * @param key must implement Comparable, and must be self-comparable.
37       * @param fileSystemOptions the required options, may be null.
38       */
39      FileSystemKey(final Comparable<?> key, final FileSystemOptions fileSystemOptions) {
40          this.key = key;
41          this.fileSystemOptions = fileSystemOptions != null ? fileSystemOptions : EMPTY_OPTIONS;
42      }
43  
44      @Override
45      public int compareTo(final FileSystemKey o) {
46          @SuppressWarnings("unchecked") // Keys must implement comparable, and be comparable to themselves
47          final Comparable<Comparable<?>> comparable = (Comparable<Comparable<?>>) key;
48          final int ret = comparable.compareTo(o.key);
49          if (ret != 0) {
50              // other filesystem
51              return ret;
52          }
53  
54          return fileSystemOptions.compareTo(o.fileSystemOptions);
55      }
56  
57      @Override
58      public String toString() {
59          return super.toString() + " [key=" + key + ", fileSystemOptions=" + fileSystemOptions + "]";
60      }
61  }