com.google.code.siren4j.annotations.Siren4JFieldOption Maven / Gradle / Ivy

Go to download

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

This is a java library to help with the creation and use of Hypermedia entities as specified by the Siren hypermedia specification. See https://github.com/kevinswiber/siren for more detail on the specification.

There is a newer version: 2.1.0

Show newest version

/*******************************************************************************************
 * The MIT License (MIT)
 *
 * Copyright (c) 2013 Erik R Serating
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 *********************************************************************************************/
package com.google.code.siren4j.annotations;

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

/**
 * Annotation to add options for fields.
 *
 *  * 
 * Usage:
 *
 *      @Siren4JFieldOption(title = "Foo", value = "foo", optionDefault = true)
 *
 *     
 *       
 *          
 *       
 *       
 *          
 *          
 *          
 *          
 *       
 *     Property Required Description
title no The display name for the option
value no The options value
optionDefault no Flag to indicate this is the default option, defaults to false.
data no One or more {@link Siren4JOptionData} annotation
 *
 * 
 * 
 *
 */
@Target({ ElementType.ANNOTATION_TYPE })
@Retention(RetentionPolicy.RUNTIME)
@com.google.code.siren4j.annotations.Siren4JAnnotation
public @interface Siren4JFieldOption {
    String title() default "";
    String value() default "";
    boolean optionDefault() default false;
    Siren4JOptionData[] data() default {};
}

Property	Required	Description
title	no	The display name for the option
value	no	The options value
optionDefault	no	Flag to indicate this is the default option, defaults to false.
data	no	One or more {@link Siren4JOptionData} annotation