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    package org.apache.logging.log4j.core.config.plugins.util;
018    
019    
020    import java.io.Serializable;
021    
022    /**
023     * Plugin Descriptor. This is a memento object for Plugin annotations paired to their annotated classes.
024     *
025     * @param <T> The plug-in class, which can be any kind of class.
026     * @see org.apache.logging.log4j.core.config.plugins.Plugin
027     */
028    public class PluginType<T> implements Serializable {
029    
030        private static final long serialVersionUID = 4743255148794846612L;
031    
032        private final Class<T> pluginClass;
033        private final String elementName;
034        private final boolean printObject;
035        private final boolean deferChildren;
036    
037        public PluginType(final Class<T> clazz, final String name, final boolean printObj, final boolean deferChildren) {
038            this.pluginClass = clazz;
039            this.elementName = name;
040            this.printObject = printObj;
041            this.deferChildren = deferChildren;
042        }
043    
044        public Class<T> getPluginClass() {
045            return this.pluginClass;
046        }
047    
048        public String getElementName() {
049            return this.elementName;
050        }
051    
052        public boolean isObjectPrintable() {
053            return this.printObject;
054        }
055    
056        public boolean isDeferChildren() {
057            return this.deferChildren;
058        }
059    
060        @Override
061        public String toString() {
062            return "PluginType [pluginClass=" + this.pluginClass + ", elementName=" + this.elementName + ", printObject="
063                    + this.printObject + ", deferChildren=" + this.deferChildren + "]";
064        }
065    }