001package ball.util.ant.taskdefs;
002/*-
003 * ##########################################################################
004 * Utilities
005 * %%
006 * Copyright (C) 2008 - 2022 Allen D. Ball
007 * %%
008 * Licensed under the Apache License, Version 2.0 (the "License");
009 * you may not use this file except in compliance with the License.
010 * You may obtain a copy of the License at
011 *
012 *      http://www.apache.org/licenses/LICENSE-2.0
013 *
014 * Unless required by applicable law or agreed to in writing, software
015 * distributed under the License is distributed on an "AS IS" BASIS,
016 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
017 * See the License for the specific language governing permissions and
018 * limitations under the License.
019 * ##########################################################################
020 */
021import org.apache.tools.ant.BuildException;
022import org.apache.tools.ant.Task;
023
024/**
025 * Interface indicating {@link Task} is annotated with {@link AntTask} and
026 * related annotations.
027 *
028 * @author {@link.uri mailto:ball@hcf.dev Allen D. Ball}
029 */
030public interface AnnotatedAntTask extends AntTaskLogMethods {
031
032    /**
033     * Method to get {@link AntTask#value()}.
034     *
035     * @return  {@link AntTask#value()} if {@link.this} {@link Task} is
036     *          annotated; {@code null} otherwise.
037     */
038    default String getAntTaskName() {
039        AntTask annotation = getClass().getAnnotation(AntTask.class);
040
041        return (annotation != null) ? annotation.value() : null;
042    }
043
044    /**
045     * Default implementation for {@link Task} subclasses.  Check attributes
046     * annotated with {@link AntTaskAttributeConstraint}.
047     * See {@link AnnotatedAntTaskConfigurationChecker}.
048     *
049     * @throws  BuildException  If a
050     *                          {@link AntTaskAttributeConstraint.Checker}
051     *                          fails.
052     */
053    default void execute() throws BuildException {
054        new AnnotatedAntTaskConfigurationChecker((Task) this).checkErrors();
055    }
056}