org.objectweb.kilim.description
Class Arity

java.lang.Object
  org.objectweb.kilim.description.Arity

public final class Arity

extends java.lang.Object

Author:

horn Describes a Port's arity. Three values are presently defined : OPTIONAL : which means that a port can be unbound or bound to one element. REQUIRED : which means that a port must be bound to one and only one element. COLLECTION : which means that a port can be unbound or be bound to an arbitrary number of elements.

See Also:

Port

Field Summary

static Arity	COLLECTION the singleton representing a multiple port binding
private java.lang.String	description
static Arity	OPTIONAL the singleton representing an optional port
static Arity	REQUIRED the singleton representing a required port

Constructor Summary

private

Arity(java.lang.String aDescription) The private constructor for arities.

Method Summary

java.lang.String

getDescription() Returns a simple description of the arity.

Methods inherited from class java.lang.Object

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

Field Detail

OPTIONAL

public static final Arity OPTIONAL

the singleton representing an optional port

REQUIRED

public static final Arity REQUIRED

the singleton representing a required port

COLLECTION

public static final Arity COLLECTION

the singleton representing a multiple port binding

description

private java.lang.String description

Constructor Detail

Arity

private Arity(java.lang.String aDescription)

The private constructor for arities.

Parameters:

aDescription - : a description which must be either "?" for optional, "1" for required, "*" for collections.

Method Detail

getDescription

public java.lang.String getDescription()

Returns a simple description of the arity. This description is either "?" (for OPTIONAL), "1" (for REQUIRED) or "*" (for COLLECTION) on the arity.

Returns:

String