mk.gdx.firebase.annotations.MapConversion Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gdx-fireapp-core Show documentation

Firebase SDK API for LibGDX projects.

There is a newer version: 3.3.1

/*
 * Copyright 2017 mk
 *
 * 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 mk.gdx.firebase.annotations;

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

import mk.gdx.firebase.deserialization.FirebaseMapConverter;

/**
 * Firebase supports only the Map structure for Pojo so here you can indicate conversion from Map to POJO.
 * 
 * You can customize map conversions by {@link mk.gdx.firebase.GdxFIRDatabase#setMapConverter(FirebaseMapConverter)}
 * Some examples:
 * 

 * List example:
 * {@code
 * // Convert all Map's in list to User instance.
 * \@MapConversion(User.class)
 * doSomething(new Callback>){}...
 * }
 * 

 * POJO example:
 * {@code
 * \@MapConversion(User.class)
 * doSomething(new Callback){}...
 * }
 * 
 * TODO - should be PojoConversion?
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface MapConversion {
    /**
     * @return The type to which Map are converted.
     */
    Class value();
}