ottlinger commented on code in PR #233: URL: https://github.com/apache/creadur-rat/pull/233#discussion_r1555989822
########## 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. + */ + public Description(ConfigComponent configComponent, boolean isCollection, Class<?> childClass, + Collection<Description> children) { + this(configComponent.type(), configComponent.name(), configComponent.desc(), isCollection, childClass, + children); + } + + /** + * Gets the type of the component. + * + * @return the component type. + */ + public Type getType() { + return type; + } + + /** + * Get the isCollection flag. + * + * @return true if this is a collection. + */ + public boolean isCollection() { + return isCollection; + } + + /** + * Get the class of the objcts for the getter/setter. + * + * @return the getter/setter param class. + */ + public Class<?> getChildType() { + return childClass; + } + + /** + * Gets the common name for the matcher. (e.g. 'text', 'spdx', etc.) May not be + * null. + * + * @return The common name for the item being inspected. + */ + public String getCommonName() { + return name; + } + + /** + * Gets the description of descriptive text for the component. May be an empty + * string or null. + * + * @return the descriptive text; + */ + public String getDescription() { + return desc; + } + + /** + * Retrieve the value of a the described parameter from the specified object. + * + * If the parameter is a collection return {@code null}. + * + * @param log the Log to log issues to. + * @param object the object that contains the value. + * @return the string value. + */ + public String getParamValue(Log log, Object object) { + if (isCollection) { + return null; + } + try { + Object val = getter(object.getClass()).invoke(object); + return val == null ? null : val.toString(); + } catch (IllegalArgumentException | IllegalAccessException | InvocationTargetException | NoSuchMethodException + | SecurityException e) { + log.error(System.err.format("Can not retrieve value for '%s' from %s\n", name, object.getClass().getName()), + e); + return null; + } + } + + /** + * Gets a map of the parameters that the object contains. For example Copyright + * has 'start', 'stop', and 'owner' parameters. Some IHeaderMatchers have simple + * text values (e.g. 'regex' or 'text' types) these should list an unnamed + * parameter (empty string) with the text value. + * + * @return the map of parameters to the objects that represent them. + */ + public Map<String, Description> getChildren() { + return children; + } + + /** + * Get all the children of a specific type + * + * @param type the type to return + * @return the collection of children of the specified type. + */ + public Collection<Description> childrenOfType(Type type) { + return children.values().stream().filter(d -> d.type == type).collect(Collectors.toList()); + } + + private String methodName(String prefix) { + return prefix + name.substring(0, 1).toUpperCase() + name.substring(1); + } + + /** + * Returns the getter for the component in the specified class. + * + * @param clazz the Class to get the getter from. + * @return the getter Method. + * @throws NoSuchMethodException if the class does not have the getter. + * @throws SecurityException if the getter can not be accessed. + */ + public Method getter(Class<?> clazz) throws NoSuchMethodException, SecurityException { + return clazz.getMethod(methodName("get")); + } + + /** + * Returns the setter for the component in the specified class. Notes: + * <ul> + * <li>License can not be set in components. They are top level components.</li> + * <li>Matcher expects an "add" method that accepts an + * IHeaderMatcher.Builder.</li> + * <li>Parameter expects a {@code set(String)} method.</li> + * <li>Unlabeled expects a {@code set(String)} method.</li> + * <li>BuilderParam expects a {@code set} method that takes a + * {@code childeClass} argument.</li> + * </ul> + * + * @param clazz the Class to get the getter from, generally a Builder class.. + * @return the getter Method. + * @throws NoSuchMethodException if the class does not have the getter. + * @throws SecurityException if the getter can not be accessed. + */ + public Method setter(Class<?> clazz) throws NoSuchMethodException, SecurityException { + switch (type) { + case License: + throw new NoSuchMethodException("Can not set a License as a child"); + case Matcher: + return clazz.getMethod("add", IHeaderMatcher.Builder.class); + case Parameter: + case Unlabeled: + return clazz.getMethod(methodName("set"), String.class); + case BuilderParam: + return clazz.getMethod(methodName("set"), childClass); + } + // should not happen + throw new IllegalStateException("Type " + type + " not valid."); + } + + private void callSetter(Log log, Description description, IHeaderMatcher.Builder builder, String value) { + try { + description.setter(builder.getClass()).invoke(builder, value); + } catch (NoSuchMethodException e) { + String msg = String.format("No setter for '%s' on %s", description.getCommonName(), builder.getClass().getCanonicalName()); + log.error(msg); + throw new ConfigurationException(msg); + } catch (IllegalAccessException | IllegalArgumentException | InvocationTargetException + | SecurityException e) { + String msg = String.format("can not call setter for '%s' on %s", description.getCommonName(), builder.getClass().getCanonicalName()); Review Comment: Unable to instead of cannot? Not sure where this message is shown. -- 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
