View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements. See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache license, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License. You may obtain a copy of the License at
8    *
9    *      http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the license for the specific language governing permissions and
15   * limitations under the license.
16   */
17  
18  package org.apache.logging.log4j.core.config;
19  
20  import java.util.ArrayList;
21  import java.util.Arrays;
22  import java.util.List;
23  
24  import org.apache.logging.log4j.core.Core;
25  import org.apache.logging.log4j.core.config.plugins.Plugin;
26  import org.apache.logging.log4j.core.config.plugins.PluginElement;
27  import org.apache.logging.log4j.core.config.plugins.PluginFactory;
28  
29  /**
30   * Container for CustomLevelConfig objects.
31   */
32  @Plugin(name = "CustomLevels", category = Core.CATEGORY_NAME, printObject = true)
33  public final class CustomLevels {
34  
35      private final List<CustomLevelConfig> customLevels;
36  
37      private CustomLevels(final CustomLevelConfig[] customLevels) {
38          this.customLevels = new ArrayList<>(Arrays.asList(customLevels));
39      }
40  
41      /**
42       * Create a CustomLevels object to contain all the CustomLevelConfigs.
43       *
44       * @param customLevels An array of CustomLevelConfigs.
45       * @return A CustomLevels object.
46       */
47      @PluginFactory
48      public static CustomLevels createCustomLevels(//
49              @PluginElement("CustomLevels") final CustomLevelConfig[] customLevels) {
50          return new CustomLevels(customLevels == null ? new CustomLevelConfig[0] : customLevels);
51      }
52  
53      /**
54       * Returns a list of the {@code CustomLevelConfig} objects created during configuration.
55       * @return the configured custom levels
56       */
57      public List<CustomLevelConfig> getCustomLevels() {
58          return customLevels;
59      }
60  }