URLTransform.java

/*******************************************************************************
 * Copyright 2012 Geoscience Australia
 * 
 * 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 au.gov.ga.earthsci.worldwind.common.util.transform;

/**
 * Defines a transformation from a url string to a transformed url string. For
 * example, this may be used to add a port number to urls that match a certain
 * pattern.
 * 
 * @author Michael de Hoog (michael.dehoog@ga.gov.au)
 */
public interface URLTransform
{
	/**
	 * Transform the given url
	 * 
	 * @param url
	 *            Url to transform
	 * @return Transformed url
	 */
	String transformURL(String url);
}