|
Reality Interface Classes | ||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||
com.northgateis.reality.rsc
Class RSCDescriptor
java.lang.Object | +--com.northgateis.reality.rsc.RSCDescriptor
- public class RSCDescriptor
- extends java.lang.Object
- implements java.util.Enumeration
- extends java.lang.Object
Builds a Vector containing the parameters of a subroutine, and provides methods to access the parameters either by reference or sequentially.
The methods of this class are normally only called by the RSC class
By default parameter are accessed by an index number (1 to n) where n is the number of parameters that the subroutine takes. Parameters referenced by index do not have to be accessed in order of index.
Optionally parameters can be accessed by name. In order to support this feature the parameter descriptors must have been down loaded from the RSC server by using the getDescriptors() method of the RSC class.
| Field Summary | |
int
|
reference
the reference number for this subroutine on the server |
| Constructor Summary | |
RSCDescriptor(java.lang.String name)Construct a new empty subroutine descriptor | |
RSCDescriptor(java.lang.String name,
int r,
int pc,
java.lang.String fmt)Construct a new subroutine descriptor | |
| Method Summary | |
RSCParam | get(int index)get a parameter descriptor by index |
RSCParam | get(java.lang.String name)get a parameter descriptor by name. |
java.lang.String | getName()return name of this subroutine |
boolean | hasMoreElements()test if there are more parameters available |
java.lang.Object | nextElement()get the next parameter descriptor in sequence. |
| Methods inherited from class java.lang.Object |
equals,
getClass,
hashCode,
notify,
notifyAll,
toString,
wait,
wait,
wait |
| Field Detail |
reference
public int reference
- the reference number for this subroutine on the server
| Constructor Detail |
RSCDescriptor
public RSCDescriptor(java.lang.String name, int r, int pc, java.lang.String fmt)
- Construct a new subroutine descriptor
RSCDescriptor
public RSCDescriptor(java.lang.String name)
- Construct a new empty subroutine descriptor
- Parameters:
name- name of subroutine
| Method Detail |
getName
public java.lang.String getName()
- return name of this subroutine
- Returns:
- the subroutine name
hasMoreElements
public boolean hasMoreElements()
- test if there are more parameters available
- Specified by:
- hasMoreElements in interface java.util.Enumeration
- Returns:
- true if there are more parameters, false otherwise
nextElement
public java.lang.Object nextElement()
- get the next parameter descriptor in sequence.
- Specified by:
- nextElement in interface java.util.Enumeration
get
public RSCParamget(java.lang.String name) throws RSCException
- get a parameter descriptor by name. The parameter descriptor string is
parsed first if it has not already been parsed.
- Parameters:
name- name of parameter- Throws:
- RSCException - no such parameter
get
public RSCParamget(int index) throws RSCException
- get a parameter descriptor by index
- Parameters:
index- index of parameter- Throws:
- RSCException - if index invalid
| Reality Interface Classes | ||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||
Copyright (c) 2000 NEC Software Services (UK) Limited