View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *   http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  package org.apache.maven.settings.validation;
20  
21  import org.apache.maven.settings.Settings;
22  import org.apache.maven.settings.building.SettingsProblemCollector;
23  
24  /**
25   * Validate a model settings
26   *
27   */
28  public interface SettingsValidator {
29  
30      /**
31       * Validate the specified settings.
32       *
33       * @param settings The settings to validate, must not be {@code null}.
34       * @param problems The container used to collect problems that were encountered, must not be {@code null}.
35       */
36      void validate(Settings settings, SettingsProblemCollector problems);
37  
38      /**
39       * Validate the specified settings.
40       *
41       * @param settings The settings to validate, must not be {@code null}.
42       * @param isProjectSettings Boolean indicating if the validation is for project settings or user / global settings.
43       * @param problems The container used to collect problems that were encountered, must not be {@code null}.
44       */
45      default void validate(Settings settings, boolean isProjectSettings, SettingsProblemCollector problems) {
46          validate(settings, problems);
47      }
48  }