Package games.stendhal.server.entity.mapstuff.portal

Class KeyedPortalFactory

java.lang.Object

games.stendhal.server.entity.mapstuff.portal.KeyedPortalFactory

All Implemented Interfaces:

ConfigurableFactory

public class KeyedPortalFactory
extends Object

A factory for KeyedPortal objects.

Constructor Summary

Constructors

Constructor	Description
KeyedPortalFactory()

Method Summary

Modifier and Type	Method	Description
Object	create(ConfigurableFactoryContext ctx)	Create a keyed portal.
protected AccessCheckingPortal	createPortal(ConfigurableFactoryContext ctx)	Create a keyed portal.
protected int	getIntValue(ConfigurableFactoryContext ctx, String key)	Extract integer value from a context.
protected String	getKey(ConfigurableFactoryContext ctx)	Extract the portal key from a context.
protected int	getQuantity(ConfigurableFactoryContext ctx)	Extract the portal key quantity from a context.
protected ChatAction	getRejectedAction(ConfigurableFactoryContext ctx)	Creates a new ChatAction from ConfigurableFactoryContext.
protected String	getStringValue(ConfigurableFactoryContext ctx, String key)	Extract string value from a context.

Methods inherited from class java.lang.Object

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

Constructor Details

KeyedPortalFactory

public KeyedPortalFactory()

Method Details

getKey

protected String getKey(ConfigurableFactoryContext ctx)

Extract the portal key from a context.

Parameters:

ctx - The configuration context.

Returns:

The key name.

Throws:

IllegalArgumentException - If the class attribute is missing.

getQuantity

protected int getQuantity(ConfigurableFactoryContext ctx)

Extract the portal key quantity from a context.

Parameters:

ctx - The configuration context.

Returns:

The required key quantity.

Throws:

IllegalArgumentException - If the class attribute is missing.

createPortal

protected AccessCheckingPortal createPortal(ConfigurableFactoryContext ctx)

Create a keyed portal.

Parameters:

ctx - The configuration context.

Returns:

The portal.

Throws:

IllegalArgumentException - If the class attribute is missing.

create

public Object create(ConfigurableFactoryContext ctx)

Create a keyed portal.

Specified by:

create in interface ConfigurableFactory

Parameters:

ctx - Configuration context.

Returns:

A KeyedPortal.

Throws:

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

See Also:

• KeyedPortal

getStringValue

protected String getStringValue(ConfigurableFactoryContext ctx,
 String key)

Extract string value from a context.

Parameters:

ctx - The configuration context.

key - The key to search for.

Returns:

The string value of the key, or null if none.

Throws:

IllegalArgumentException - If the class attribute is missing.

getIntValue

protected int getIntValue(ConfigurableFactoryContext ctx,
 String key)

Extract integer value from a context.

Parameters:

ctx - The configuration context.

key - The key to search for.

Returns:

The integer value of the key, or null if none.

Throws:

IllegalArgumentException - If the class attribute is missing.

getRejectedAction

protected ChatAction getRejectedAction(ConfigurableFactoryContext ctx)

Creates a new ChatAction from ConfigurableFactoryContext.

Parameters:

ctx - ConfigurableFactoryContext

Returns:

ChatAction instance