com.helger.commons.url.IURLProtocol 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-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.commons.url;

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

import com.helger.commons.annotation.Nonempty;

/**
 * Base interface for an URL protocol descriptor. See {@link EURLProtocol} for
 * an implementation.
 *
 * @author Philip Helger
 */
public interface IURLProtocol
{
  /**
   * Retrieve the URL protocol prefix to be used. May contain "//".
   *
   * @return The underlying text representation of the protocol. Never
   *         null nor empty.
   */
  @Nonnull
  @Nonempty
  String getProtocol ();

  /**
   * Tells if the passed String (URL) belongs to this protocol.
   *
   * @param sURL
   *        The URL to check. May be null.
   * @return true if the passed URL starts with this protocol
   */
  boolean isUsedInURL (@Nullable String sURL);

  /**
   * Prefix the passed URL with this protocol.
   *
   * @param sURL
   *        The URL to be prefixed. May be null.
   * @return null if the parameter is null. The
   *         protocol is prepended independent whether the URL already has a
   *         protocol or not.
   */
  @Nullable
  String getWithProtocol (@Nullable String sURL);

  /**
   * Prefix the passed URL with this protocol if the URL does not have a
   * protocol yet.
   *
   * @param sURL
   *        The URL to be prefixed. May be null.
   * @return null if the parameter is null. The
   *         protocol is prepended if the URL not already has a protocol.
   */
  @Nullable
  String getWithProtocolIfNone (@Nullable String sURL);

  /**
   * @return true if this protocol can handle HTTP query parameters
   *         (?x=y&z=1), false if not.
   */
  boolean allowsForQueryParameters ();
}