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