com.thoughtworks.qdox.model.JavaAnnotatedElement Maven / Gradle / Ivy
package com.thoughtworks.qdox.model;
/*
* 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.
*/
import java.util.List;
/**
*
* Equivalent of {@link java.lang.reflect.AnnotatedElement}, providing the most important methods.
* Where the original AnnotatedElement uses an Array, the JavaAnnotatedElement is using a {@link List}.
*
*
* Where you can use Annotations, you can also use JavaDoc. For that reason all JavaDoc methods have been added to this interface.
*
*
* @author Robert Scholte
* @since 2.0
*
*/
public interface JavaAnnotatedElement extends JavaModel
{
// Methods from AnnotatedElement
/**
*
* Equivalent of {@link java.lang.reflect.AnnotatedElement#getAnnotations()}
*
* @return a list of Annotations, never null
*/
List getAnnotations();
// JavaDoc specific methods
/**
* Retrieve the javadoc comment of this annotated element.
* This is the part between /** and the */, but without the doclet tags
*
* @return the comment, otherwise null
*/
String getComment();
/**
* Retrieve all defined doclet tags.
*
* @return a list of DocletTags, never null
*/
List getTags();
/**
* Retrieve all doclettags with a specific name.
*
* @param name the name of the doclet tag
* @return a list of doclettags, never null
*/
List getTagsByName( String name );
/**
* Retrieve the doclettag by the specified name.
* If there are more than one tags, only return the first one.
*
* @param name the name of the doclettag trying to retrieve
* @return the first doclettag matching the name, otherwise null
*/
DocletTag getTagByName( String name );
/**
* Convenience method for getTagByName(String).getNamedParameter(String)
* that also checks for null tag.
*
* @param tagName the tag name
* @param parameterName the parameter name
* @return the value of the matching parameter, otherwise null
* @since 1.3
*/
String getNamedParameter(String tagName, String parameterName);
}