com.groupbyinc.common.apache.commons.collections4.IterableGet Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You 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 org.apache.commons.collections4;
/**
* The "read" subset of the {@link java.util.Map} interface.
*
* @since 4.0
* @version $Id: IterableGet.java 1477779 2013-04-30 18:55:24Z tn $
*
* @see Put
*/
public interface IterableGet extends Get {
/**
* Obtains a MapIterator over the map.
*
* A map iterator is an efficient way of iterating over maps.
* There is no need to access the entry set or use Map Entry objects.
*
* IterableMap map = new HashedMap();
* MapIterator it = map.mapIterator();
* while (it.hasNext()) {
* String key = it.next();
* Integer value = it.getValue();
* it.setValue(value + 1);
* }
*
*
* @return a map iterator
*/
MapIterator mapIterator();
}