li.cil.oc.api.fs

Interface Label

All Superinterfaces:

Persistable

public interface Label
extends Persistable

Used by file system components to get and set the file system's label.

See Also:

FileSystem.asManagedEnvironment(FileSystem, Label)

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getLabel() Get the current value of this label.
void	setLabel(java.lang.String value) Set the new value of this label.

Methods inherited from interface li.cil.oc.api.Persistable

load, save

Method Detail

getLabel

java.lang.String getLabel()

Get the current value of this label.

May be null if no label is set.

Returns:

the current label.

setLabel

void setLabel(java.lang.String value)

Set the new value of this label.

May be set to null to clear the label.

May throw an exception if the label is read-only.

Parameters:

value - the new label.

Throws:

java.lang.IllegalArgumentException - if the label is read-only.