com.bea.wlpi.common
Class FunctionInfo

java.lang.Object
  |
  +--com.bea.wlpi.common.FunctionInfo

public final class FunctionInfo

extends java.lang.Object

implements java.io.Serializable, java.lang.Comparable

Holds information about a workflow function.

Objects of this class override the boolean equals(Object) and implement the comparable interface. Homogeneous collections containing objects of this class may, therefore, be searched and sorted using the Collection.contains(Object), List.indexOf(Object), Collections.sort(List) methods.

See Also:

Serialized Form

Constructor Summary

FunctionInfo(java.lang.String name, java.lang.String prototype)
Create a new FunctionInfo object.

Method Summary

int	compareTo(java.lang.Object o) Compare two FunctionInfo objects.
boolean	equals(java.lang.Object obj) Test two FunctionInfo objects for equality.
java.lang.String	getName() Return the function name.
java.lang.String	getPrototype() Return the function prototype.

Methods inherited from class java.lang.Object

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

Constructor Detail

FunctionInfo

public FunctionInfo(java.lang.String name,
                    java.lang.String prototype)

Create a new FunctionInfo object.

Parameters:

name - The function name.

prototype - The function prototype in pseudo-Bachus-Naur form.

Method Detail

getName

public final java.lang.String getName()

Return the function name.

Returns:

The function name.

getPrototype

public final java.lang.String getPrototype()

Return the function prototype.

Returns:

The function prototype in pseudo-Bachus-Naur form.

equals

public boolean equals(java.lang.Object obj)

Test two FunctionInfo objects for equality.

Overrides:

equals in class java.lang.Object

Parameters:

obj - Object with which to compare this one.

Returns:

true if obj is an instance of FunctionInfo with the same name as this one.

See Also:

compareTo(java.lang.Object)

compareTo

public int compareTo(java.lang.Object o)

Compare two FunctionInfo objects.

Specified by:

compareTo in interface java.lang.Comparable

Parameters:

obj - Object with which to compare this one. Must be null or an instance of FunctionInfo.

Returns:

The result of comparing the name members using the String.compareTo(Object) method.

Throws:

java.lang.ClassCastException - if o is not an instance of FunctionInfo.

See Also:

equals(java.lang.Object)