com.vmware.vapi.core

Class MethodDefinition

java.lang.Object

com.vmware.vapi.core.MethodDefinition

public class MethodDefinition
extends Object

The MethodDefinition class contains detailed information about a vAPI method. This should contain all the information required to address a method in the vAPI runtime.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MethodDefinition.TaskSupport Levels of task support by the method

Constructor Summary

Constructors

Constructor and Description
MethodDefinition(MethodIdentifier id, DataDefinition input, DataDefinition output, Set<ErrorDefinition> errors) Constructor.
MethodDefinition(MethodIdentifier id, DataDefinition input, DataDefinition output, Set<ErrorDefinition> errors, MethodDefinition.TaskSupport taskSupport) Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
ErrorDefinition	getErrorDefinition(String errorName) Returns the error definition with the specified name reported by this method or null if this method doesn't report an error with the specified name.
Set<ErrorDefinition>	getErrorDefinitions() Returns a set of error definitions describing the errors which this method can report.
MethodIdentifier	getIdentifier() Returns the identifier of this method.
DataDefinition	getInputDefinition() Returns the input definition of this method.
DataDefinition	getOutputDefinition() Returns the output definition of this method.
MethodDefinition.TaskSupport	getTaskSupport() Returns task support level of the method.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

MethodDefinition

public MethodDefinition(MethodIdentifier id,
                        DataDefinition input,
                        DataDefinition output,
                        Set<ErrorDefinition> errors)

Constructor.

Parameters:

id - method identifier

input - data definition of the method input

output - data definition of the method output

errors - set of ErrorDefinitions for errors that can be reported by the method; might be null

MethodDefinition

public MethodDefinition(MethodIdentifier id,
                        DataDefinition input,
                        DataDefinition output,
                        Set<ErrorDefinition> errors,
                        MethodDefinition.TaskSupport taskSupport)

Constructor.

Parameters:

id - method identifier

input - data definition of the method input

output - data definition of the method output

errors - set of ErrorDefinitions for errors that can be reported by the method; might be null

taskSupport - Task support level of the method

Method Detail

getIdentifier

public MethodIdentifier getIdentifier()

Returns the identifier of this method.

Returns:

method identifier of this method

getInputDefinition

public DataDefinition getInputDefinition()

Returns the input definition of this method.

Returns:

data definition of the input of this method

getOutputDefinition

public DataDefinition getOutputDefinition()

Returns the output definition of this method.

Returns:

data definition of the output of this method

getErrorDefinitions

public Set<ErrorDefinition> getErrorDefinitions()

Returns a set of error definitions describing the errors which this method can report.

Returns:

set of ErrorDefinitions for the method

getErrorDefinition

public ErrorDefinition getErrorDefinition(String errorName)

Returns the error definition with the specified name reported by this method or null if this method doesn't report an error with the specified name.

Parameters:

errorName - name of the error definition to return

Returns:

error definition with the specified name reported by this method or null if this method doesn't report an error with the specified name.

Throws:

NullPointerException - if the error name is null

getTaskSupport

public MethodDefinition.TaskSupport getTaskSupport()

Returns task support level of the method.

Returns:

TaskSupport enum to indicate the task support level of the method

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object