001package ball.tools.javadoc;
002/*-
003 * ##########################################################################
004 * Utilities
005 * $Id: AnnotatedTaglet.java 5285 2020-02-05 04:23:21Z ball $
006 * $HeadURL: svn+ssh://svn.hcf.dev/var/spool/scm/repository.svn/ball-util/trunk/src/main/java/ball/tools/javadoc/AnnotatedTaglet.java $
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 com.sun.tools.doclets.Taglet;
024
025/**
026 * Interface indicating {@link Taglet} is annotated with {@link TagletName}
027 * and related annotations.
028 *
029 * @author {@link.uri mailto:ball@hcf.dev Allen D. Ball}
030 * @version $Revision: 5285 $
031 */
032public interface AnnotatedTaglet extends Taglet {
033
034    /**
035     * Method to get {@link TagletName#value()}.
036     *
037     * @return  {@link TagletName#value()} if {@link.this} {@link Taglet} is
038     *          annotated; {@code null} otherwise.
039     */
040    @Override
041    default String getName() {
042        return getClass().getAnnotation(TagletName.class).value();
043    }
044}