001    package 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    
022    import java.io.File;
023    import java.io.FileInputStream;
024    import java.io.IOException;
025    import java.io.InputStream;
026    
027    /**
028     * Wraps an ordinary {@link File} as a settings source.
029     * 
030     * @author Benjamin Bentmann
031     */
032    public class FileSettingsSource
033        implements SettingsSource
034    {
035    
036        private File settingsFile;
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            if ( settingsFile == null )
046            {
047                throw new IllegalArgumentException( "no settings file specified" );
048            }
049            this.settingsFile = settingsFile.getAbsoluteFile();
050        }
051    
052        public InputStream getInputStream()
053            throws IOException
054        {
055            return new FileInputStream( settingsFile );
056        }
057    
058        public String getLocation()
059        {
060            return settingsFile.getPath();
061        }
062    
063        /**
064         * Gets the settings file of this model source.
065         * 
066         * @return The underlying settings file, never {@code null}.
067         */
068        public File getSettingsFile()
069        {
070            return settingsFile;
071        }
072    
073        @Override
074        public String toString()
075        {
076            return getLocation();
077        }
078    
079    }