ottlinger commented on code in PR #233: URL: https://github.com/apache/creadur-rat/pull/233#discussion_r1555987496
########## apache-rat-core/src/main/java/org/apache/rat/config/parameters/Description.java: ########## @@ -0,0 +1,321 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +package org.apache.rat.config.parameters; + +import java.lang.reflect.InvocationTargetException; +import java.lang.reflect.Method; +import java.util.Arrays; +import java.util.Collection; +import java.util.Map; +import java.util.TreeMap; +import java.util.stream.Collectors; + +import org.apache.rat.ConfigurationException; +import org.apache.rat.analysis.IHeaderMatcher; +import org.apache.rat.config.parameters.Component.Type; +import org.apache.rat.utils.Log; + +/** + * A description of a component. + */ +public class Description { + /** The type of component this describes */ + private final Type type; + /** + * The common name for the component. Set by ConfigComponent.name() or + * class/field name. + */ + private final String name; + /** The description for the component */ + private final String desc; + /** The class of the getter/setter parameter */ + private final Class<?> childClass; + /** True if the getter/setter expects a collection of childClass objects */ + private final boolean isCollection; + /** + * a map of name to Description for all the components that are children the + * described component + */ + private final Map<String, Description> children; + + /** + * Constructor. + * + * @param type the type of the component. + * @param name the name of the component. + * @param desc the description of the component. + * @param isCollection true if the getter/setter expects a collection + * @param childClass the class for expected for the getter/setter. + * @param children the collection of descriptions for all the components that + * are children the described component. + */ + public Description(Type type, String name, String desc, boolean isCollection, Class<?> childClass, + Collection<Description> children) { + this.type = type; + this.name = name; + this.desc = desc; + this.isCollection = isCollection; + this.childClass = childClass; + this.children = new TreeMap<>(); + if (children != null) { + children.forEach(d -> { + this.children.put(d.name, d); + }); + } + } + + /** + * Constructor + * + * @param configComponent the configuration component + * @param isCollection the collection flag. + * @param childClass the type of object that the method getter/setter expects. + * @param children the collection of descriptions for all the components that + * are children the described component. Review Comment: Typo: of the described component -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: dev-unsubscr...@creadur.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
