Package wbs.utils.util.providers.generator.vector

Class VectorGenerator

java.lang.Object

wbs.utils.util.providers.generator.vector.VectorGenerator

All Implemented Interfaces:

Provider, Refreshable

Direct Known Subclasses:

VectorBinaryFunctionalGenerator, VectorFunctionalGenerator, VectorGeneratorNormalise, VectorGeneratorRotate

public abstract class VectorGenerator
extends Object
implements Provider

A generator that returns a single Vector until refresh() is called, at which point it calculates a new value.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	VectorGenerator.VectorGeneratorType	Represents the subclasses of this generator.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	VectorGenerator()
	VectorGenerator(org.bukkit.configuration.ConfigurationSection section, WbsSettings settings, String directory)	Create this generator from a ConfigurationSection, logging errors in the given settings

Method Summary

Modifier and Type	Method	Description
static VectorGenerator	buildGenerator(String typeString, org.bukkit.configuration.ConfigurationSection section, WbsSettings settings, String directory)	Get a VectorGenerator based on a configuration section
abstract VectorGenerator	clone()
protected abstract org.bukkit.util.Vector	getNewValue()
org.bukkit.util.Vector	getValue()
final void	refresh()	Generate a new value
protected void	refreshInternal()
abstract void	writeToConfig(org.bukkit.configuration.ConfigurationSection section, String path)	Save this generator in a config that can be read by its constructor

Methods inherited from class java.lang.Object

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

Constructor Details

VectorGenerator

protected VectorGenerator()

VectorGenerator

public VectorGenerator(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

buildGenerator

public static VectorGenerator buildGenerator(String typeString,
 org.bukkit.configuration.ConfigurationSection section,
 WbsSettings settings,
 String directory)

Get a VectorGenerator based on a configuration section

Parameters:

typeString - The name of the generator type

section - The section to read from

settings - The settings to log errors against

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

Returns:

The built VectorGenerator

getNewValue

protected abstract org.bukkit.util.Vector getNewValue()

writeToConfig

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

Save this generator in a config that can be read by its constructor

Specified by:

writeToConfig in interface Provider

Parameters:

section - The section to write to

path - The field/path inside the given section

refresh

public final void refresh()

Generate a new value

Specified by:

refresh in interface Refreshable

refreshInternal

protected void refreshInternal()

getValue

public org.bukkit.util.Vector getValue()

Returns:

A clone of the most recently generated value

clone

public abstract VectorGenerator clone()

Overrides:

clone in class Object