001/* -*- mode: Java; c-basic-offset: 2; indent-tabs-mode: nil; coding: utf-8-unix -*-
002 *
003 * Copyright © 2018–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.Inherited;
022import java.lang.annotation.Retention;
023import java.lang.annotation.RetentionPolicy;
024import java.lang.annotation.Target;
025
026/**
027 * Indicates that the annotated element is governed by the license
028 * identified by the value of the {@link #uri()} element.
029 *
030 * @author <a href="https://about.me/lairdnelson"
031 * target="_parent">Laird Nelson</a>
032 */
033@Documented
034@Inherited
035@Retention(RetentionPolicy.RUNTIME)
036@Target({
037  ElementType.ANNOTATION_TYPE,
038  ElementType.PACKAGE,
039  ElementType.TYPE
040})
041public @interface License {
042
043  /**
044   * The name of the license in question.
045   *
046   * @return the name of the license in question
047   */
048  String name() default "";
049  
050  /**
051   * An absolute URI identifying the license in question.
052   *
053   * @return a {@link String} representation of an absolute URI
054   * identifying the license in question
055   */
056  String uri();
057  
058}