net.openhft.koloboke.collect.map.hash.HashObjShortMapFactory Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of koloboke-api-jdk8 Show documentation
Carefully designed and efficient extension of the Java Collections Framework with primitive specializations and more, built for Java 8 (API)
The newest version!
/*
 * Copyright 2014 the original author or authors.
 *
 * 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 net.openhft.koloboke.collect.map.hash;

import net.openhft.koloboke.collect.*;
import net.openhft.koloboke.collect.hash.*;
import java.util.function.Consumer;
import net.openhft.koloboke.collect.map.*;

import javax.annotation.Nonnull;

import java.util.Map;



/**
 * An immutable factory of {@code HashObjShortMap}s.
 *
 * @see HashObjShortMap
 * @see HashObjShortMaps#getDefaultFactory()
 */
public interface HashObjShortMapFactory
        extends ObjShortMapFactory>
        , ObjHashFactory>
        {

    /**
     * {@inheritDoc} Defaults to {@link Equivalence#defaultEquality()}.
     */
    @Override
    @Nonnull Equivalence getKeyEquivalence();

    

    

    

    

    

    
    

    
    

    /**
     * Returns a copy of this factory, with exception that it constructs maps with
     * {@linkplain HashObjShortMap#keyEquivalence() key equivalence} set to the given
     * {@code Equivalence}.
     *
     * @param keyEquivalence the new key equivalence
     * @return a copy of this factory, which constructs maps with the given {@code keyEquivalence}
     */
    @Nonnull
    HashObjShortMapFactory
    withKeyEquivalence(@Nonnull Equivalence keyEquivalence);

    @Override
    @Nonnull
    
     HashObjShortMap newMutableMap();

    @Override
    @Nonnull
    
     HashObjShortMap newMutableMap(int expectedSize);

    

    @Override
    @Nonnull
    
     HashObjShortMap newMutableMap(
            @Nonnull Map map, int expectedSize);

    @Override
    @Nonnull
    
     HashObjShortMap newMutableMap(@Nonnull Map map1,
            @Nonnull Map map2, int expectedSize);

    @Override
    @Nonnull
    
     HashObjShortMap newMutableMap(@Nonnull Map map1,
            @Nonnull Map map2,
            @Nonnull Map map3, int expectedSize);

    @Override
    @Nonnull
    
     HashObjShortMap newMutableMap(@Nonnull Map map1,
            @Nonnull Map map2,
            @Nonnull Map map3,
            @Nonnull Map map4, int expectedSize);

    @Override
    @Nonnull
    
     HashObjShortMap newMutableMap(@Nonnull Map map1,
            @Nonnull Map map2,
            @Nonnull Map map3,
            @Nonnull Map map4,
            @Nonnull Map map5, int expectedSize);



    @Override
    @Nonnull
    
     HashObjShortMap newMutableMap(@Nonnull
            Consumer> entriesSupplier
            , int expectedSize);

    @Override
    @Nonnull
    
     HashObjShortMap newMutableMap(
            @Nonnull K2[] keys, @Nonnull short[] values, int expectedSize);

    @Override
    @Nonnull
    
     HashObjShortMap newMutableMap(
            @Nonnull K2[] keys, @Nonnull Short[] values, int expectedSize);

    @Override
    @Nonnull
    
     HashObjShortMap newMutableMap(@Nonnull Iterable keys,
            @Nonnull Iterable values, int expectedSize);

    

    @Override
    @Nonnull
    
     HashObjShortMap newMutableMap(
            @Nonnull Map map);

    @Override
    @Nonnull
    
     HashObjShortMap newMutableMap(@Nonnull Map map1,
            @Nonnull Map map2);

    @Override
    @Nonnull
    
     HashObjShortMap newMutableMap(@Nonnull Map map1,
            @Nonnull Map map2,
            @Nonnull Map map3);

    @Override
    @Nonnull
    
     HashObjShortMap newMutableMap(@Nonnull Map map1,
            @Nonnull Map map2,
            @Nonnull Map map3,
            @Nonnull Map map4);

    @Override
    @Nonnull
    
     HashObjShortMap newMutableMap(@Nonnull Map map1,
            @Nonnull Map map2,
            @Nonnull Map map3,
            @Nonnull Map map4,
            @Nonnull Map map5);



    @Override
    @Nonnull
    
     HashObjShortMap newMutableMap(@Nonnull
            Consumer> entriesSupplier
            );

    @Override
    @Nonnull
    
     HashObjShortMap newMutableMap(
            @Nonnull K2[] keys, @Nonnull short[] values);

    @Override
    @Nonnull
    
     HashObjShortMap newMutableMap(
            @Nonnull K2[] keys, @Nonnull Short[] values);

    @Override
    @Nonnull
    
     HashObjShortMap newMutableMap(@Nonnull Iterable keys,
            @Nonnull Iterable values);


    @Override
    @Nonnull
    
     HashObjShortMap newMutableMapOf(K2 k1, short v1);

    @Override
    @Nonnull
    
     HashObjShortMap newMutableMapOf(K2 k1, short v1,
            K2 k2, short v2);

    @Override
    @Nonnull
    
     HashObjShortMap newMutableMapOf(K2 k1, short v1,
            K2 k2, short v2, K2 k3, short v3);

    @Override
    @Nonnull
    
     HashObjShortMap newMutableMapOf(K2 k1, short v1,
            K2 k2, short v2, K2 k3, short v3,
            K2 k4, short v4);

    @Override
    @Nonnull
    
     HashObjShortMap newMutableMapOf(K2 k1, short v1,
            K2 k2, short v2, K2 k3, short v3,
            K2 k4, short v4, K2 k5, short v5);
    @Override
    @Nonnull
    
     HashObjShortMap newUpdatableMap();

    @Override
    @Nonnull
    
     HashObjShortMap newUpdatableMap(int expectedSize);

    

    @Override
    @Nonnull
    
     HashObjShortMap newUpdatableMap(
            @Nonnull Map map, int expectedSize);

    @Override
    @Nonnull
    
     HashObjShortMap newUpdatableMap(@Nonnull Map map1,
            @Nonnull Map map2, int expectedSize);

    @Override
    @Nonnull
    
     HashObjShortMap newUpdatableMap(@Nonnull Map map1,
            @Nonnull Map map2,
            @Nonnull Map map3, int expectedSize);

    @Override
    @Nonnull
    
     HashObjShortMap newUpdatableMap(@Nonnull Map map1,
            @Nonnull Map map2,
            @Nonnull Map map3,
            @Nonnull Map map4, int expectedSize);

    @Override
    @Nonnull
    
     HashObjShortMap newUpdatableMap(@Nonnull Map map1,
            @Nonnull Map map2,
            @Nonnull Map map3,
            @Nonnull Map map4,
            @Nonnull Map map5, int expectedSize);



    @Override
    @Nonnull
    
     HashObjShortMap newUpdatableMap(@Nonnull
            Consumer> entriesSupplier
            , int expectedSize);

    @Override
    @Nonnull
    
     HashObjShortMap newUpdatableMap(
            @Nonnull K2[] keys, @Nonnull short[] values, int expectedSize);

    @Override
    @Nonnull
    
     HashObjShortMap newUpdatableMap(
            @Nonnull K2[] keys, @Nonnull Short[] values, int expectedSize);

    @Override
    @Nonnull
    
     HashObjShortMap newUpdatableMap(@Nonnull Iterable keys,
            @Nonnull Iterable values, int expectedSize);

    

    @Override
    @Nonnull
    
     HashObjShortMap newUpdatableMap(
            @Nonnull Map map);

    @Override
    @Nonnull
    
     HashObjShortMap newUpdatableMap(@Nonnull Map map1,
            @Nonnull Map map2);

    @Override
    @Nonnull
    
     HashObjShortMap newUpdatableMap(@Nonnull Map map1,
            @Nonnull Map map2,
            @Nonnull Map map3);

    @Override
    @Nonnull
    
     HashObjShortMap newUpdatableMap(@Nonnull Map map1,
            @Nonnull Map map2,
            @Nonnull Map map3,
            @Nonnull Map map4);

    @Override
    @Nonnull
    
     HashObjShortMap newUpdatableMap(@Nonnull Map map1,
            @Nonnull Map map2,
            @Nonnull Map map3,
            @Nonnull Map map4,
            @Nonnull Map map5);



    @Override
    @Nonnull
    
     HashObjShortMap newUpdatableMap(@Nonnull
            Consumer> entriesSupplier
            );

    @Override
    @Nonnull
    
     HashObjShortMap newUpdatableMap(
            @Nonnull K2[] keys, @Nonnull short[] values);

    @Override
    @Nonnull
    
     HashObjShortMap newUpdatableMap(
            @Nonnull K2[] keys, @Nonnull Short[] values);

    @Override
    @Nonnull
    
     HashObjShortMap newUpdatableMap(@Nonnull Iterable keys,
            @Nonnull Iterable values);


    @Override
    @Nonnull
    
     HashObjShortMap newUpdatableMapOf(K2 k1, short v1);

    @Override
    @Nonnull
    
     HashObjShortMap newUpdatableMapOf(K2 k1, short v1,
            K2 k2, short v2);

    @Override
    @Nonnull
    
     HashObjShortMap newUpdatableMapOf(K2 k1, short v1,
            K2 k2, short v2, K2 k3, short v3);

    @Override
    @Nonnull
    
     HashObjShortMap newUpdatableMapOf(K2 k1, short v1,
            K2 k2, short v2, K2 k3, short v3,
            K2 k4, short v4);

    @Override
    @Nonnull
    
     HashObjShortMap newUpdatableMapOf(K2 k1, short v1,
            K2 k2, short v2, K2 k3, short v3,
            K2 k4, short v4, K2 k5, short v5);

    

    @Override
    @Nonnull
    
     HashObjShortMap newImmutableMap(
            @Nonnull Map map, int expectedSize);

    @Override
    @Nonnull
    
     HashObjShortMap newImmutableMap(@Nonnull Map map1,
            @Nonnull Map map2, int expectedSize);

    @Override
    @Nonnull
    
     HashObjShortMap newImmutableMap(@Nonnull Map map1,
            @Nonnull Map map2,
            @Nonnull Map map3, int expectedSize);

    @Override
    @Nonnull
    
     HashObjShortMap newImmutableMap(@Nonnull Map map1,
            @Nonnull Map map2,
            @Nonnull Map map3,
            @Nonnull Map map4, int expectedSize);

    @Override
    @Nonnull
    
     HashObjShortMap newImmutableMap(@Nonnull Map map1,
            @Nonnull Map map2,
            @Nonnull Map map3,
            @Nonnull Map map4,
            @Nonnull Map map5, int expectedSize);



    @Override
    @Nonnull
    
     HashObjShortMap newImmutableMap(@Nonnull
            Consumer> entriesSupplier
            , int expectedSize);

    @Override
    @Nonnull
    
     HashObjShortMap newImmutableMap(
            @Nonnull K2[] keys, @Nonnull short[] values, int expectedSize);

    @Override
    @Nonnull
    
     HashObjShortMap newImmutableMap(
            @Nonnull K2[] keys, @Nonnull Short[] values, int expectedSize);

    @Override
    @Nonnull
    
     HashObjShortMap newImmutableMap(@Nonnull Iterable keys,
            @Nonnull Iterable values, int expectedSize);

    

    @Override
    @Nonnull
    
     HashObjShortMap newImmutableMap(
            @Nonnull Map map);

    @Override
    @Nonnull
    
     HashObjShortMap newImmutableMap(@Nonnull Map map1,
            @Nonnull Map map2);

    @Override
    @Nonnull
    
     HashObjShortMap newImmutableMap(@Nonnull Map map1,
            @Nonnull Map map2,
            @Nonnull Map map3);

    @Override
    @Nonnull
    
     HashObjShortMap newImmutableMap(@Nonnull Map map1,
            @Nonnull Map map2,
            @Nonnull Map map3,
            @Nonnull Map map4);

    @Override
    @Nonnull
    
     HashObjShortMap newImmutableMap(@Nonnull Map map1,
            @Nonnull Map map2,
            @Nonnull Map map3,
            @Nonnull Map map4,
            @Nonnull Map map5);



    @Override
    @Nonnull
    
     HashObjShortMap newImmutableMap(@Nonnull
            Consumer> entriesSupplier
            );

    @Override
    @Nonnull
    
     HashObjShortMap newImmutableMap(
            @Nonnull K2[] keys, @Nonnull short[] values);

    @Override
    @Nonnull
    
     HashObjShortMap newImmutableMap(
            @Nonnull K2[] keys, @Nonnull Short[] values);

    @Override
    @Nonnull
    
     HashObjShortMap newImmutableMap(@Nonnull Iterable keys,
            @Nonnull Iterable values);


    @Override
    @Nonnull
    
     HashObjShortMap newImmutableMapOf(K2 k1, short v1);

    @Override
    @Nonnull
    
     HashObjShortMap newImmutableMapOf(K2 k1, short v1,
            K2 k2, short v2);

    @Override
    @Nonnull
    
     HashObjShortMap newImmutableMapOf(K2 k1, short v1,
            K2 k2, short v2, K2 k3, short v3);

    @Override
    @Nonnull
    
     HashObjShortMap newImmutableMapOf(K2 k1, short v1,
            K2 k2, short v2, K2 k3, short v3,
            K2 k4, short v4);

    @Override
    @Nonnull
    
     HashObjShortMap newImmutableMapOf(K2 k1, short v1,
            K2 k2, short v2, K2 k3, short v3,
            K2 k4, short v4, K2 k5, short v5);
}