com.gs.collections.api.map.primitive.ObjectCharMap Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2014 Goldman Sachs.
 *
 * 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.gs.collections.api.map.primitive;

import java.util.Set;

import com.gs.collections.api.CharIterable;
import com.gs.collections.api.LazyIterable;
import com.gs.collections.api.RichIterable;
import com.gs.collections.api.block.predicate.primitive.ObjectCharPredicate;
import com.gs.collections.api.block.procedure.Procedure;
import com.gs.collections.api.block.procedure.primitive.ObjectCharProcedure;
import com.gs.collections.api.block.procedure.primitive.CharProcedure;
import com.gs.collections.api.collection.primitive.MutableCharCollection;
import com.gs.collections.api.tuple.primitive.ObjectCharPair;

/**
 * This file was automatically generated from template file objectPrimitiveMap.stg.
 *
 * @since 3.0.
 */
public interface ObjectCharMap extends CharIterable
{
    char get(Object key);

    char getOrThrow(Object key);

    char getIfAbsent(Object key, char ifAbsent);

    boolean containsKey(Object key);

    boolean containsValue(char value);

    void forEachValue(CharProcedure procedure);

    void forEachKey(Procedure procedure);

    void forEachKeyValue(ObjectCharProcedure procedure);

    ObjectCharMap select(ObjectCharPredicate predicate);

    ObjectCharMap reject(ObjectCharPredicate predicate);

    /**
     * Returns a string representation of this ObjectCharMap. The string representation consists of a list of the
     * map's key-value pairs in the order they are returned by its iterator. The key and value in each key-value pair are separated
     * by a colon (":") and each pair is enclosed in square brackets ("[]"). Adjacent key-value pairs
     * are separated by the characters ", " (comma and space). Keys and values are converted to strings as by
     * String#valueOf().
     *
     * @return a string representation of this ObjectCharMap
     */
    String toString();

    ImmutableObjectCharMap toImmutable();

    Set keySet();

    MutableCharCollection values();

    /**
     * @since 5.0
     */
    LazyIterable keysView();

    /**
     * @since 5.0
     */
    RichIterable> keyValuesView();
}