org.osgl.util.KV Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of osgl-tool Show documentation
A simple Java toolkit
The newest version!
package org.osgl.util;

/*-
 * #%L
 * Java Tool
 * %%
 * Copyright (C) 2014 - 2017 OSGL (Open Source General Library)
 * %%
 * 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.
 * #L%
 */

import java.util.Map;

/**
 * A instance of `KV` is a Map with {@link ValueObject} indexed with {@link String}
 */
public interface KV extends Map {

    /**
     * Add an new pair (key, val) into the store.
     * @param key the key
     * @param val the Object typed value (instead of encoded ValueObject type)
     * @return this KV instance
     */
    KV putValue(String key, Object val);

    /**
     * Returns a decoded value by key
     * @param key the key index the value object
     * @param  the generic type of the value
     * @return the decoded value
     */
     T getValue(String key);

    /**
     * Put all (key, value) pair from an normal map into this KV map. Note the original
     * map contains String typed key and Object typed value. After they have been put
     * into this KV map. The original value will be encoded by {@link ValueObject}
     *
     * @param kvMap the original map
     * @return this KV instance after all pairs has been put into this KV
     */
    KV putValues(Map kvMap);

    /**
     * Returns a `Map` contains (key, value) pairs that stored in this
     * `KV` map. The value in the pair should be the {@link ValueObject#value()}
     * stored in the {@link ValueObject} in this `KV` map
     *
     * @return the map of key and raw value stored in this store
     */
    Map toMap();
}