001package org.apache.maven.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;
023import java.io.FileInputStream;
024import java.io.IOException;
025import java.io.InputStream;
026
027/**
028 * Wraps an ordinary {@link File} as a source.
029 *
030 * @author Benjamin Bentmann
031 */
032public class FileSource
033    implements Source
034{
035    private final File file;
036
037    /**
038     * Creates a new source backed by the specified file.
039     *
040     * @param file The file, must not be {@code null}.
041     */
042    public FileSource( File file )
043    {
044        if ( file == null )
045        {
046            throw new IllegalArgumentException( "no file specified" );
047        }
048        this.file = file.getAbsoluteFile();
049    }
050
051    @Override
052    public InputStream getInputStream()
053        throws IOException
054    {
055        return new FileInputStream( file );
056    }
057
058    @Override
059    public String getLocation()
060    {
061        return file.getPath();
062    }
063
064    /**
065     * Gets the file of this source.
066     *
067     * @return The underlying file, never {@code null}.
068     */
069    public File getFile()
070    {
071        return file;
072    }
073
074    @Override
075    public String toString()
076    {
077        return getLocation();
078    }
079}