org.apache.pulsar.common.configuration.FieldContext Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of pulsar-broker-common Show documentation

Common classes used in multiple broker modules

There is a newer version: 3.0.7.0-SNAPSHOT-a030c50

/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package org.apache.pulsar.common.configuration;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * Stores field context to validate based on requirement or value constraints.
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface FieldContext {

    /**
     * checks field value is required. By default field is mandatory false.
     *
     * @return true if attribute is required else returns false
     */
    boolean required() default false;

    /**
     * binds numeric value's lower bound.
     *
     * @return minimum value of the field
     */
    long minValue() default Long.MIN_VALUE;

    /**
     * binds numeric value's upper bound.
     *
     * @return maximum value of the field
     */
    long maxValue() default Long.MAX_VALUE;

    /**
     * binds character length of text.
     *
     * @return character length of field
     */
    int maxCharLength() default Integer.MAX_VALUE;

    /**
     * allow field to be updated dynamically.
     *
     * @return
     */
    boolean dynamic() default false;

    /**
     * Category to group settings.
     *
     * @return category name
     */
    String category() default "";

    /**
     * Documentation of the settings.
     *
     * @return the documentation of the settings.
     */
    String doc() default "";

    /**
     * Whether the setting is deprecated or not.
     *
     * @return true if the setting is deprecated, otherwise false.
     */
    boolean deprecated() default false;

}