Package de.eldoria.schematicbrush.storage.brush

Class Brush

java.lang.Object

de.eldoria.schematicbrush.storage.brush.Brush

All Implemented Interfaces:

Comparable<Brush>, ConfigurationSerializable

public class Brush
extends Object
implements ConfigurationSerializable, Comparable<Brush>

Class used for serialization and saving of a BrushBuilderSnapshot/

Field Summary

Fields

Modifier and Type	Field	Description
protected String	description

Constructor Summary

Constructors

Constructor	Description
Brush(String name, BrushBuilder builder)	Constructs a new brush with the given brush.
Brush(String name, BrushBuilderSnapshot snapshot)	Constructs a new brush with the given brush.
Brush(String name, String description, BrushBuilderSnapshot snapshot)	Constructs a new brush with the given snapshot.

Method Summary

Modifier and Type	Method	Description
int	compareTo(@NotNull Brush o)
String	description()
void	description(String description)
static Brush	deserialize(Map<String,Object> objectMap)	Constructor required by ConfigurationSerializable in order to deserialize the object.
String	detailComponent(boolean global, BrushSettingsRegistry registry)
boolean	equals(Object o)
int	hashCode()
String	infoComponent(boolean global, boolean canDelete, BrushSettingsRegistry registry)
String	name()	Name of brush
@NotNull Map<String,Object>	serialize()
String	simpleComponent(BrushSettingsRegistry registry)
BrushBuilderSnapshot	snapshot()	Snapshot of the brush

Methods inherited from class java.lang.Object

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

Field Details

description

protected String description

Constructor Details

Brush

public Brush(String name,
 String description,
 BrushBuilderSnapshot snapshot)

Constructs a new brush with the given snapshot.

Parameters:

name - name of brush

snapshot - snapshot of brush

Brush

public Brush(String name,
 BrushBuilder builder)

Constructs a new brush with the given brush.

Parameters:

name - name of brush

builder - brush builder

Brush

public Brush(String name,
 BrushBuilderSnapshot snapshot)

Constructs a new brush with the given brush.

Parameters:

name - name of brush

snapshot - snapshot

Method Details

deserialize

public static Brush deserialize(Map<String,Object> objectMap)

Constructor required by ConfigurationSerializable in order to deserialize the object.

Parameters:

objectMap - map of the already deserialized object

serialize

@NotNull
public @NotNull Map<String,Object> serialize()

Specified by:

serialize in interface ConfigurationSerializable

name

public String name()

Name of brush

Returns:

name

snapshot

public BrushBuilderSnapshot snapshot()

Snapshot of the brush

Returns:

snapshot

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

description

public void description(String description)

description

public String description()

compareTo

public int compareTo(@NotNull
 @NotNull Brush o)

Specified by:

compareTo in interface Comparable<Brush>

simpleComponent

public String simpleComponent(BrushSettingsRegistry registry)

infoComponent

public String infoComponent(boolean global,
 boolean canDelete,
 BrushSettingsRegistry registry)

detailComponent

public String detailComponent(boolean global,
 BrushSettingsRegistry registry)