1 package org.apache.maven.settings.building;
2
3 /*
4 * Licensed to the Apache Software Foundation (ASF) under one
5 * or more contributor license agreements. See the NOTICE file
6 * distributed with this work for additional information
7 * regarding copyright ownership. The ASF licenses this file
8 * to you under the Apache License, Version 2.0 (the
9 * "License"); you may not use this file except in compliance
10 * with the License. You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing,
15 * software distributed under the License is distributed on an
16 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 * KIND, either express or implied. See the License for the
18 * specific language governing permissions and limitations
19 * under the License.
20 */
21
22 import java.io.File;
23 import java.io.FileInputStream;
24 import java.io.IOException;
25 import java.io.InputStream;
26
27 /**
28 * Wraps an ordinary {@link File} as a settings source.
29 *
30 * @author Benjamin Bentmann
31 */
32 public class FileSettingsSource
33 implements SettingsSource
34 {
35
36 private File settingsFile;
37
38 /**
39 * Creates a new settings source backed by the specified file.
40 *
41 * @param settingsFile The settings file, must not be {@code null}.
42 */
43 public FileSettingsSource( File settingsFile )
44 {
45 if ( settingsFile == null )
46 {
47 throw new IllegalArgumentException( "no settings file specified" );
48 }
49 this.settingsFile = settingsFile.getAbsoluteFile();
50 }
51
52 public InputStream getInputStream()
53 throws IOException
54 {
55 return new FileInputStream( settingsFile );
56 }
57
58 public String getLocation()
59 {
60 return settingsFile.getPath();
61 }
62
63 /**
64 * Gets the settings file of this model source.
65 *
66 * @return The underlying settings file, never {@code null}.
67 */
68 public File getSettingsFile()
69 {
70 return settingsFile;
71 }
72
73 @Override
74 public String toString()
75 {
76 return getLocation();
77 }
78
79 }