001/* -*- mode: Java; c-basic-offset: 2; indent-tabs-mode: nil; coding: utf-8-unix -*- 002 * 003 * Copyright © 2017–2019 microBean™. 004 * 005 * Licensed under the Apache License, Version 2.0 (the "License"); 006 * you may not use this file except in compliance with the License. 007 * You may obtain a copy of the License at 008 * 009 * http://www.apache.org/licenses/LICENSE-2.0 010 * 011 * Unless required by applicable law or agreed to in writing, software 012 * distributed under the License is distributed on an "AS IS" BASIS, 013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 014 * implied. See the License for the specific language governing 015 * permissions and limitations under the License. 016 */ 017package org.microbean.development.annotation; 018 019import java.lang.annotation.Documented; 020import java.lang.annotation.ElementType; 021import java.lang.annotation.Retention; 022import java.lang.annotation.RetentionPolicy; 023import java.lang.annotation.Target; 024 025/** 026 * Indicates that the annotated element has some work associated with 027 * it. 028 * 029 * @author <a href="https://about.me/lairdnelson" 030 * target="_parent">Laird Nelson</a> 031 */ 032@Documented 033@Retention(RetentionPolicy.RUNTIME) 034@Target({ 035 ElementType.ANNOTATION_TYPE, 036 ElementType.CONSTRUCTOR, 037 ElementType.FIELD, 038 ElementType.LOCAL_VARIABLE, 039 ElementType.METHOD, 040 ElementType.PACKAGE, 041 ElementType.PARAMETER, 042 ElementType.TYPE, 043 ElementType.TYPE_PARAMETER, 044 ElementType.TYPE_USE 045}) 046public @interface Todo { 047 048 /** 049 * A description of the work. 050 * 051 * @return a description of the work 052 */ 053 String value() default ""; 054 055 /** 056 * Where more information about the work may be found. 057 * 058 * @return a {@link String} representation of an absolute URI where 059 * more information about the work may be found 060 */ 061 String uri() default ""; 062 063}