byucc.jhdl.base
Class Parameter

java.lang.Object
  byucc.jhdl.base.Parameter

All Implemented Interfaces:

CellInterface

public class Parameter

extends java.lang.Object

implements CellInterface

This class allows the creation of arbitrarily typed parameters as part of a CellInterface. It can be constructed via Cell.param(). Note that if a parameter is referenced in calculating the width of a port, the parameter must be of type Integer.

Method Summary

java.lang.Object	getArgument() Used to retrieve the bound argument.
java.lang.String	getName() Returns the name of the parameter
java.lang.Class	getType() Returns the declared type of the parameter (which may be a superclass or superinterface of the actual argument).
boolean	isBound() Used to determine whether a binding is valid.
java.lang.String	toString() Returns a formatted String describing the parameter.

Methods inherited from class java.lang.Object

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

Method Detail

getName

public final java.lang.String getName()

Returns the name of the parameter

Specified by:

getName in interface CellInterface

Returns:

the name

getType

public final java.lang.Class getType()

Returns the declared type of the parameter (which may be a superclass or superinterface of the actual argument).

Returns:

the declared type of the parameter

toString

public java.lang.String toString()

Returns a formatted String describing the parameter.

Returns:

a String describing the parameter

getArgument

public final java.lang.Object getArgument()

Used to retrieve the bound argument.

Returns:

the argument (may be null).

isBound

public final boolean isBound()

Used to determine whether a binding is valid.

Returns:

true if the binding has been bound.