com.helger.commons.url.IURLData 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.6+ Library with tons of utility classes required in all projects
There is a newer version: 9.5.5
/**
 * Copyright (C) 2014-2016 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.url;

import java.io.Serializable;

import javax.annotation.Nonnegative;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;

import com.helger.commons.annotation.ReturnsMutableCopy;
import com.helger.commons.annotation.ReturnsMutableObject;
import com.helger.commons.collection.ext.ICommonsList;
import com.helger.commons.equals.EqualsHelper;
import com.helger.commons.string.StringHelper;

/**
 * Base interface representing the basic elements of a URL from a high level
 * perspective.
 *
 * @author Philip Helger
 */
public interface IURLData extends Serializable
{
  /**
   * @return The protocol used. May be null for an unknown
   *         protocol.
   */
  @Nullable
  default IURLProtocol getProtocol ()
  {
    return URLProtocolRegistry.getInstance ().getProtocol (getPath ());
  }

  /**
   * @return true if the URL has a known protocol
   */
  default boolean hasKnownProtocol ()
  {
    return URLProtocolRegistry.getInstance ().hasKnownProtocol (getPath ());
  }

  /**
   * @return The path part of the URL (everything before the "?" and the "#",
   *         incl. the protocol). Never null but maybe empty (e.g.
   *         for "?x=y").
   */
  @Nonnull
  String getPath ();

  /**
   * @return true if at least one parameter is present,
   *         false otherwise.
   */
  boolean hasParams ();

  /**
   * @return The number of parameters present. Always ≥ 0.
   */
  @Nonnegative
  int getParamCount ();

  /**
   * @return A map of all query string parameters. May be null.
   */
  @Nullable
  @ReturnsMutableObject ("design")
  URLParameterList directGetAllParams ();

  /**
   * @return A map of all query string parameters in the order they were passed
   *         on. Never null.
   */
  @Nonnull
  @ReturnsMutableCopy
  URLParameterList getAllParams ();

  /**
   * Check if at least one parameter with the given name is contained.
   *
   * @param sName
   *        The name to check. May be null.
   * @return true if at least one parameter with this name is
   *         present, false otherwise.
   */
  boolean containsParam (@Nullable String sName);

  /**
   * Get the first parameter value of the given key.
   *
   * @param sName
   *        The key to check. May be null.
   * @return null if no such parameter is present.
   */
  @Nullable
  String getParam (@Nullable String sName);

  /**
   * Get all parameter values of the passed key.
   *
   * @param sName
   *        The key to check. May be null.
   * @return A non-null but maybe empty list.
   */
  @Nonnull
  @ReturnsMutableCopy
  ICommonsList  getAllParams (@Nullable String sName);

  /**
   * @return The name of the anchor (everything after the "#") or
   *         null if none is defined.
   */
  @Nullable
  String getAnchor ();

  /**
   * @return true if an anchor is present, false
   *         otherwise.
   */
  default boolean hasAnchor ()
  {
    return StringHelper.hasText (getAnchor ());
  }

  /**
   * Check if this URL has an anchor with the passed name.
   *
   * @param sAnchor
   *        The anchor name to check.
   * @return true if the passed anchor is present.
   */
  default boolean hasAnchor (@Nullable final String sAnchor)
  {
    return EqualsHelper.equals (sAnchor, getAnchor ());
  }
}