org.pepsoft.worldpainter.layers.bo2

Interface Bo2ObjectProvider

All Superinterfaces:

java.lang.Cloneable, java.io.Serializable

All Known Implementing Classes:

Bo2Object, Bo2ObjectTube, Bo3Object, Schematic, Structure

public interface Bo2ObjectProvider
extends java.io.Serializable, java.lang.Cloneable

A provider of one or more WPObject(s).

Method Summary

Modifier and Type	Method and Description
Bo2ObjectProvider	clone() Create a deep copy of the object provider.
java.util.List<WPObject>	getAllObjects() Obtain a list of all different WPObjects which this object provider can return.
java.lang.String	getName() Get the name of this object provider (if it represents one object this may be the name of the object).
WPObject	getObject() Obtain one WPObject, which may be the same one every time, or a different one from a random collection or sequence every time.
void	setSeed(long seed) Sets the seed of the PRNG, for object providers which use one.

Method Detail

getName

java.lang.String getName()

Get the name of this object provider (if it represents one object this may be the name of the object).

Returns:

The name of this object provider.

getObject

WPObject getObject()

Obtain one WPObject, which may be the same one every time, or a different one from a random collection or sequence every time.

Returns:

One WPObject.

getAllObjects

java.util.List<WPObject> getAllObjects()

Obtain a list of all different WPObjects which this object provider can return. This is an optional operation which may throw an UnsupportedOperationException if this object provider does not support it.

Returns:

A list of all objects which this provider can return.

Throws:

java.lang.UnsupportedOperationException - If this object provider does not support this operation (for example if the objects are dynamically generated).

setSeed

void setSeed(long seed)

Sets the seed of the PRNG, for object providers which use one. Does nothing for other object providers.

Parameters:

seed - The seed to set on the PRNG, if any.

clone

Bo2ObjectProvider clone()

Create a deep copy of the object provider.

Returns:

A deep copy of the object provider.