com.icfolson.aem.library.api.ImageSource Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of aem-library-api Show documentation

There is a newer version: 13.0.1-beta

package com.icfolson.aem.library.api;

import com.google.common.base.Optional;

/**
 * Definition for items with associated images, such as pages and components.
 */
public interface ImageSource {

    /**
     * Get the image source for the default image (named "image") for this node. Uses the image servlet rather than a
     * direct reference to the DAM path.
     *
     * @return optional image source (absent if the referenced image has no content)
     */
    Optional getImageSource();

    /**
     * Get the image source for the default image (named "image") for this node for the given width.
     *
     * @param width image width
     * @return optional image source (absent if the referenced image has no content)
     */
    Optional getImageSource(int width);

    /**
     * Get the image source for this node for the named image.
     *
     * @param name image name (name of image as defined in dialog)
     * @return optional image source (absent if the referenced image has no content)
     */
    Optional getImageSource(String name);

    /**
     * Get the image source for this node for the named image and given width.
     *
     * @param name image name (name of image as defined in dialog)
     * @param width image width
     * @return optional image source (absent if the referenced image has no content)
     */
    Optional getImageSource(String name, int width);

    /**
     * Check if the current resource has a default image.
     *
     * @return true if image has content
     */
    boolean isHasImage();

    /**
     * Check if the current resource has a named image.
     *
     * @param name image name (name of image as defined in dialog)
     * @return true if image has content
     */
    boolean isHasImage(String name);
}