001package ball.game.scrabble;
002/*-
003 * ##########################################################################
004 * Game Applications and Utilities
005 * %%
006 * Copyright (C) 2010 - 2022 Allen D. Ball
007 * %%
008 * Licensed under the Apache License, Version 2.0 (the "License");
009 * you may not use this file except in compliance with the License.
010 * You may obtain a copy of the License at
011 *
012 *      http://www.apache.org/licenses/LICENSE-2.0
013 *
014 * Unless required by applicable law or agreed to in writing, software
015 * distributed under the License is distributed on an "AS IS" BASIS,
016 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
017 * See the License for the specific language governing permissions and
018 * limitations under the License.
019 * ##########################################################################
020 */
021import ball.annotation.processing.TargetMustExtend;
022import ball.annotation.processing.TargetMustHaveConstructor;
023import ball.annotation.processing.TargetMustNotHaveModifiers;
024import java.lang.annotation.Documented;
025import java.lang.annotation.Retention;
026import java.lang.annotation.Target;
027
028import static java.lang.annotation.ElementType.TYPE;
029import static java.lang.annotation.RetentionPolicy.RUNTIME;
030import static javax.lang.model.element.Modifier.ABSTRACT;
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 */
038@Documented
039@Retention(RUNTIME)
040@Target({ TYPE })
041@TargetMustExtend(SQ.class)
042@TargetMustNotHaveModifiers({ ABSTRACT })
043@TargetMustHaveConstructor(PUBLIC)
044public @interface WordPremium {
045    int value() default 1;
046}