src/main/java/li/cil/oc/api/fs/Label.java

package li.cil.oc.api.fs;

import li.cil.oc.api.Persistable;

/**
 * Used by file system components to get and set the file system's label.
 *
 * @see li.cil.oc.api.FileSystem#asManagedEnvironment(FileSystem, Label)
 */
public interface Label extends Persistable {
    /**
     * Get the current value of this label.
     * <p/>
     * May be <tt>null</tt> if no label is set.
     *
     * @return the current label.
     */
    String getLabel();

    /**
     * Set the new value of this label.
     * <p/>
     * May be set to <tt>null</tt> to clear the label.
     * <p/>
     * May throw an exception if the label is read-only.
     *
     * @param value the new label.
     * @throws IllegalArgumentException if the label is read-only.
     */
    void setLabel(String value);
}