Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle TopLink
11g Release 1 (11.1.1)

E28847-01


org.eclipse.persistence.platform.database.oracle.publisher.sqlrefl
Class ProcedureMethod

java.lang.Object
  extended by org.eclipse.persistence.platform.database.oracle.publisher.sqlrefl.ProcedureMethod

All Implemented Interfaces:
java.lang.Comparable<ProcedureMethod>
Direct Known Subclasses:
PlsqlMethod, SqlStmtMethod

public class ProcedureMethod
extends java.lang.Object
implements java.lang.Comparable<ProcedureMethod>

A Method provides information about a single method of a type.


Field Summary
static int ALL
           
static int IN
           
static int INOUT
           
protected  boolean m_hasDefault
           
protected  boolean m_keepMethodName
           
protected  int m_modifiers
           
protected  java.lang.String m_name
           
protected  java.lang.String m_overloadNumber
           
protected  boolean[] m_paramDefaults
           
protected  int[] m_paramModes
           
protected  java.lang.String[] m_paramNames
           
protected  TypeClass[] m_paramTypes
           
protected  TypeClass m_returnType
           
static int OUT
           
static int RETURN
           

 

Constructor Summary
ProcedureMethod(java.lang.String name, int modifiers)
          Construct a Method
ProcedureMethod(java.lang.String name, java.lang.String overloadNumber, int modifiers, TypeClass returnType, TypeClass[] parameterTypes, java.lang.String[] parameterNames, int[] parameterModes, boolean[] parameterDefaults, int paramLen)
          Construct a Method

 

Method Summary
 void accept(PublisherVisitor v)
           
 int compareTo(ProcedureMethod other)
           
 int getModifiers()
          Returns the source language modifiers for the member or constructor represented by this Member, as an integer.
 java.lang.String getName()
          Returns the simple name of the underlying member or constructor represented by this JSMember.
 boolean[] getParamDefaults()
           
 int[] getParamModes()
          Returns an array of ints that represent the parameter modes, in declaration order, of the method represented by this Method object.
 java.lang.String[] getParamNames()
          Returns an array of String objects that represent the formal parameter names, in declaration order, of the method represented by this Method object.
 TypeClass[] getParamTypes()
          Returns an array of Type objects that represent the formal parameter types, in declaration order, of the method represented by this Method object.
 TypeClass getReturnType()
          Returns a Type object that represents the formal return type of the method represented by this Method object.
protected  java.lang.String getSortingKey()
           
 java.lang.String getSqlStatement()
           
 boolean hasDefault()
           
 boolean keepMethodName()
           
 void setKeepMethodName(boolean keep)
           
 java.lang.String toString()
           

 

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

 

Field Detail

IN

public static final int IN
See Also:
Constant Field Values

OUT

public static final int OUT
See Also:
Constant Field Values

INOUT

public static final int INOUT
See Also:
Constant Field Values

RETURN

public static final int RETURN
See Also:
Constant Field Values

ALL

public static final int ALL
See Also:
Constant Field Values

m_name

protected java.lang.String m_name

m_modifiers

protected int m_modifiers

m_returnType

protected TypeClass m_returnType

m_paramTypes

protected TypeClass[] m_paramTypes

m_paramNames

protected java.lang.String[] m_paramNames

m_paramModes

protected int[] m_paramModes

m_paramDefaults

protected boolean[] m_paramDefaults

m_hasDefault

protected boolean m_hasDefault

m_keepMethodName

protected boolean m_keepMethodName

m_overloadNumber

protected java.lang.String m_overloadNumber

Constructor Detail

ProcedureMethod

public ProcedureMethod(java.lang.String name,
                       int modifiers)
Construct a Method

ProcedureMethod

public ProcedureMethod(java.lang.String name,
                       java.lang.String overloadNumber,
                       int modifiers,
                       TypeClass returnType,
                       TypeClass[] parameterTypes,
                       java.lang.String[] parameterNames,
                       int[] parameterModes,
                       boolean[] parameterDefaults,
                       int paramLen)
Construct a Method

Method Detail

getName

public java.lang.String getName()
Returns the simple name of the underlying member or constructor represented by this JSMember.

getModifiers

public int getModifiers()
Returns the source language modifiers for the member or constructor represented by this Member, as an integer. The Modifier class should be used to decode the modifiers in the integer.

getReturnType

public TypeClass getReturnType()
Returns a Type object that represents the formal return type of the method represented by this Method object. If the method does not return anything, getReturnType() may return null or a representation of the void type.

getParamNames

public java.lang.String[] getParamNames()
Returns an array of String objects that represent the formal parameter names, in declaration order, of the method represented by this Method object. Returns an array of length 0 if the underlying method takes no parameters. Returns null if the parameter names are not known.

getParamTypes

public TypeClass[] getParamTypes()
Returns an array of Type objects that represent the formal parameter types, in declaration order, of the method represented by this Method object. Returns an array of length 0 if the underlying method takes no parameters.

getParamModes

public int[] getParamModes()
Returns an array of ints that represent the parameter modes, in declaration order, of the method represented by this Method object. Returns an array of length 0 if the underlying method takes no parameters. Possible modes are: IN, OUT, INOUT.

getParamDefaults

public boolean[] getParamDefaults()

hasDefault

public boolean hasDefault()

getSqlStatement

public java.lang.String getSqlStatement()

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

keepMethodName

public boolean keepMethodName()

setKeepMethodName

public void setKeepMethodName(boolean keep)

accept

public void accept(PublisherVisitor v)

getSortingKey

protected java.lang.String getSortingKey()

compareTo

public int compareTo(ProcedureMethod other)
Specified by:
compareTo in interface java.lang.Comparable<ProcedureMethod>

Skip navigation links

Copyright © 1998, 2012, Oracle. All Rights Reserved.