gsonpath.FlattenDelimiter Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gsonpath Show documentation

An annotation processor which generates Type Adapters for the Google Gson library

There is a newer version: 4.0.0

package gsonpath;

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

/**
 * Defines a delimiter character used by the Gson Path library when dealing with nested fields.
 * 
 * This exists as another annotation as opposed to using a char directly since it provides an easy mechanism
 * to determine whether the Type Adapter should use the default delimiter if supplied, or override it.
 */
@Target(ElementType.ANNOTATION_TYPE)
public @interface FlattenDelimiter {
    /**
     * The delimiter value
     *
     * @return a delimiter character.
     */
    char value();

    /**
     * Whether this delimiter should be overridden by the default value.
     * 
     * Typically you should leave this as false.
     *
     * @return if the default should be used.
     */
    boolean inheritDefaultIfAvailable() default false;
}