001package ball.util.ant.taskdefs;
002/*-
003 * ##########################################################################
004 * Utilities
005 * $Id: ConfigurableAntTask.html 5431 2020-02-12 19:03:17Z ball $
006 * $HeadURL: svn+ssh://svn.hcf.dev/var/spool/scm/repository.svn/hcf-dev/blog/2019-07-08-fivethirtyeight-best-scrabble-string/src/main/resources/javadoc/src-html/ball/util/ant/taskdefs/ConfigurableAntTask.html $
007 * %%
008 * Copyright (C) 2008 - 2020 Allen D. Ball
009 * %%
010 * Licensed under the Apache License, Version 2.0 (the "License");
011 * you may not use this file except in compliance with the License.
012 * You may obtain a copy of the License at
013 *
014 *      http://www.apache.org/licenses/LICENSE-2.0
015 *
016 * Unless required by applicable law or agreed to in writing, software
017 * distributed under the License is distributed on an "AS IS" BASIS,
018 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
019 * See the License for the specific language governing permissions and
020 * limitations under the License.
021 * ##########################################################################
022 */
023import ball.util.PropertiesImpl;
024import org.apache.tools.ant.BuildException;
025import org.apache.tools.ant.Task;
026
027/**
028 * Provides default {@link Task#init()} method to initialize {@link Task}
029 * attributes from project properties.
030 *
031 * @author {@link.uri mailto:ball@hcf.dev Allen D. Ball}
032 * @version $Revision: 5431 $
033 */
034public interface ConfigurableAntTask extends AntTaskMixIn {
035
036    /**
037     * Default implementation for {@link Task} subclasses.
038     */
039    default void init() throws BuildException { configure(); }
040
041    /**
042     * Default method to configure {@link Task} attributes.
043     */
044    default void configure() throws BuildException {
045        try {
046            PropertiesImpl properties = new PropertiesImpl();
047
048            properties.putAll(((Task) this).getProject().getProperties());
049            properties.keySet()
050                .removeAll(((Task) this).getRuntimeConfigurableWrapper()
051                           .getAttributeMap().keySet());
052            properties.configure(this);
053        } catch (BuildException exception) {
054            throw exception;
055        } catch (RuntimeException exception) {
056            throw exception;
057        } catch (Exception exception) {
058            throw new BuildException(exception);
059        }
060    }
061}