org.pepsoft.worldpainter.layers.bo2

Class Bo2ObjectTube

java.lang.Object

org.pepsoft.worldpainter.layers.bo2.Bo2ObjectTube

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, Bo2ObjectProvider

public final class Bo2ObjectTube
extends java.lang.Object
implements Bo2ObjectProvider

A custom object provider which maintains a collection of objects which it returns randomly (weighted according to their WPObject.ATTRIBUTE_FREQUENCY attributes).

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Bo2ObjectTube(java.lang.String name, java.util.List<WPObject> objects)

Method Summary

Modifier and Type	Method and Description
Bo2ObjectTube	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.
static Bo2ObjectTube	load(java.io.File dir) Create a new Bo2ObjectTube containing all supported custom objects from a specific directory.
static Bo2ObjectTube	load(java.lang.String name, java.util.Collection<java.io.File> files) Create a new Bo2ObjectTube with a specific name from a list of specific custom object files.
static Bo2ObjectTube	load(java.lang.String name, java.io.File dir) Create a new Bo2ObjectTube with a specific name, containing all supported custom objects from a specific directory.
void	setSeed(long seed) Sets the seed of the PRNG, for object providers which use one.

Methods inherited from class java.lang.Object

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

Constructor Detail

Bo2ObjectTube

public Bo2ObjectTube(java.lang.String name,
                     java.util.List<WPObject> objects)

Method Detail

getName

public java.lang.String getName()

Description copied from interface: Bo2ObjectProvider

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

Specified by:

getName in interface Bo2ObjectProvider

Returns:

The name of this object provider.

setSeed

public void setSeed(long seed)

Description copied from interface: Bo2ObjectProvider

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

Specified by:

setSeed in interface Bo2ObjectProvider

Parameters:

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

getObject

public WPObject getObject()

Description copied from interface: Bo2ObjectProvider

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

Specified by:

getObject in interface Bo2ObjectProvider

Returns:

One WPObject.

getAllObjects

public java.util.List<WPObject> getAllObjects()

Description copied from interface: Bo2ObjectProvider

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.

Specified by:

getAllObjects in interface Bo2ObjectProvider

Returns:

A list of all objects which this provider can return.

clone

public Bo2ObjectTube clone()

Description copied from interface: Bo2ObjectProvider

Create a deep copy of the object provider.

Specified by:

clone in interface Bo2ObjectProvider

Overrides:

clone in class java.lang.Object

Returns:

A deep copy of the object provider.

load

public static Bo2ObjectTube load(java.io.File dir)
                          throws java.io.IOException

Create a new Bo2ObjectTube containing all supported custom objects from a specific directory. The name of the Bo2ObjectTube will be set to the name of the directory.

Parameters:

dir - The directory containing the objects to load.

Returns:

A new Bo2ObjectTube containing the supported objects from the specified directory.

Throws:

java.io.IOException - If there was an I/O error reading one of the files.

load

public static Bo2ObjectTube load(java.lang.String name,
                                 java.io.File dir)
                          throws java.io.IOException

Create a new Bo2ObjectTube with a specific name, containing all supported custom objects from a specific directory.

Parameters:

name - The name of the new Bo2ObjectTube.

dir - The directory containing the objects to load.

Returns:

A new Bo2ObjectTube containing the supported objects from the specified directory.

Throws:

java.io.IOException - If there was an I/O error reading one of the files.

load

public static Bo2ObjectTube load(java.lang.String name,
                                 java.util.Collection<java.io.File> files)
                          throws java.io.IOException

Create a new Bo2ObjectTube with a specific name from a list of specific custom object files.

Parameters:

name - The name of the new Bo2ObjectTube.

files - The list of files containing the objects to load.

Returns:

A new Bo2ObjectTube containing the custom objects from the specified file(s).

Throws:

java.io.IOException - If there was an I/O error reading one of the files.