001package ball.annotation;
002/*-
003 * ##########################################################################
004 * Utilities
005 * $Id: PatternRegex.java 5877 2020-05-04 22:00:56Z ball $
006 * $HeadURL: svn+ssh://svn.hcf.dev/var/spool/scm/repository.svn/ball-util/trunk/src/main/java/ball/annotation/PatternRegex.java $
007 * %%
008 * Copyright (C) 2008 - 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.AnnotationValueMustConvertTo;
024import java.lang.annotation.Documented;
025import java.lang.annotation.Retention;
026import java.lang.annotation.Target;
027import java.util.regex.Pattern;
028
029import static java.lang.annotation.ElementType.TYPE;
030import static java.lang.annotation.RetentionPolicy.RUNTIME;
031
032/**
033 * {@link java.lang.annotation.Annotation} to mark a type with a
034 * {@link java.util.regex.Pattern} regex.
035 *
036 * @see Pattern#compile(String)
037 *
038 * @author {@link.uri mailto:ball@hcf.dev Allen D. Ball}
039 * @version $Revision: 5877 $
040 */
041@Documented
042@Retention(RUNTIME)
043@Target({ TYPE })
044@AnnotationValueMustConvertTo(value = Pattern.class, method = "compile")
045public @interface PatternRegex {
046    String value();
047}