com.yahoo.parsec.validation.annotations.Yiv Maven / Gradle / Ivy

Go to download
// Copyright 2016 Yahoo Inc.
// Licensed under the terms of the Apache license. Please see LICENSE.md file distributed with this work for terms.

package com.yahoo.parsec.validation.annotations;

import java.lang.annotation.*;

/**
 * @author sho
 */
@Documented
@Target({ ElementType.FIELD })
@Retention(RetentionPolicy.RUNTIME)
public @interface Yiv {

    /**
     * Filter type.
     *
     * @return the current filter
     */
    Filter value() default Filter.HTML;

    /**
     * The list of groups this class/method belongs to.
     *
     * @return array of groups
     */
    String[] groups() default {};

    /**
     * Flags.
     *
     * @return the YIV flags
     */
    int flags() default 0;

    /**
     * Subset.
     *
     * @return subset of YIV
     */
    String subset() default "YIV_HTML_NO_TAGS";

    /**
     * Charset.
     *
     * @return the charset of inputs
     */
    String charset() default "utf-8";

    /**
     * Defines several {@code @Yiv} annotations on the same element.
     *
     */
    @Target({ ElementType.FIELD })
    @Retention(RetentionPolicy.RUNTIME)
    @Documented
    public @interface List {
        /**
         * Yiv.
         *
         * @return array of Yiv object
         */
        Yiv[] value();
    }

}