hla.rti
Interface ParameterHandle

All Superinterfaces:

java.io.Serializable

public interface ParameterHandle

extends java.io.Serializable

Type-safe handle for a parameter. Generally these are created by the run-time infrastructure and passed to the user.

Author:

DMSO

Method Summary

void	encode(byte[] buffer, int offset) Encodes this parameter handle and places the result in the specified buffer.
int	encodedLength() Returns the encoded length of this parameter handle.
boolean	equals(java.lang.Object otherParameterHandle) Checks this parameter handle for equality with another.
int	hashCode() Computes and returns a hash code corresponding to this parameter handle.
java.lang.String	toString() Returns a string representation of this parameter handle.

Method Detail

equals

public boolean equals(java.lang.Object otherParameterHandle)

Checks this parameter handle for equality with another.

Parameters:

otherParameterHandle - the other parameter handle

Returns:

true if the two handles represent the same parameter, false otherwise

hashCode

public int hashCode()

Computes and returns a hash code corresponding to this parameter handle.

Returns:

a hash code corresponding to this parameter handle

encodedLength

public int encodedLength()

Returns the encoded length of this parameter handle.

Returns:

the encoded length of this parameter handle (in bytes)

encode

public void encode(byte[] buffer,
                   int offset)

Encodes this parameter handle and places the result in the specified buffer.

Parameters:

buffer - the buffer to contain the encoded handle

offset - the offset within the buffer at which to store the encoded handle

toString

public java.lang.String toString()

Returns a string representation of this parameter handle.

Returns:

a string representation of this parameter handle