com.icfolson.aem.library.api.link.Link Maven / Gradle / Ivy

Go to download
package com.icfolson.aem.library.api.link;

import java.io.Serializable;
import java.util.List;
import java.util.Map;

import com.fasterxml.jackson.annotation.JsonAutoDetect;
import com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility;
import com.fasterxml.jackson.annotation.JsonInclude;

/**
 * A link represents the attributes that compose a URL with additional title and
 * target properties to encapsulate the typical attributes of an HTML anchor
 * tag.
 */
@JsonInclude(JsonInclude.Include.NON_NULL)
@JsonAutoDetect(isGetterVisibility = Visibility.NONE)
public interface Link extends Serializable {

	/**
	 * @return extension
	 */
	String getExtension();

	/**
	 * @return href (path with extension)
	 */
	String getHref();

	/**
	 * @return path
	 */
	String getPath();

	/**
	 * @return property map
	 */
	Map getProperties();

	/**
	 * @return query string starting with '?' or empty string if no parameters
	 *         present
	 */
	String getQueryString();

	/**
	 * @return list of selector values or empty list if none exist
	 */
	List getSelectors();

	/**
	 * @return suffix
	 */
	String getSuffix();

	/**
	 * @return link target
	 */
	String getTarget();

	/**
	 * @return link title
	 */
	String getTitle();

	/**
	 * @return true if href is null or empty
	 */
	boolean isEmpty();

	/**
	 * @return if href is to an external URL
	 */
	boolean isExternal();
}