Package wbs.utils.util.providers.generator.num

Class ClampGenerator

java.lang.Object

wbs.utils.util.providers.generator.num.DoubleGenerator

wbs.utils.util.providers.generator.num.ClampGenerator

All Implemented Interfaces:

Provider, Refreshable

public class ClampGenerator
extends DoubleGenerator

A generator that takes a NumProvider and clamps it between two other NumProviders

Constructor Summary

Constructors

Constructor	Description
ClampGenerator(double min, double max, double value)
ClampGenerator(org.bukkit.configuration.ConfigurationSection section, WbsSettings settings, String directory)	Create this generator from a ConfigurationSection, logging errors in the given settings
ClampGenerator(ClampGenerator clone)	Clone constructor.
ClampGenerator(NumProvider min, NumProvider max, NumProvider value)

Method Summary

Modifier and Type	Method	Description
ClampGenerator	clone()
protected double	getNewValue()	Generate a new value to override the current one
protected void	refreshInternal()	An internal method called before DoubleGenerator.getNewValue(), to allow implementing classes to refresh the provider in a controlled way.
void	writeToConfig(org.bukkit.configuration.ConfigurationSection section, String path)	Save this provider in a config (that can often by read by its constructor)

Methods inherited from class wbs.utils.util.providers.generator.num.DoubleGenerator

getValue, refresh

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ClampGenerator

public ClampGenerator(ClampGenerator clone)

Clone constructor.

Parameters:

clone - The object to clone from.

ClampGenerator

public ClampGenerator(double min,
 double max,
 double value)

ClampGenerator

public ClampGenerator(NumProvider min,
 NumProvider max,
 NumProvider value)

ClampGenerator

public ClampGenerator(org.bukkit.configuration.ConfigurationSection section,
 WbsSettings settings,
 String directory)

Create this generator from a ConfigurationSection, logging errors in the given settings

Parameters:

section - The section where this generator is defined

settings - The settings to log errors against

directory - The path taken through the config to get to this point, for logging purposes

Method Details

refreshInternal

protected void refreshInternal()

Description copied from class: DoubleGenerator

An internal method called before DoubleGenerator.getNewValue(), to allow implementing classes to refresh the provider in a controlled way.

Overrides:

refreshInternal in class DoubleGenerator

getNewValue

protected double getNewValue()

Description copied from class: DoubleGenerator

Generate a new value to override the current one

Specified by:

getNewValue in class DoubleGenerator

Returns:

The new value

writeToConfig

public void writeToConfig(org.bukkit.configuration.ConfigurationSection section,
 String path)

Description copied from interface: Provider

Save this provider in a config (that can often by read by its constructor)

Specified by:

writeToConfig in interface Provider

Specified by:

writeToConfig in class DoubleGenerator

Parameters:

section - The section to write to

path - The field/path inside the given section

clone

public ClampGenerator clone()

Specified by:

clone in class DoubleGenerator