com.phloc.commons.url.IURLData Maven / Gradle / Ivy
/**
* Copyright (C) 2006-2014 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.commons.url;
import java.io.Serializable;
import java.util.Map;
import javax.annotation.Nonnegative;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import com.phloc.commons.annotations.ReturnsMutableCopy;
import com.phloc.commons.annotations.ReturnsMutableObject;
/**
* 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
IURLProtocol getProtocol ();
/**
* @return true if the URL has a known protocol
*/
boolean hasKnownProtocol ();
/**
* @return The path part of the URL (everything before the "?" and the "#",
* incl. the protocol)
*/
@Nonnull
String getPath ();
/**
* @return true if at least one parameter is present.
*/
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 (reason = "design")
Map directGetParams ();
/**
* @return A map of all query string parameters in the order they were passed
* on. Never null.
*/
@Nonnull
@ReturnsMutableCopy
Map getAllParams ();
/**
* @return true if an anchor is present
*/
boolean hasAnchor ();
/**
* @return The name of the anchor (everything after the "#") or
* null if none is defined.
*/
@Nullable
String getAnchor ();
}