001package org.apache.maven.settings.building;
002
003/*
004 * Licensed to the Apache Software Foundation (ASF) under one
005 * or more contributor license agreements.  See the NOTICE file
006 * distributed with this work for additional information
007 * regarding copyright ownership.  The ASF licenses this file
008 * to you under the Apache License, Version 2.0 (the
009 * "License"); you may not use this file except in compliance
010 * with the License.  You may obtain a copy of the License at
011 *
012 *   http://www.apache.org/licenses/LICENSE-2.0
013 *
014 * Unless required by applicable law or agreed to in writing,
015 * software distributed under the License is distributed on an
016 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017 * KIND, either express or implied.  See the License for the
018 * specific language governing permissions and limitations
019 * under the License.
020 */
021
022import java.io.File;
023
024import org.apache.maven.building.FileSource;
025
026/**
027 * Wraps an ordinary {@link File} as a settings source.
028 *
029 * @author Benjamin Bentmann
030 * 
031 * @deprecated instead use {@link FileSource}
032 */
033@Deprecated
034public class FileSettingsSource extends FileSource
035    implements SettingsSource
036{
037
038    /**
039     * Creates a new settings source backed by the specified file.
040     *
041     * @param settingsFile The settings file, must not be {@code null}.
042     */
043    public FileSettingsSource( File settingsFile )
044    {
045        super( settingsFile );
046    }
047
048    /**
049     * Gets the settings file of this model source.
050     *
051     * @return The underlying settings file, never {@code null}.
052     * @deprecated instead use {@link #getFile()}
053     */
054    @Deprecated
055    public File getSettingsFile()
056    {
057        return getFile();
058    }
059}