com.helger.photon.api.pathdescriptor.PathMatchingResult Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ph-oton-api Show documentation
ph-oton API stuff
The newest version!
/*
 * Copyright (C) 2014-2024 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.photon.api.pathdescriptor;

import java.io.Serializable;

import javax.annotation.Nonnull;

import com.helger.commons.ValueEnforcer;
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;

/**
 * This class represents the overall result of a path matching. Upon successful
 * matching all variable path parts are returned as a map in the order of the
 * path.
 *
 * @author Philip Helger
 */
public final class PathMatchingResult implements Serializable
{
  public static final PathMatchingResult NO_MATCH = new PathMatchingResult ();

  private final boolean m_bMatch;
  private final ICommonsOrderedMap  m_aVariableValues;

  /**
   * Internal constructor for "no match"
   */
  private PathMatchingResult ()
  {
    m_bMatch = false;
    m_aVariableValues = null;
  }

  /**
   * Constructor for "match"
   *
   * @param aVariableValues
   *        Non-null but may empty matching variables.
   */
  public PathMatchingResult (@Nonnull final ICommonsOrderedMap  aVariableValues)
  {
    ValueEnforcer.notNull (aVariableValues, "VariableValues");
    m_bMatch = true;
    m_aVariableValues = aVariableValues;
  }

  /**
   * @return true if the path matching was successful,
   *         false otherwise.
   */
  public boolean isMatch ()
  {
    return m_bMatch;
  }

  @Nonnull
  @ReturnsMutableCopy
  public ICommonsOrderedMap  getAllVariableValues ()
  {
    return new CommonsLinkedHashMap <> (m_aVariableValues);
  }

  @Override
  public String toString ()
  {
    return new ToStringGenerator (null).append ("Match", m_bMatch).appendIfNotNull ("VariableValues", m_aVariableValues).getToString ();
  }

  @Nonnull
  public static PathMatchingResult createSuccess (@Nonnull final ICommonsOrderedMap  aVariableValues)
  {
    return new PathMatchingResult (aVariableValues);
  }
}