001package ball.annotation;
002/*-
003 * ##########################################################################
004 * Utilities
005 * %%
006 * Copyright (C) 2008 - 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.AnnotationValueMustConvertTo;
022import java.lang.annotation.Documented;
023import java.lang.annotation.Retention;
024import java.lang.annotation.Target;
025import java.util.regex.Pattern;
026
027import static java.lang.annotation.ElementType.TYPE;
028import static java.lang.annotation.RetentionPolicy.RUNTIME;
029
030/**
031 * {@link java.lang.annotation.Annotation} to mark a type with a
032 * {@link java.util.regex.Pattern} regex.
033 *
034 * @see Pattern#compile(String)
035 *
036 * @author {@link.uri mailto:ball@hcf.dev Allen D. Ball}
037 */
038@Documented
039@Retention(RUNTIME)
040@Target({ TYPE })
041@AnnotationValueMustConvertTo(value = Pattern.class, method = "compile")
042public @interface PatternRegex {
043    String value();
044}