001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements. See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache license, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License. You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the license for the specific language governing permissions and
015 * limitations under the license.
016 */
017
018package org.apache.logging.log4j.core.config;
019
020import java.util.ArrayList;
021import java.util.Arrays;
022import java.util.List;
023
024import org.apache.logging.log4j.core.config.plugins.Plugin;
025import org.apache.logging.log4j.core.config.plugins.PluginElement;
026import org.apache.logging.log4j.core.config.plugins.PluginFactory;
027
028/**
029 * Container for CustomLevelConfig objects.
030 */
031@Plugin(name = "CustomLevels", category = "Core", printObject = true)
032public final class CustomLevels {
033
034    private final List<CustomLevelConfig> customLevels;
035
036    private CustomLevels(final CustomLevelConfig[] customLevels) {
037        this.customLevels = new ArrayList<CustomLevelConfig>(Arrays.asList(customLevels));
038    }
039
040    /**
041     * Create a CustomLevels object to contain all the CustomLevelConfigs.
042     * 
043     * @param customLevels An array of CustomLevelConfigs.
044     * @return A CustomLevels object.
045     */
046    @PluginFactory
047    public static CustomLevels createCustomLevels(//
048            @PluginElement("CustomLevels") final CustomLevelConfig[] customLevels) {
049        return new CustomLevels(customLevels == null ? new CustomLevelConfig[0] : customLevels);
050    }
051
052    /**
053     * Returns a list of the {@code CustomLevelConfig} objects created during configuration.
054     * @return the configured custom levels
055     */
056    public List<CustomLevelConfig> getCustomLevels() {
057        return customLevels;
058    }
059}