MicroTAPAS
Class CapabilitySet

java.lang.Object
  |
  +--MicroTAPAS.CapabilitySet

All Implemented Interfaces:

java.io.Serializable

public class CapabilitySet

extends java.lang.Object

implements java.io.Serializable

Defines the representation of capability sets, and functionality related to capability sets. Capability sets are properties attached to actors, and they are used as requirements for doing plug in of actors. A capability set may consists of zero or more capabilities, where each capability value is represented as a text string. Capabilitities specifications may be done as a dotted (i.e. ".") separated list of terms, where each term represents a level in the hierarchical specification of the capability. I.e. "printer" define the capability "any printer", while "printer.postscript" specifies the capability "printer with postscript capabilities". The term asterisk (i.e. "*") may be used to specify "any value" for a capability term. I.e. "printer.*" specifies any printer capability. Functionality is defined to assign or change the set of capabilities included into a capability set value, and also functionality to determine whether or not a set of capabilities is included in another specified capability set.

See Also:

Serialized Form

Field Summary

static int	ADD Add specified capabilities to set for those not already existing
static int	REMOVE Remove specified set of capabilities, for those that exists in set
static int	SET Set capability set to value specified

Constructor Summary

CapabilitySet(java.lang.String[] initialSet)
Constructor defines a capability set, with an initial value as specified.

Method Summary

java.lang.String[]	getAll() Determine all capability entries
boolean	includedIn(CapabilitySet caps) Check if specified capability set is included in this one
int	length() Determine the number of category entries included into the set
java.lang.String	toString() Determine a string representation of all capabilities.
static java.lang.String	toString(CapabilitySet obj) Determine a string representation of all capabilities.
void	update(int opType, CapabilitySet caps) Update set of capabilities according to specified set and operation type.
RequestResult	validateRequiredCaps(RequestPars pRP) This method compares the offered capabilities (this set), with the capabilities required by an actor.
java.lang.String	value(int i) Determine the value of a specified category entry in the set

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

SET

public static final int SET

Set capability set to value specified

See Also:

Constant Field Values

ADD

public static final int ADD

Add specified capabilities to set for those not already existing

See Also:

Constant Field Values

REMOVE

public static final int REMOVE

Remove specified set of capabilities, for those that exists in set

See Also:

Constant Field Values

Constructor Detail

CapabilitySet

public CapabilitySet(java.lang.String[] initialSet)

Constructor defines a capability set, with an initial value as specified.

Parameters:

initialSet - The initial set of capabilities

Method Detail

update

public void update(int opType,
                   CapabilitySet caps)

Update set of capabilities according to specified set and operation type.

Parameters:

opType - Operation type

caps - The set of capabilities

length

public int length()

Determine the number of category entries included into the set

Returns:

The number of category entries included in the set

value

public java.lang.String value(int i)

Determine the value of a specified category entry in the set

Parameters:

i - The index to where the category entry is located

Returns:

The category entry at specified index if valid index value, else null is returned

getAll

public java.lang.String[] getAll()

Determine all capability entries

Returns:

A list containing all capability entries if such exists, else null is returned

includedIn

public boolean includedIn(CapabilitySet caps)

Check if specified capability set is included in this one

Parameters:

caps - The set of capabilities that are checked if included

Returns:

true if 'caps' is included in this set, or if specified to 'null' (i.e. not use)

validateRequiredCaps

public RequestResult validateRequiredCaps(RequestPars pRP)
                                   throws java.lang.Exception

This method compares the offered capabilities (this set), with the capabilities required by an actor.

Parameters:

pRP - The request.

Returns:

TAPAS style result

java.lang.Exception

toString

public java.lang.String toString()

Determine a string representation of all capabilities. Starts with [ and ends with ].

Overrides:

toString in class java.lang.Object

Returns:

String representation of all capabilities in set

toString

public static java.lang.String toString(CapabilitySet obj)

Determine a string representation of all capabilities. Starts with [ and ends with ].

Parameters:

obj - CapabilitySet object - if existing

Returns:

String representation of all capabilities in set