001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *   http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing,
013 * software distributed under the License is distributed on an
014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 * KIND, either express or implied.  See the License for the
016 * specific language governing permissions and limitations
017 * under the License.
018 */
019package org.eclipse.aether.internal.impl;
020
021import java.io.File;
022import java.nio.file.Path;
023import java.util.Map;
024import java.util.Properties;
025
026/**
027 * Manages access to a properties file.
028 */
029public interface TrackingFileManager {
030    /**
031     * Reads up the specified properties file into {@link Properties}, if exists, otherwise {@code null} is returned.
032     * @deprecated Use {@link #read(Path)} instead.
033     */
034    @Deprecated
035    Properties read(File file);
036
037    /**
038     * Reads up the specified properties file into {@link Properties}, if exists, otherwise {@code null} is returned.
039     * @since 2.0.0
040     */
041    Properties read(Path path);
042
043    /**
044     * Applies updates to specified properties file and returns resulting {@link Properties} with contents same
045     * as in updated file, never {@code null}.
046     * @deprecated Use {@link #update(Path, Map)} instead.
047     */
048    @Deprecated
049    Properties update(File file, Map<String, String> updates);
050
051    /**
052     * Applies updates to specified properties file and returns resulting {@link Properties} with contents same
053     * as in updated file, never {@code null}.
054     * @since 2.0.0
055     */
056    Properties update(Path path, Map<String, String> updates);
057
058    /**
059     * Deletes the specified properties file, if exists. If file existed and was deleted, returns {@code true}.
060     *
061     * @deprecated Use {@link #delete(Path)} instead.
062     * @since 1.9.25
063     */
064    @Deprecated
065    boolean delete(File file);
066
067    /**
068     * Deletes the specified properties file, if exists. If file existed and was deleted, returns {@code true}.
069     *
070     * @since 2.0.14
071     */
072    boolean delete(Path path);
073}