org.technologybrewery.fermenter.mda.notification.Notification Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of fermenter-mda Show documentation

The newest version!

package org.technologybrewery.fermenter.mda.notification;

import com.fasterxml.jackson.annotation.JsonIgnore;

import java.io.File;
import java.util.Set;

/**
 * A notification of a required action to present to the user during project generation.
 */
public interface Notification {

    /**
     * Returns the unique key representing the type of action indicated by this notification.
     *
     * @return the notification key
     */
    String getKey();

    /**
     * Returns a grouping that this notification should be displayed in conjunction with.
     *
     * @return group
     */
    String getGroup();

    /**
     * Determines if a group is set for this notification.
     *
     * @return true if set, false if not
     */
    boolean hasGroup();

    /**
     * Returns the list of action items to request from the user.
     *
     * @return the actions required
     */
    Set getItems();

    /**
     * Add multiple action items to the notification.
     *
     * @param items tne set of action items to add
     */
    void addItems(Set items);

    /**
     * Returns the notification as string that can be output to the console.
     *
     * @return notification content
     */
    String getNotificationAsString();

    /**
     * The file where the notification's JSON representation was stored, if applicable.
     *
     * @return json file location
     */
    @JsonIgnore
    File getFile();

}