com.leanplum.annotations.Variable Maven / Gradle / Ivy
Show all versions of leanplum-core Show documentation
/*
* Copyright 2013, Leanplum, Inc. All rights reserved.
*
* 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 com.leanplum.annotations;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* Leanplum variable annotation.
*
*
Use this to make this variable changeable from the Leanplum dashboard. Variables must be of
* type boolean, byte, short, int, long, float, double, char, String, List, or Map. Lists and maps
* may contain other lists and maps.
*
*
Variables with this annotation update when the API call for Leanplum.start completes
* successfully or fails (in which case values are loaded from a cache stored on the device).
*
* @author Andrew First
*/
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Variable {
/**
* (Optional). The group to put the variable in. Use "." to nest groups.
*/
String group() default "";
/**
* (Optional). The name of the variable. If not set, then uses the actual name of the field.
*/
String name() default "";
}