Package games.stendhal.server.entity.mapstuff.area

Class CreatureProtectionAreaFactory

java.lang.Object

games.stendhal.server.entity.mapstuff.area.CreatureProtectionAreaFactory

All Implemented Interfaces:

ConfigurableFactory

public class CreatureProtectionAreaFactory
extends Object
implements ConfigurableFactory

A base factory for CreatureProtectionArea objects.

Constructor Summary

Constructors

Constructor	Description
CreatureProtectionAreaFactory()

Method Summary

Modifier and Type	Method	Description
Object	create(ConfigurableFactoryContext ctx)	Create a damaging area.
protected void	defineCreatures(CreatureProtectionArea area, ConfigurableFactoryContext ctx)	Configure an area's criteria rules.
protected boolean	getBlockedDefault(ConfigurableFactoryContext ctx)	Extract the default action from a context.
protected int	getHeight(ConfigurableFactoryContext ctx)	Extract the area height from a context.
protected int	getWidth(ConfigurableFactoryContext ctx)	Extract the area width from a context.

Methods inherited from class java.lang.Object

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

Constructor Details

CreatureProtectionAreaFactory

public CreatureProtectionAreaFactory()

Method Details

defineCreatures

protected void defineCreatures(CreatureProtectionArea area,
 ConfigurableFactoryContext ctx)

Configure an area's criteria rules.

Parameters:

area - The area to configure.

ctx - The configuration context.

Throws:

IllegalArgumentException - If the attribute is invalid.

getBlockedDefault

protected boolean getBlockedDefault(ConfigurableFactoryContext ctx)

Extract the default action from a context.

Parameters:

ctx - The configuration context.

Returns:

The default action.

Throws:

IllegalArgumentException - If the attribute is other than "block" or "allow".

getHeight

protected int getHeight(ConfigurableFactoryContext ctx)

Extract the area height from a context.

Parameters:

ctx - The configuration context.

Returns:

The height.

Throws:

IllegalArgumentException - If the attribute is invalid.

getWidth

protected int getWidth(ConfigurableFactoryContext ctx)

Extract the area width from a context.

Parameters:

ctx - The configuration context.

Returns:

The width.

Throws:

IllegalArgumentException - If the attribute is invalid.

create

public Object create(ConfigurableFactoryContext ctx)

Create a damaging area.

Specified by:

create in interface ConfigurableFactory

Parameters:

ctx - Configuration context.

Returns:

A CreatureProtectionArea.

Throws:

IllegalArgumentException - If there is a problem with the attributes. The exception message should be a value suitable for meaningful user interpretation.

See Also:

CreatureProtectionArea