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;
18  
19  /**
20   * An enumerated type to deal with the various cache strategies.
21   */
22  public enum CacheStrategy {
23  
24      /**
25       * Deal with cached data manually. Call {@link FileObject#refresh()} to refresh the object data.
26       */
27      MANUAL("manual"),
28  
29      /**
30       * Refresh the data every time you request a file from {@link FileSystemManager#resolveFile}.
31       */
32      ON_RESOLVE("onresolve"),
33  
34      /**
35       * Refresh the data every time you call a method on the fileObject. You'll use this only if you really need the
36       * latest info as this setting is a major performance loss.
37       */
38      ON_CALL("oncall");
39  
40      /**
41       * Cache strategy name
42       */
43      private final String realName;
44  
45      private CacheStrategy(final String name) {
46          this.realName = name;
47      }
48  
49      /**
50       * Returns the name of the scope.
51       *
52       * @return the name of the scope.
53       */
54      @Override
55      public String toString() {
56          return realName;
57      }
58  
59      /**
60       * Returns the name of the scope.
61       *
62       * @return the name of the scope.
63       */
64      public String getName() {
65          return realName;
66      }
67  }