/**
 * Copyright (C) 2013-2017 Vasilis Vryniotis 
 *
 * 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 com.datumbox.framework.common.storage.interfaces;

import com.datumbox.framework.common.storage.interfaces.StorageEngine.MapType;
import com.datumbox.framework.common.storage.interfaces.StorageEngine.StorageHint;

import java.lang.annotation.*;

/**
 * BigMap annotation is used to declare large Maps in the ModelParameters classes.
 * Fields that are annotated with this annotation, are automatically initialized
 * by the BigMapHolder object.
 * 
 * @author Vasilis Vryniotis 
 */
@Target(ElementType.FIELD)
@Inherited
@Retention(RetentionPolicy.RUNTIME)
public @interface BigMap {
    /**
     * Parameter that passes the Class of the Key of the BigMap.
     *
     * @return
     */
    public Class keyClass();

    /**
     * Parameter that passes the Class of the Value of the BigMap.
     *
     * @return
     */
    public Class valueClass();

    /**
     * Parameter that passes the MapType of the BigMap.
     * 
     * @return 
     */
    public MapType mapType();
    
    /**
     * Parameter that passes the StorageHint of the BigMap.
     * 
     * @return 
     */
    public StorageHint storageHint();
    
    /**
     * Parameter that passes whether the BigMap should be tread-safe.
     * 
     * @return 
     */
    public boolean concurrent();
}