# annotationutil

**Repository Path**: mirrors_josdejong/annotationutil

## Basic Information

- **Project Name**: annotationutil
- **Description**: Get aggregated annotations from a class, its interfaces, and its superclasses
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-09
- **Last Updated**: 2026-02-14

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

AnnotationUtil
==============

Get all annotations of a Java class, methods, and parameters. Returned 
annotations include all annotations of the classes interfaces and super classes.

## Usage

The project is a Maven project. The code consists of a single Java file, 
AnnotationUtil.java. To use the utility, you can:

- add the sourcefile [AnnotationUtil.java](https://github.com/josdejong/annotationutil/blob/master/src/main/java/com/almende/util/AnnotationUtil.java) to your project.
- add the built jar [annotationutil.x.x.x.jar](https://github.com/josdejong/annotationutil/tree/master/target) to your project.


## Example

    package com.almende.util;

    import java.lang.annotation.Annotation;
    import java.lang.annotation.ElementType;
    import java.lang.annotation.Retention;
    import java.lang.annotation.RetentionPolicy;
    import java.lang.annotation.Target;
    import java.util.List;

    import com.almende.util.AnnotationUtil.AnnotatedClass;
    import com.almende.util.AnnotationUtil.AnnotatedMethod;
    import com.almende.util.AnnotationUtil.AnnotatedParam;

    public class Example {
	    public static void main(String args[]) {
		    // Get annotated class from a Java class
		    AnnotatedClass annotatedClass = AnnotationUtil.get(MyClass.class);
		
		    // Get all class methods
		    List<AnnotatedMethod> methods = annotatedClass.getMethods();
		    for (AnnotatedMethod method : methods) {
			    System.out.println("Method: " + method.getName());
			
			    // get a particular method annotation
			    Expose expose = method.getAnnotation(Expose.class);
			    if (expose != null) {
				    System.out.println("expose: " + expose.value());
			    }
			
			    // loop over all parameters
			    List<AnnotatedParam> params = method.getParams();
			    for (AnnotatedParam param : params) {
				    // loop over all parameter annotations
				    for (Annotation annotation : param.getAnnotations()) {
					    System.out.println("Param annotation: " + annotation);
				    }
			    }
		    }
	    }

	    class MyClass implements MyInterface {
		    @Expose(true)
		    public void myMethod(String a, String b) {
			    // ...
		    }
	    }

	    interface MyInterface {
		    public void myMethod(@Name("a") String a, @Name("b") String b);
	    }

	    @Retention(RetentionPolicy.RUNTIME)
	    @Target(value=ElementType.METHOD)
	    public @interface Expose {
		    boolean value();
	    }

	    @Retention(RetentionPolicy.RUNTIME)
	    @Target(value=ElementType.PARAMETER)
	    public @interface Name {
		    String value();
	    }
    }