View Javadoc
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 org.apache.maven.building.StringSource;
23  
24  /**
25   * Wraps an ordinary {@link CharSequence} as a settings source.
26   *
27   * @author Benjamin Bentmann
28   * 
29   * @deprecated instead use {@link StringSource}
30   */
31  @Deprecated
32  public class StringSettingsSource extends StringSource
33      implements SettingsSource
34  {
35  
36      /**
37       * Creates a new settings source backed by the specified string.
38       *
39       * @param settings The settings' string representation, may be empty or {@code null}.
40       */
41      public StringSettingsSource( CharSequence settings )
42      {
43          this( settings, null );
44      }
45  
46      /**
47       * Creates a new settings source backed by the specified string.
48       *
49       * @param settings The settings' string representation, may be empty or {@code null}.
50       * @param location The location to report for this use, may be {@code null}.
51       */
52      public StringSettingsSource( CharSequence settings, String location )
53      {
54          super( settings, location );
55      }
56  
57      /**
58       * Gets the character sequence of this settings source.
59       *
60       * @return The underlying character stream, never {@code null}.
61       * @deprecated instead use {@link #getContent()}
62       */
63      @Deprecated
64      public String getSettings()
65      {
66          return getContent();
67      }
68  
69  }