com.phloc.web.http.AbstractQValueList Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of phloc-web Show documentation
Library with basic web functionality
There is a newer version: 6.0.0
/**
 * 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.web.http;

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

import javax.annotation.Nonnull;

import com.phloc.commons.annotations.ReturnsMutableCopy;
import com.phloc.commons.collections.ContainerHelper;
import com.phloc.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
  protected final Map  m_aMap = new LinkedHashMap  ();

  public AbstractQValueList ()
  {}

  @Nonnull
  @ReturnsMutableCopy
  public Map  getAllQValues ()
  {
    return ContainerHelper.newMap (m_aMap);
  }

  @Nonnull
  @ReturnsMutableCopy
  public final Map  getAllQValuesLowerThan (final double dQuality)
  {
    final Map  ret = new HashMap  ();
    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 Map  getAllQValuesLowerOrEqual (final double dQuality)
  {
    final Map  ret = new HashMap  ();
    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 Map  getAllQValuesGreaterThan (final double dQuality)
  {
    final Map  ret = new HashMap  ();
    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 Map  getAllQValuesGreaterOrEqual (final double dQuality)
  {
    final Map  ret = new HashMap  ();
    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).toString ();
  }
}