Class MethodAliasInfo

java.lang.Object

org.apache.derby.catalog.types.MethodAliasInfo

All Implemented Interfaces:

Externalizable, Serializable, AliasInfo, Formatable, TypedFormat

Direct Known Subclasses:

RoutineAliasInfo

public class MethodAliasInfo
extends Object
implements AliasInfo, Formatable

Describe a method alias.

See Also:

• AliasInfo
• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
private String	methodName	This class implements Formatable.

Fields inherited from interface AliasInfo

ALIAS_NAME_SPACE_AGGREGATE_AS_CHAR, ALIAS_NAME_SPACE_AGGREGATE_AS_STRING, ALIAS_NAME_SPACE_FUNCTION_AS_CHAR, ALIAS_NAME_SPACE_FUNCTION_AS_STRING, ALIAS_NAME_SPACE_PROCEDURE_AS_CHAR, ALIAS_NAME_SPACE_PROCEDURE_AS_STRING, ALIAS_NAME_SPACE_SYNONYM_AS_CHAR, ALIAS_NAME_SPACE_SYNONYM_AS_STRING, ALIAS_NAME_SPACE_UDT_AS_CHAR, ALIAS_NAME_SPACE_UDT_AS_STRING, ALIAS_TYPE_AGGREGATE_AS_CHAR, ALIAS_TYPE_AGGREGATE_AS_STRING, ALIAS_TYPE_FUNCTION_AS_CHAR, ALIAS_TYPE_FUNCTION_AS_STRING, ALIAS_TYPE_PROCEDURE_AS_CHAR, ALIAS_TYPE_PROCEDURE_AS_STRING, ALIAS_TYPE_SYNONYM_AS_CHAR, ALIAS_TYPE_SYNONYM_AS_STRING, ALIAS_TYPE_UDT_AS_CHAR, ALIAS_TYPE_UDT_AS_STRING

Constructor Summary

Constructors

Constructor	Description
MethodAliasInfo()	Public niladic constructor.
MethodAliasInfo(String methodName)	Create a MethodAliasInfo

Method Summary

Modifier and Type	Method	Description
String	getMethodName()	Get the name of the static method that the alias represents at the source database.
int	getTypeFormatId()	Get the formatID which corresponds to this class.
boolean	isTableFunction()	Return true if this alias is a Table Function.
void	readExternal(ObjectInput in)	Read this object from a stream of stored objects.
String	toString()
void	writeExternal(ObjectOutput out)	Write this object to a stream of stored objects.

Methods inherited from class Object

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

Field Details

methodName

private String methodName

This class implements Formatable. That means that it can write itself to and from a formatted stream. If you add more fields to this class, make sure that you also write/read them with the writeExternal()/readExternal() methods. If, inbetween releases, you add more fields to this class, then you should bump the version number emitted by the getTypeFormatId() method.

Constructor Details

MethodAliasInfo

public MethodAliasInfo()

Public niladic constructor. Needed for Formatable interface to work.

MethodAliasInfo

public MethodAliasInfo(String methodName)

Create a MethodAliasInfo

Parameters:

methodName - The name of the method for the alias.

Method Details

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
ClassNotFoundException

Read this object from a stream of stored objects.

Specified by:

readExternal in interface Externalizable

Parameters:

in - read this.

Throws:

IOException - thrown on error

ClassNotFoundException - thrown on error

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Write this object to a stream of stored objects.

Specified by:

writeExternal in interface Externalizable

Parameters:

out - write bytes here.

Throws:

IOException - thrown on error

getTypeFormatId

public int getTypeFormatId()

Get the formatID which corresponds to this class.

Specified by:

getTypeFormatId in interface TypedFormat

Returns:

the formatID of this class

getMethodName

public String getMethodName()

Description copied from interface: AliasInfo

Get the name of the static method that the alias represents at the source database. (Only meaningful for method aliases )

Specified by:

getMethodName in interface AliasInfo

Returns:

The name of the static method that the alias represents at the source database.

See Also:

• AliasInfo.getMethodName()

isTableFunction

public boolean isTableFunction()

Description copied from interface: AliasInfo

Return true if this alias is a Table Function.

Specified by:

isTableFunction in interface AliasInfo

toString

public String toString()

Overrides:

toString in class Object

See Also:

• Object.toString()