001/* 002 * ============================================================================ 003 * Copyright © 2002-2020 by Thomas Thrien. 004 * All Rights Reserved. 005 * ============================================================================ 006 * Licensed to the public under the agreements of the GNU Lesser General Public 007 * License, version 3.0 (the "License"). You may obtain a copy of the License at 008 * 009 * http://www.gnu.org/licenses/lgpl.html 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, WITHOUT 013 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the 014 * License for the specific language governing permissions and limitations 015 * under the License. 016 */ 017 018package org.tquadrat.foundation.annotation; 019 020import static java.lang.annotation.ElementType.TYPE; 021import static java.lang.annotation.RetentionPolicy.SOURCE; 022import static org.apiguardian.api.API.Status.STABLE; 023 024import java.lang.annotation.Documented; 025import java.lang.annotation.Retention; 026import java.lang.annotation.Target; 027 028import org.apiguardian.api.API; 029 030/** 031 * <p>{@summary This is the marker annotation for a "Playground 032 * Class"}, a class that is added to the test code to verify a certain 033 * concept, but that is neither part of the tests nor of the product 034 * itself.</p> 035 * <p>Such a class may hurt several inspection rules that have to followed 036 * by otherwise "regular" classes, and these inspections can be 037 * switched off by applying this annotation.</p> 038 * 039 * @extauthor Thomas Thrien - thomas.thrien@tquadrat.org 040 * @version $Id: PlaygroundClass.java 966 2022-01-04 22:28:49Z tquadrat $ 041 * 042 * @UMLGraph.link 043 * @since 0.1.0 044 */ 045@ClassVersion( sourceVersion = "$Id: PlaygroundClass.java 966 2022-01-04 22:28:49Z tquadrat $" ) 046@API( status = STABLE, since = "0.1.0" ) 047@Documented 048@Retention( SOURCE ) 049@Target( TYPE ) 050public @interface PlaygroundClass 051{ /* Empty */ } 052// @interface PlaygroundClass 053 054/* 055 * End of File 056 */