com.softicar.platform.common.io.resource.key.IResourceKey Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of platform-common Show documentation

The SoftiCAR Platform is a lightweight, Java-based library to create interactive business web applications.

There is a newer version: 50.0.0

package com.softicar.platform.common.io.resource.key;

import com.softicar.platform.common.io.resource.IResource;

/**
 * Abstractly identifies an {@link IResource}.
 *
 * @author Alexander Schmidt
 */
public interface IResourceKey extends Comparable {

	/**
	 * Returns the name of the package in which the {@link IResource} resides.
	 * 
	 * All letters in the returned {@link String} are lower-case.
	 *
	 * @return the package name of the {@link IResource} (never null)
	 */
	String getPackageName();

	/**
	 * Returns a new {@link ResourceKeyBasename}, derived from the file name of
	 * the {@link IResource}.
	 *
	 * @return the {@link ResourceKeyBasename} of the {@link IResource} (never
	 *         null)
	 */
	ResourceKeyBasename getBasename();

	/**
	 * Returns a new {@link ResourceKeySuperMimeType}, derived from the file
	 * name of the {@link IResource}.
	 *
	 * @return the {@link ResourceKeySuperMimeType} of the {@link IResource}
	 *         (never null)
	 */
	ResourceKeySuperMimeType getSuperMimeType();
}