com.phloc.commons.collections.multimap.IMultiMap Maven / Gradle / Ivy
/**
* Copyright (C) 2006-2015 phloc systems
* http://www.phloc.com
* office[at]phloc[dot]com
*
* 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.phloc.commons.collections.multimap;
import java.util.Collection;
import java.util.Map;
import javax.annotation.Nonnegative;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import com.phloc.commons.state.EChange;
/**
* Base interface for a multi map (one key with several values).
*
* @author Philip Helger
* @param
* Key type
* @param
* Element type
* @param
* Container type containing value types
*/
public interface IMultiMap > extends Map
{
/**
* Get or create the collection of the specified key.
*
* @param aKey
* The key to use. May not be null.
* @return {@link EChange}
*/
@Nonnull
COLLTYPE getOrCreate (@Nonnull KEYTYPE aKey);
/**
* Add a single value into the container identified by the passed key.
*
* @param aKey
* The key to use. May not be null.
* @param aValue
* The value to be added. May be null.
* @return {@link EChange}
*/
@Nonnull
EChange putSingle (@Nonnull KEYTYPE aKey, @Nullable VALUETYPE aValue);
/**
* Add all values into the container identified by the passed key-value-map.
*
* @param aMap
* The key-value-map to use. May not be null.
* @return {@link EChange}
*/
@Nonnull
EChange putAllIn (@Nonnull Map aMap);
/**
* Remove a single element from the container identified by the passed key.
*
* @param aKey
* The key to use. May not be null.
* @param aValue
* The value to be removed. May be null.
* @return {@link EChange}
*/
@Nonnull
EChange removeSingle (@Nonnull KEYTYPE aKey, @Nullable VALUETYPE aValue);
/**
* Check a single element from the container identified by the passed key is
* present.
*
* @param aKey
* The key to use. May not be null.
* @param aValue
* The value to be checked. May be null.
* @return {@link EChange}
*/
boolean containsSingle (@Nonnull KEYTYPE aKey, @Nullable VALUETYPE aValue);
/**
* @return The total number of contained values. Always ≥ 0.
*/
@Nonnegative
long getTotalValueCount ();
}