Package org.spongepowered.api.scoreboard.objective

Interface Objective.Builder

All Superinterfaces:

AbstractBuilder<Objective>, Builder<Objective,Objective.Builder>, CopyableBuilder<Objective,Objective.Builder>, ResettableBuilder<Objective,Objective.Builder>

Enclosing interface:

Objective

public static interface Objective.Builder
extends Builder<Objective,Objective.Builder>, CopyableBuilder<Objective,Objective.Builder>

Represents a builder to create Objective instances.

Method Summary

Modifier and Type	Method	Description
Objective	build()	Builds an instance of an Objective.
default Objective.Builder	criterion(Supplier<? extends Criterion> criterion)	Sets the Criterion of the Objective.
Objective.Builder	criterion(Criterion criterion)	Sets the Criterion of the Objective.
Objective.Builder	displayName(Component displayName)	Sets the display name of the Objective.
Objective.Builder	name(String name)	Sets the name of the Objective.
default Objective.Builder	objectiveDisplayMode(Supplier<? extends ObjectiveDisplayMode> objectiveDisplayMode)	Sets the ObjectiveDisplayMode of the Objective.
Objective.Builder	objectiveDisplayMode(ObjectiveDisplayMode objectiveDisplayMode)	Sets the ObjectiveDisplayMode of the Objective.

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

reset

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

from

Method Details

name

Objective.Builder name(String name)

Sets the name of the Objective.

Parameters:

name - The name to set

Returns:

This builder

displayName

Objective.Builder displayName(Component displayName)

Sets the display name of the Objective.

Parameters:

displayName - The display name to set

Returns:

This builder

criterion

default Objective.Builder criterion(Supplier<? extends Criterion> criterion)

Sets the Criterion of the Objective.

Parameters:

criterion - The Criterion to set

Returns:

This builder

criterion

Objective.Builder criterion(Criterion criterion)

Sets the Criterion of the Objective.

Parameters:

criterion - The Criterion to set

Returns:

This builder

objectiveDisplayMode

default Objective.Builder objectiveDisplayMode(Supplier<? extends ObjectiveDisplayMode> objectiveDisplayMode)

Sets the ObjectiveDisplayMode of the Objective.

Parameters:

objectiveDisplayMode - The ObjectiveDisplayMode to set

Returns:

This builder

objectiveDisplayMode

Objective.Builder objectiveDisplayMode(ObjectiveDisplayMode objectiveDisplayMode)

Sets the ObjectiveDisplayMode of the Objective.

Parameters:

objectiveDisplayMode - The ObjectiveDisplayMode to set

Returns:

This builder

build

Objective build()
         throws IllegalStateException

Builds an instance of an Objective.

Specified by:

build in interface AbstractBuilder<Objective>

Returns:

A new instance of an Objective

Throws:

IllegalStateException - if the Objective is not complete