/*
 * @(#)CopyrightCanadianMindProducts.java
 *
 * Summary: embedded copyright annotation.
 *
 * Copyright: (c) 2005-2010 Roedy Green, Canadian Mind Products, http://mindprod.com
 *
 * Licence: This software may be copied and used freely for any purpose but military.
 *          http://mindprod.com/contact/nonmil.html
 *
 * Requires: JDK 1.5+
 *
 * Created with: IntelliJ IDEA IDE.
 *
 * Version History:
 *  1.0 2005-01-01 - initial version
 */
package com.mindprod.common15;

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

/**
 * embedded copyright annotation.
 *
 * @author Roedy Green, Canadian Mind Products
 * @version 1.0 2005-01-01 - initial version
 * @since 2005-01-01
 */
@Documented
@Retention( RetentionPolicy.RUNTIME )
        @interface CopyrightCanadianMindProducts
    {
    // ------------------------------ CONSTANTS ------------------------------

    /**
     * copyright to embed via annotations so it is embedded in all classes that reference it
     */
    String defaultCopyright =
            "copyright (c) 1998-2010 Roedy Green, Canadian Mind Products, http://mindprod.com";
    // -------------------------- PUBLIC INSTANCE  METHODS --------------------------

    /**
     * get value of this annotation
     *
     * @return the copyright string
     */
    String value() default defaultCopyright;
    }
