edu.hm.hafner.util.Generated Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of codingstyle Show documentation

Provides all necessary resources for a Java project to enforce the coding style that I am using in my lectures about software development at Munich University of Applied Sciences and in all of my open source projects. It configures several static analysis tools for Maven and IntelliJ. Moreover, it provides some sample classes that already use this style guide. This classes can be used as such but are not required in this project. These classes also use some additional libraries that are included using the Maven dependency mechanism. If the sample classes are deleted then the dependencies can be safely deleted, too.

There is a newer version: 4.13.0

Show newest version

package edu.hm.hafner.util;

import java.lang.annotation.Retention;
import java.lang.annotation.Target;

import static java.lang.annotation.ElementType.*;
import static java.lang.annotation.RetentionPolicy.*;

/**
 * This annotation is used to mark source code that has been generated or is somehow not relevant for style checking or
 * code coverage analysis. It is quite similar to the JSR305 annotation. The
 * main difference is that it has class retention, so it is available for tools that work on bytecode (like JaCoCo,
 * PIT, or SpotBugs).
 */
@Retention(CLASS)
@Target({PACKAGE, TYPE, ANNOTATION_TYPE, METHOD, CONSTRUCTOR, FIELD,
        LOCAL_VARIABLE, PARAMETER})
public @interface Generated {
    /**
     * An optional property that identifies the code generator.
     *
     * @return the name of the generator
     */
    String[] value() default "";
}