ml.alternet.facet.Localizable Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of alternet-tools Show documentation

Alternet Tools include discovery service tools, concurrent and locking tools, and more

The newest version!

package ml.alternet.facet;

import java.util.Optional;

/**
 * A Localizable component may have an absolute URI.
 *
 * 
 * A localizable component may be used to resolve relative paths.
 * 
 *
 * 
 * Classes that implement this interface may have instances that are not
 * localizable ; in this case, trying to resolve relative paths is irrelevant
 * for such instances.
 * 
 * 
 * @param 
 *            The type of URI (typically String, URI, URL, File, etc).
 *
 * @author Philippe Poulard
 */
public interface Localizable {

    /**
     * Return the absolute localization of this component.
     *
     * @return The URI of this component.
     */
    Optional getLocation();

    /**
     * Set the localization of this component.
     *
     * @param location
     *            The absolute URI of this component.
     */
    void setLocation(T location);

}