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.ByteArrayInputStream;
023    import java.io.IOException;
024    import java.io.InputStream;
025    
026    /**
027     * Wraps an ordinary {@link CharSequence} as a settings source.
028     * 
029     * @author Benjamin Bentmann
030     */
031    public class StringSettingsSource
032        implements SettingsSource
033    {
034    
035        private String settings;
036    
037        private String location;
038    
039        /**
040         * Creates a new settings source backed by the specified string.
041         * 
042         * @param settings The settings' string representation, may be empty or {@code null}.
043         */
044        public StringSettingsSource( CharSequence settings )
045        {
046            this( settings, null );
047        }
048    
049        /**
050         * Creates a new settings source backed by the specified string.
051         * 
052         * @param settings The settings' string representation, may be empty or {@code null}.
053         * @param location The location to report for this use, may be {@code null}.
054         */
055        public StringSettingsSource( CharSequence settings, String location )
056        {
057            this.settings = ( settings != null ) ? settings.toString() : "";
058            this.location = ( location != null ) ? location : "(memory)";
059        }
060    
061        public InputStream getInputStream()
062            throws IOException
063        {
064            return new ByteArrayInputStream( settings.getBytes( "UTF-8" ) );
065        }
066    
067        public String getLocation()
068        {
069            return location;
070        }
071    
072        /**
073         * Gets the character sequence of this settings source.
074         * 
075         * @return The underlying character stream, never {@code null}.
076         */
077        public String getSettings()
078        {
079            return settings;
080        }
081    
082        @Override
083        public String toString()
084        {
085            return getLocation();
086        }
087    
088    }