URLComponent.java

/* 
 * The MIT License
 *
 * Copyright 2013 Tim Boudreau.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package com.mastfrog.url;

import java.io.Serializable;

/**
 * One element of a URL, such as a Host, Port, Password, Path, PathElement,
 * Parameters or ParametersElement.
 *
 * @author Tim Boudreau
 */
public interface URLComponent extends Serializable {
    /**
     * Determine if this component is in compliance with the RFCs governing
     * URLs and DNS.
     * @return True if this component is valid.
     */
    public boolean isValid();
    /**
     * Get a human-readable, localized name for this part of the URL.
     * Useful if an error message needs to be shown.
     * @return The component name
     */
    public String getComponentName();
    /**
     * Append this component to a StringBuilder.
     * @param sb A StringBuilder
     */
    public void appendTo (StringBuilder sb);
}