001package ball.game.scrabble;
002/*-
003 * ##########################################################################
004 * Game Applications and Utilities
005 * $Id: WordPremium.java 6104 2020-06-03 18:26:30Z ball $
006 * $HeadURL: svn+ssh://svn.hcf.dev/var/spool/scm/repository.svn/ball-game/trunk/src/main/java/ball/game/scrabble/WordPremium.java $
007 * %%
008 * Copyright (C) 2010 - 2020 Allen D. Ball
009 * %%
010 * Licensed under the Apache License, Version 2.0 (the "License");
011 * you may not use this file except in compliance with the License.
012 * You may obtain a copy of the License at
013 *
014 *      http://www.apache.org/licenses/LICENSE-2.0
015 *
016 * Unless required by applicable law or agreed to in writing, software
017 * distributed under the License is distributed on an "AS IS" BASIS,
018 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
019 * See the License for the specific language governing permissions and
020 * limitations under the License.
021 * ##########################################################################
022 */
023import ball.annotation.processing.TargetMustExtend;
024import ball.annotation.processing.TargetMustHaveConstructor;
025import java.lang.annotation.Documented;
026import java.lang.annotation.Retention;
027import java.lang.annotation.Target;
028
029import static java.lang.annotation.ElementType.TYPE;
030import static java.lang.annotation.RetentionPolicy.RUNTIME;
031import static javax.lang.model.element.Modifier.PUBLIC;
032
033/**
034 * {@link java.lang.annotation.Annotation} to mark premium {@link SQ}s.
035 *
036 * @author {@link.uri mailto:ball@hcf.dev Allen D. Ball}
037 * @version $Revision: 6104 $
038 */
039@Documented
040@Retention(RUNTIME)
041@Target({ TYPE })
042@TargetMustExtend(SQ.class)
043@TargetMustHaveConstructor(PUBLIC)
044public @interface WordPremium {
045    int value() default 1;
046}