public class MethodDescriptor
extends java.lang.Object
implements java.io.Serializable
Modifier and Type | Field and Description |
---|---|
static int |
IMPACT_ACTION
This impact value indicates that the method takes some action that can potentially
change the state of the managed object.
|
static int |
IMPACT_ACTION_INFO
This impact value indicates that the method takes some action that can potentially
change the state of the managed object and also returns some information as a return value.
|
static int |
IMPACT_INFO
This impact value indicates that the method simply retrieves some information
in a manner that does not change the state of the managed object.
|
Constructor and Description |
---|
MethodDescriptor(java.lang.String name,
java.lang.String desc,
DataDescriptor ret,
DataDescriptor[] args,
boolean async,
int impact,
int maxTime)
Constructs a method descriptor.
|
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object obj)
Compares this object against the specified object.
|
DataDescriptor[] |
getArgumentDescriptors()
Returns a DataDescriptor array describing the method's arguments or
null if this method accepts no arguments.
|
java.lang.String |
getDescription()
Returns a description of this method
|
int |
getImpact()
Returns the impact of this method.
|
int |
getMaxResponseTime()
Returns the maximum response time for this method.
|
java.lang.String |
getName()
Returns the name of this method
|
DataDescriptor |
getReturnDescriptor()
Returns the DataDescriptor describing the method's return value or null if the method returns no value.
|
boolean |
isAsync()
Returns true if the method is asynchronous.
|
boolean |
isOpenMethod()
Returns true if this descriptor describes an open method.
|
java.lang.String |
toFormattedString(java.lang.String indent)
Returns a formatted string representation of this descriptor.
|
java.lang.String |
toString()
Returns a string representation of this descriptor.
|
public static final int IMPACT_INFO
public static final int IMPACT_ACTION
public static final int IMPACT_ACTION_INFO
public MethodDescriptor(java.lang.String name, java.lang.String desc, DataDescriptor ret, DataDescriptor[] args, boolean async, int impact, int maxTime)
name
- The name of the method. Must be a non-null, non-empty string.desc
- A description of the methodret
- A DataDescriptor describing the return value of the method.
It may be null to indicate that this method has no return value.args
- An array of DataDescriptor objects describing the arguments required
by the method.
It may be null or empty array to indicat that this method has no arguments.
If not empty, the array must not contain null elements.
Each DataDescriptor in this array must have a unique name.async
- Indicates whether or not this method is an asynchronous method. An asynchronous
method is analogous to an event source. Listeners that subscribe to
an asynchronous method will receive the method's declared return value each
time an particular event occurs. A method may not be declared as asynchronous
unless it also describes a return value (see ret
parameter).impact
- States the impact this method will have. Must be one of
IMPACT_ACTION,
IMPACT_INFO, or
IMPACT_ACTION_INFO.
A method that does not return a value (see ret
parameter) may not be declared
to have an impact of IMPACT_INFO or IMPACT_ACTION_INFO
.maxTime
- The maximum response time for this method, in seconds.
Must be greater than zero. This is the amount of time
that must elapse between the method's invocation and its return before declaring
it to have timed out. If the method is being invoked remotely, the round-trip time
of the intervening transport mechanism should also be taken into account
before declaring a timeout.java.lang.IllegalArgumentException
- If the parameter conditions are violated.public java.lang.String getName()
public java.lang.String getDescription()
public DataDescriptor getReturnDescriptor()
public DataDescriptor[] getArgumentDescriptors()
public boolean isAsync()
An asynchronous method is analogous to an event source. Listeners that subscribe to an asynchronous method will receive the method's declared return value each time a particular event occurs.
public int getImpact()
public int getMaxResponseTime()
public boolean isOpenMethod()
An open method is one whose argument and return types are limited to the set of open data types defined by the OpenData interface.
Because an open method uses a well known set of types, it can be used in an open manner by any application using this api.
A non-open method is a proprietary method from the perspective of the TIB/Hawk Console API because it uses data types outside of this set.
Use of non-open methods is supported by this api. However, this api by itself is not sufficient to use such methods. An additonal proprietary api is required.
public boolean equals(java.lang.Object obj)
Two MethodDescriptor objects are equal if they have the same name, description, return descriptors, argument descriptors (specified in the same order), and the same async and impact values.
equals
in class java.lang.Object
public java.lang.String toString()
toString
in class java.lang.Object
public java.lang.String toFormattedString(java.lang.String indent)
Copyright © 2000-2019 TIBCO Inc. All Rights Reserved.