io.machinecode.vial.api.map.BIMap Maven / Gradle / Ivy

Go to download

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

Vial Collections

The newest version!

/*
 * Copyright (C) 2015 Brent Douglas and other contributors
 * as indicated by the @author tags. All rights reserved.
 *
 * 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 io.machinecode.vial.api.map;

import java.util.Map;

/**
 * @author Brent Douglas
 * @since 1.0
 */
public interface BIMap extends Map, Iterable {

    int nv();

    boolean xcontainsKey(final byte key);

    boolean xcontainsValue(final int value);

    int xget(final byte key);

    Integer getOrDefault(final Object key, final Integer defaultValue);

    int xgetOrDefault(final byte key, final int defaultValue);

    BIMap with(final byte key, final int value);

    int xput(final byte key, final int value);

    Integer putIfAbsent(final Byte key, final Integer value);

    int xputIfAbsent(final byte key, final int value);

    boolean remove(final Object key, final Object value);

    int xremove(final byte key);

    boolean xremove(final byte key, final int value);

    boolean xremoveValue(final int value);

    boolean replace(final Byte key, final Integer oldValue, final Integer newValue);

    boolean xreplace(final byte key, final int oldValue, final int newValue);

    Integer replace(final Byte key, final Integer value);

    int xreplace(final byte key, final int value);

    BIMap capacity(final int desired);

    BICursor iterator();
}