View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *   http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  package org.eclipse.aether.internal.impl;
20  
21  import java.io.File;
22  import java.nio.file.Path;
23  import java.util.Map;
24  import java.util.Properties;
25  
26  /**
27   * Manages access to a properties file.
28   */
29  public interface TrackingFileManager {
30      /**
31       * Reads up the specified properties file into {@link Properties}, if exists, otherwise {@code null} is returned.
32       * @deprecated Use {@link #read(Path)} instead.
33       */
34      @Deprecated
35      Properties read(File file);
36  
37      /**
38       * Reads up the specified properties file into {@link Properties}, if exists, otherwise {@code null} is returned.
39       * @since 2.0.0
40       */
41      Properties read(Path path);
42  
43      /**
44       * Applies updates to specified properties file and returns resulting {@link Properties} with contents same
45       * as in updated file, never {@code null}.
46       * @deprecated Use {@link #update(Path, Map)} instead.
47       */
48      @Deprecated
49      Properties update(File file, Map<String, String> updates);
50  
51      /**
52       * Applies updates to specified properties file and returns resulting {@link Properties} with contents same
53       * as in updated file, never {@code null}.
54       * @since 2.0.0
55       */
56      Properties update(Path path, Map<String, String> updates);
57  }