Package de.eldoria.schematicbrush.brush.config.modifier

Class BaseModifier

java.lang.Object

de.eldoria.schematicbrush.brush.config.util.Nameable

de.eldoria.schematicbrush.brush.config.modifier.BaseModifier

Direct Known Subclasses:

PlacementModifier, SchematicModifier

public class BaseModifier
extends Nameable

Represents a modifier.

A modifier is an extended Nameable which also has a description.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BaseModifier(String name, String description, boolean required)
	BaseModifier(String name, String description, String localizedName, boolean required)

Method Summary

Modifier and Type	Method	Description
String	description()	Get a short explanation about this modifier.
String	getLocalizedName()
boolean	required()	Defines whether this provider is required or not for a brush.

Methods inherited from class de.eldoria.schematicbrush.brush.config.util.Nameable

equals, hashCode, name, of, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

BaseModifier

public BaseModifier(String name,
 String description,
 String localizedName,
 boolean required)

BaseModifier

protected BaseModifier(String name,
 String description,
 boolean required)

Method Details

description

public String description()

Get a short explanation about this modifier.

Returns:

the description

required

public boolean required()

Defines whether this provider is required or not for a brush. If the brush behaviour wouldn't change when the default value is applied a modifier is usually not considered required.

Returns:

true if the modifier is required.

getLocalizedName

public String getLocalizedName()