com.landawn.abacus.annotation.JsonXmlField Maven / Gradle / Ivy

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

A general programming library in Java/Android. It's easy to learn and simple to use with concise and powerful APIs.

There is a newer version: 5.2.4

/*
 * Copyright (C) 2019 HaiYang Li
 *
 * Licensed 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 com.landawn.abacus.annotation;

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

import com.landawn.abacus.annotation.Type.EnumBy;

@Target({ ElementType.FIELD })
@Retention(RetentionPolicy.RUNTIME)
public @interface JsonXmlField {

    /**
     * 
     *
     * @return 
     */
    String name() default "";

    /**
     * 
     *
     * @return 
     */
    String[] alias() default {};

    /**
     * 
     *
     * @return 
     */
    String type() default "";

    /**
     * 
     *
     * @return 
     */
    EnumBy enumerated() default EnumBy.NAME;

    /**
     * 
     *
     * @return 
     */
    String dateFormat() default "";

    /**
     * 
     *
     * @return 
     */
    String timeZone() default "";

    /**
     *
     * @return
     * @see DecimalFormat
     */
    String numberFormat() default "";

    /**
     *
     * @return true, if successful
     */
    boolean ignore() default false;

    /**
     *
     * @return true if target field type is a JSON String.
     */
    boolean isJsonRawValue() default false;

    //    /**
    //     *
    //     * @return
    //     * @deprecated should use the order of fields defined.
    //     */
    //    @Deprecated
    //    int ordinal() default -1;

    /**
     * 
     *
     * @return 
     */
    Expose expose() default Expose.DEFAULT;

    public static enum Expose {
        /**
         * @deprecated don't need to set it. It's {@code DEFAULT} by default.
         */
        DEFAULT,

        SERIALIZE_ONLY,

        DESERIALIZE_ONLY;
    }
}