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.config.plugins.Plugin;
    25  import org.apache.logging.log4j.core.config.plugins.PluginElement;
    26  import org.apache.logging.log4j.core.config.plugins.PluginFactory;
    27
    28  /**
    29   * Container for CustomLevelConfig objects.
    30   */
    31  @Plugin(name = "CustomLevels", category = "Core", printObject = true)
    32  public final class CustomLevels {
    33
    34      private final List<CustomLevelConfig> customLevels;
    35
    36      private CustomLevels(final CustomLevelConfig[] customLevels) {
    37          this.customLevels = new ArrayList<CustomLevelConfig>(Arrays.asList(customLevels));
    38      }
    39
    40      /**
    41       * Create a CustomLevels object to contain all the CustomLevelConfigs.
    42       *
    43       * @param customLevels An array of CustomLevelConfigs.
    44       * @return A CustomLevels object.
    45       */
    46      @PluginFactory
    47      public static CustomLevels createCustomLevels(//
    48              @PluginElement("CustomLevels") final CustomLevelConfig[] customLevels) {
    49          return new CustomLevels(customLevels == null ? new CustomLevelConfig[0] : customLevels);
    50      }
    51
    52      /**
    53       * Returns a list of the {@code CustomLevelConfig} objects created during configuration.
    54       * @return the configured custom levels
    55       */
    56      public List<CustomLevelConfig> getCustomLevels() {
    57          return customLevels;
    58      }
    59  }