com.helger.commons.collection.impl.ICommonsNavigableMap Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ph-commons Show documentation

Java 1.8+ Library with tons of utility classes required in all projects

There is a newer version: 11.1.10

/*
 * Copyright (C) 2014-2022 Philip Helger (www.helger.com)
 * philip[at]helger[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.helger.commons.collection.impl;

import java.util.Collections;
import java.util.NavigableMap;

import javax.annotation.Nonnull;

import com.helger.commons.annotation.CodingStyleguideUnaware;
import com.helger.commons.annotation.ReturnsMutableCopy;

/**
 * A special {@link NavigableMap} interface based on {@link ICommonsSortedMap}.
 *
 * @author Philip Helger
 * @param 
 *        Map key type
 * @param 
 *        Map value type
 */
public interface ICommonsNavigableMap  extends NavigableMap , ICommonsSortedMap 
{
  @Override
  @Nonnull
  @CodingStyleguideUnaware
  default NavigableMap  getAsUnmodifiable ()
  {
    return Collections.unmodifiableNavigableMap (this);
  }

  @Nonnull
  @ReturnsMutableCopy
  ICommonsNavigableMap  getClone ();
}