io.machinecode.vial.api.map.COMap 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 COMap extends Map, Iterable> {

    boolean xcontainsKey(final char key);

    V xget(final char key);

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

    V xgetOrDefault(final char key, final V defaultValue);

    COMap with(final char key, final V value);

    V xput(final char key, final V value);

    V xputIfAbsent(final char key, final V value);

    V putIfAbsent(final Character key, final V value);

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

    V xremove(final char key);

    boolean xremove(final char key, final V value);

    boolean xremoveValue(final V value);

    V replace(final Character key, final V value);

    boolean replace(final Character key, final V oldValue, final V newValue);

    boolean xreplace(final char key, final V oldValue, final V newValue);

    V xreplace(final char key, final V value);

    COMap capacity(final int desired);

    COCursor iterator();
}