mk.gdx.firebase.deserialization.FirebaseMapConverter 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.deserialization;

import java.util.Map;

/**
 * Covers interface for converting database Maps to POJO
 */
public interface FirebaseMapConverter {

    /**
     * Transforms {@code Map} to {@code T object}.
     * 
     *
     * @param map        Map which we want to transform.
     * @param wantedType Type we want to get
     * @param         Generic type of class we want to get. Needed if type we want have nested generic type.
     * @return Deserialized object, may be null
     */
     T convert(Map map, Class wantedType);

    /**
     * Transforms {@code object} to Map.
     * 
     * Should be inverse of {@link #convert(Map, Class)}
     *
     * @param object Should be Pojo
     * @return Serialized object, may be null
     */
    Map unConvert(Object object);
}