io.klerch.alexa.state.model.AlexaStateIgnore Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of alexa-skills-kit-states-java Show documentation

This SDK is an extension to the Alexa Skills SDK for Java. It provides a framework for managing state of POJO models in a variety of persistence stores in an Alexa skill.

There is a newer version: 1.1.0

Show newest version

/**
 * Made by Kay Lerch (https://twitter.com/KayLerch)
 *
 * Attached license applies.
 * This library is licensed under GNU GENERAL PUBLIC LICENSE Version 3 as of 29 June 2007
 */
package io.klerch.alexa.state.model;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import java.util.Arrays;
import java.util.List;

/**
 * A field having this annotation will be ignored from being saved and loaded by AlexaStateHandlers
 * even when they have the AlexaStateSave annotation. Use the scope parameter to define in which
 * scopes (Session, User, Application) the ignore should apply. This tag makes most sense if the
 * whole model class is annotated with AlexaStateSave and only few fields should be excluded from
 * the general saving and loading of all fields of the model. By default this annotation ignores
 * the field regardless of what scope it is saved in.
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface AlexaStateIgnore {
    /**
     * The scopes in which the field is ignored by AlexaStateHandlers.
     * @return The scopes in which the field is ignored by AlexaStateHandlers.
     */
    AlexaScope[] Scope() default {AlexaScope.SESSION, AlexaScope.USER, AlexaScope.APPLICATION};
}