net.digitalid.utility.collaboration.annotations.Review Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of utility-collaboration Show documentation

The newest version!

package net.digitalid.utility.collaboration.annotations;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import javax.annotation.Nonnull;

import net.digitalid.utility.collaboration.enumerations.Author;
import net.digitalid.utility.collaboration.enumerations.Priority;

/**
 * This annotation indicates that the annotated element should be reviewed.
 * 
 * @see Question
 * @see TODO
 */
@Documented
@Retention(RetentionPolicy.SOURCE)
@Target({ElementType.TYPE, ElementType.METHOD, ElementType.CONSTRUCTOR})
public @interface Review {
    
    /**
     * Returns the date when this review request was created.
     * (The desired format is 'YYYY-MM-DD'.)
     */
    @Nonnull String date();
    
    /**
     * Returns the author that created this review request.
     */
    @Nonnull Author author();
    
    /**
     * Returns the programmer to whom the review is assigned.
     */
    @Nonnull Author assignee() default Author.ANYONE;
    
    /**
     * Returns the priority with which the review should be done.
     */
    @Nonnull Priority priority() default Priority.UNSPECIFIED;
    
    /**
     * Returns a comment with explanations or considerations.
     */
    @Nonnull String comment() default "";
    
}