001package 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
022import org.apache.maven.building.StringSource;
023
024/**
025 * Wraps an ordinary {@link CharSequence} as a settings source.
026 *
027 * @author Benjamin Bentmann
028 * 
029 * @deprecated instead use {@link StringSource}
030 */
031@Deprecated
032public class StringSettingsSource extends StringSource
033    implements SettingsSource
034{
035
036    /**
037     * Creates a new settings source backed by the specified string.
038     *
039     * @param settings The settings' string representation, may be empty or {@code null}.
040     */
041    public StringSettingsSource( CharSequence settings )
042    {
043        this( settings, null );
044    }
045
046    /**
047     * Creates a new settings source backed by the specified string.
048     *
049     * @param settings The settings' string representation, may be empty or {@code null}.
050     * @param location The location to report for this use, may be {@code null}.
051     */
052    public StringSettingsSource( CharSequence settings, String location )
053    {
054        super( settings, location );
055    }
056
057    /**
058     * Gets the character sequence of this settings source.
059     *
060     * @return The underlying character stream, never {@code null}.
061     * @deprecated instead use {@link #getContent()}
062     */
063    @Deprecated
064    public String getSettings()
065    {
066        return getContent();
067    }
068
069}