functionalj.map.ReadOnlyMap Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of functionalj-core Show documentation
The module for FunctionalJ Core.
There is a newer version: 1.0.17
// ============================================================================
// Copyright (c) 2017-2019 Nawapunth Manusitthipol (NawaMan - http://nawaman.net).
// ----------------------------------------------------------------------------
// MIT License
// 
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
// 
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.
// ============================================================================
package functionalj.map;

import java.util.Collection;
import java.util.Map;
import java.util.Set;
import java.util.function.BiConsumer;
import java.util.function.BiFunction;
import java.util.function.Function;

@SuppressWarnings("javadoc")
public interface ReadOnlyMap extends Map {
    
    @Override
    public int size();
    
    @Override
    public default boolean isEmpty() {
        return size() == 0;
    }
    
    @Override
    public Set keySet();
    
    @Override
    public Collection values();
    
    @Override
    public Set> entrySet() ;
    
    @Override
    public boolean containsKey(Object key);
    
    @Override
    public boolean containsValue(Object value);
    
    @Override
    public VALUE get(Object key);
    
    @Override
    public VALUE getOrDefault(Object key, VALUE defaultValue);
    
    @Override
    public default VALUE put(KEY key, VALUE value) {
        throw new ReadOnlyMapException(this);
    }
    
    @Override
    public default VALUE remove(Object key) {
        throw new ReadOnlyMapException(this);
    }
    
    @Override
    public default void putAll(Map m) {
        throw new ReadOnlyMapException(this);
    }
    
    @Override
    public default void clear() {
        throw new ReadOnlyMapException(this);
    }
    
    @Override
    public void forEach(BiConsumer action);
    
    @Override
    public default void replaceAll(BiFunction function) {
        throw new ReadOnlyMapException(this);
    }
    
    @Override
    public default VALUE putIfAbsent(KEY key, VALUE value) {
        throw new ReadOnlyMapException(this);
    }
    
    @Override
    public default boolean remove(Object key, Object value) {
        throw new ReadOnlyMapException(this);
    }
    
    @Override
    public default boolean replace(KEY key, VALUE oldValue, VALUE newValue) {
        throw new ReadOnlyMapException(this);
    }
    
    @Override
    public default VALUE replace(KEY key, VALUE value) {
        throw new ReadOnlyMapException(this);
    }
    
    @Override
    public default VALUE computeIfAbsent(KEY key, Function mappingFunction) {
        throw new ReadOnlyMapException(this);
    }
    
    @Override
    public default VALUE computeIfPresent(KEY key, BiFunction remappingFunction) {
        throw new ReadOnlyMapException(this);
    }
    
    @Override
    public default VALUE compute(KEY key, BiFunction remappingFunction) {
        throw new ReadOnlyMapException(this);
    }
    
    @Override
    public default VALUE merge(KEY key, VALUE value, BiFunction remappingFunction) {
        throw new ReadOnlyMapException(this);
    }
    
}