com.helger.http.AbstractQValueList Maven / Gradle / Ivy

Go to download
/**
 * Copyright (C) 2014-2020 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.http;

import java.io.Serializable;
import java.util.Map;

import javax.annotation.Nonnull;

import com.helger.commons.annotation.ReturnsMutableCopy;
import com.helger.commons.collection.impl.CommonsLinkedHashMap;
import com.helger.commons.collection.impl.ICommonsOrderedMap;
import com.helger.commons.string.ToStringGenerator;

/**
 * Represents a base class for all QValue'd stuff
 *
 * @author Philip Helger
 * @param 
 *        The key type for the map. Must implement Serializable.
 */
public abstract class AbstractQValueList  implements Serializable
{
  // Maps something to quality
  private final ICommonsOrderedMap  m_aMap = new CommonsLinkedHashMap <> ();

  public AbstractQValueList ()
  {}

  @Nonnull
  @ReturnsMutableCopy
  protected final ICommonsOrderedMap  qvalueMap ()
  {
    return m_aMap;
  }

  @Nonnull
  @ReturnsMutableCopy
  public final ICommonsOrderedMap  getAllQValues ()
  {
    return m_aMap.getClone ();
  }

  @Nonnull
  @ReturnsMutableCopy
  public final ICommonsOrderedMap  getAllQValuesLowerThan (final double dQuality)
  {
    final ICommonsOrderedMap  ret = new CommonsLinkedHashMap <> ();
    for (final Map.Entry  aEntry : m_aMap.entrySet ())
    {
      final QValue aQValue = aEntry.getValue ();
      if (aQValue.getQuality () < dQuality)
        ret.put (aEntry.getKey (), aQValue);
    }
    return ret;
  }

  @Nonnull
  @ReturnsMutableCopy
  public final ICommonsOrderedMap  getAllQValuesLowerOrEqual (final double dQuality)
  {
    final ICommonsOrderedMap  ret = new CommonsLinkedHashMap <> ();
    for (final Map.Entry  aEntry : m_aMap.entrySet ())
    {
      final QValue aQValue = aEntry.getValue ();
      if (aQValue.getQuality () <= dQuality)
        ret.put (aEntry.getKey (), aQValue);
    }
    return ret;
  }

  @Nonnull
  @ReturnsMutableCopy
  public final ICommonsOrderedMap  getAllQValuesGreaterThan (final double dQuality)
  {
    final ICommonsOrderedMap  ret = new CommonsLinkedHashMap <> ();
    for (final Map.Entry  aEntry : m_aMap.entrySet ())
    {
      final QValue aQValue = aEntry.getValue ();
      if (aQValue.getQuality () > dQuality)
        ret.put (aEntry.getKey (), aQValue);
    }
    return ret;
  }

  @Nonnull
  @ReturnsMutableCopy
  public final ICommonsOrderedMap  getAllQValuesGreaterOrEqual (final double dQuality)
  {
    final ICommonsOrderedMap  ret = new CommonsLinkedHashMap <> ();
    for (final Map.Entry  aEntry : m_aMap.entrySet ())
    {
      final QValue aQValue = aEntry.getValue ();
      if (aQValue.getQuality () >= dQuality)
        ret.put (aEntry.getKey (), aQValue);
    }
    return ret;
  }

  @Override
  public String toString ()
  {
    return new ToStringGenerator (this).append ("map", m_aMap).getToString ();
  }
}