Package org.spongepowered.api.map.color

Interface MapColor.Builder

All Superinterfaces:

ResettableBuilder<MapColor,MapColor.Builder>

Enclosing interface:

MapColor

public static interface MapColor.Builder
extends ResettableBuilder<MapColor,MapColor.Builder>

Builds a MapColor

Method Summary

Modifier and Type	Method	Description
MapColor.Builder	base()	Sets the MapShade to MapShades.BASE.
default MapColor.Builder	baseColor(java.util.function.Supplier<MapColorType> mapColorTypeSupplier)	Method to ease using MapColorTypes enumerations.
MapColor.Builder	baseColor(MapColorType mapColor)	Sets the MapColorType that will form the basis of the built MapColor.
MapColor	build()	Creates a MapColor that represents the combination of this MapColorType and MapShade.
MapColor.Builder	dark()	Sets the MapShade to MapShades.DARK.
MapColor.Builder	darker()	Sets the MapShade to MapShades.DARKER.
MapColor.Builder	darkest()	Sets the MapShade to MapShades.DARKEST.
MapColor.Builder	from(MapColor mapColor)	Copies all data from the given MapColor and applies it to this builder.
MapColor.Builder	fromContainer(DataView container)	Attempts to reconstruct the builder with all of the data from DataSerializable.toContainer().
MapColor.Builder	shade(MapShade shade)	Sets the MapShade of the supplied MapColor.color().

Methods inherited from interface org.spongepowered.api.util.ResettableBuilder

reset

Method Detail

shade

MapColor.Builder shade(MapShade shade)

Sets the MapShade of the supplied MapColor.color().

If this method is not called, MapShades.BASE is used.

Parameters:

shade - The MapShade to use

Returns:

This builder, for chaining

base

MapColor.Builder base()

Sets the MapShade to MapShades.BASE.

Returns:

This builder, for chaining

dark

MapColor.Builder dark()

Sets the MapShade to MapShades.DARK.

Returns:

This builder, for chaining

darker

MapColor.Builder darker()

Sets the MapShade to MapShades.DARKER.

Returns:

This builder, for chaining

darkest

MapColor.Builder darkest()

Sets the MapShade to MapShades.DARKEST.

Returns:

This builder, for chaining

baseColor

MapColor.Builder baseColor(MapColorType mapColor)

Sets the MapColorType that will form the basis of the built MapColor.

Parameters:

mapColor - the MapColorType

Returns:

This builder, for chaining

baseColor

default MapColor.Builder baseColor(java.util.function.Supplier<MapColorType> mapColorTypeSupplier)

Method to ease using MapColorTypes enumerations. Unwraps then calls baseColor(MapColorType)

Parameters:

mapColorTypeSupplier - Supplier to be unwrapped and applied

Returns:

This builder, for chaining

from

MapColor.Builder from(MapColor mapColor)

Copies all data from the given MapColor and applies it to this builder. Therefore, if build() is called directly after, the result of Objects.equals(Object, Object) between them will be true. Any aspect of this builder could then be modified to produce similar but not identical MapColors.

Parameters:

mapColor - MapColor to copy data from.

Returns:

This builder, for chaining

fromContainer

MapColor.Builder fromContainer(DataView container)

Attempts to reconstruct the builder with all of the data from DataSerializable.toContainer().

Parameters:

container - The container to translate

Returns:

This builder, for chaining

build

MapColor build()
        throws java.lang.IllegalStateException

Creates a MapColor that represents the combination of this MapColorType and MapShade.

Returns:

The MapColor

Throws:

java.lang.IllegalStateException - if no MapColorType was provided