Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## xjavadoc
Class ConstructorImpl

    java.lang.Object
      xjavadoc.AbstractProgramElement
          xjavadoc.MemberImpl
              xjavadoc.AbstractExecutableMember
                  xjavadoc.ConstructorImpl

All Implemented Interfaces:
  Comparable, Named, XConstructor, XExecutableMember, XMember, XProgramElement

final class ConstructorImpl
extends AbstractExecutableMember
implements XConstructor

Describe what this class does

Author:
  Aslak Hellesøy

Field Summary
`static int` | `instanceCount`

Fields inherited from class xjavadoc.AbstractProgramElement
`EMPTY_LIST`

Constructor Summary
`ConstructorImpl(AbstractClass containingClass, XTagFactory tagFactory)`

Method Summary
`void` | `addParameterData(String type, String name, int dimension)` Adds a parameter
`void` | `addThrownException(String thrownException)`
`protected String` | `buildStringId()`
`boolean` | `equals(Object o)`
`List` | `getAllSuperElements()`
`String` | `getName()` Get name
`String` | `getNameWithSignature(boolean withParam)` Gets the name and signature
`(package private) int` | `getParameterDimension(int index)`
`(package private) String` | `getParameterName(int index)`
`List` | `getParameters()` Returns the method parameters.
`(package private) String` | `getParameterType(int index)`
`String` | `getParameterTypes()` Returns the parameters as a comma separated list of classes.
`String` | `getSignature(boolean withParam)` Gets the signature
`XProgramElement` | `getSuperElement()`
`XProgramElement` | `getSuperElement(boolean forMethod)`
`List` | `getSuperInterfaceElements()`
`List` | `getThrownExceptions()` Returns the thrown exception classes.
`int` | `hashCode()`
`boolean` | `isConstructor()` Return true if this is a constructor.
`boolean` | `isNative()` Gets the Native attribute of the AbstractExecutableMember object
`boolean` | `isSynchronized()` Gets the Synchronized attribute of the AbstractExecutableMember object
`void` | `setName(String name)`
`boolean` | `throwsException(String exception_class_name)` Return true if the member throws the specified exception in its throws block.
`String` | `toString()`

Methods inherited from class xjavadoc.AbstractProgramElement
`addModifier, compareTo, getContainingAbstractClass, getContainingClass, getContainingPackage, getDoc, getModifiers, getModifierSpecifier, getTagFactory, getXJavaDoc, isAbstract, isFinal, isPackagePrivate, isPrivate, isProtected, isPublic, isStatic, reset, setToken, updateDoc`

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

Methods inherited from interface xjavadoc.XExecutableMember
`getNameWithSignature, getParameters, getParameterTypes, getSignature, getThrownExceptions, isNative, isSynchronized, throwsException`

Methods inherited from interface xjavadoc.XProgramElement
`getContainingClass, getContainingPackage, getDoc, getModifiers, getModifierSpecifier, getSuperInterfaceElements, getXJavaDoc, isAbstract, isFinal, isPackagePrivate, isPrivate, isProtected, isPublic, isStatic, updateDoc`

Methods inherited from interface java.lang.Comparable
`compareTo`

Field Detail

### instanceCount

    public static int instanceCount

Constructor Detail

### ConstructorImpl

    public ConstructorImpl(AbstractClass containingClass,
                           XTagFactory tagFactory)

Method Detail

### isConstructor

    public final boolean isConstructor()

  Description copied from interface: `XExecutableMember`
  Return true if this is a constructor.

  Specified by:
    `isConstructor` in interface `XExecutableMember`
  Returns:
    true if this is a constructor.

### getSuperElement

    public XProgramElement getSuperElement()

  Specified by:
    `getSuperElement` in interface `XProgramElement`

### getAllSuperElements

    public List getAllSuperElements()

### getName

    public String getName()

  Description copied from interface: `Named`
  Get name

  Specified by:
    `getName` in interface `Named`
  Overrides:
    `getName` in class `MemberImpl`

### setName

    public final void setName(String name)

  Overrides:
    `setName` in class `MemberImpl`

### buildStringId

    protected String buildStringId()

  Specified by:
    `buildStringId` in class `AbstractExecutableMember`

### isNative

    public final boolean isNative()

  Gets the Native attribute of the AbstractExecutableMember object

  Specified by:
    `isNative` in interface `XExecutableMember`
  Returns:
    The Native value

### isSynchronized

    public final boolean isSynchronized()

  Gets the Synchronized attribute of the AbstractExecutableMember object

  Specified by:
    `isSynchronized` in interface `XExecutableMember`
  Returns:
    The Synchronized value

### getParameters

    public final List getParameters()

  Returns the method parameters.

  Specified by:
    `getParameters` in interface `XExecutableMember`
  Returns:
    the method parameters

### getSignature

    public final String getSignature(boolean withParam)

  Gets the signature

  Specified by:
    `getSignature` in interface `XExecutableMember`
  Parameters:
    `withParam` - if true, include the parameters in the signature. Otherwise, only the types will be used.
  Returns:
    the signature

### getNameWithSignature

    public final String getNameWithSignature(boolean withParam)

  Gets the name and signature

  Specified by:
    `getNameWithSignature` in interface `XExecutableMember`
  Parameters:
    `withParam` - if true, include the parameters in the signature. Otherwise, only the types will be used.
  Returns:
    the name and signature

### getParameterTypes

    public String getParameterTypes()

  Description copied from interface: `XExecutableMember`
  Returns the parameters as a comma separated list of classes. E.g. a method with signature `(java.lang.String,int)` would return `java.lang.String.class, java.lang.Integer.TYPE`.

  Specified by:
    `getParameterTypes` in interface `XExecutableMember`
  Returns:
    comma separated list of types for all parameters.

### getThrownExceptions

    public List getThrownExceptions()

  Description copied from interface: `XExecutableMember`
  Returns the thrown exception classes.

  Specified by:
    `getThrownExceptions` in interface `XExecutableMember`
  Returns:
    a Collection of `XClass`.

### getSuperElement

    public XProgramElement getSuperElement(boolean forMethod)

### throwsException

    public boolean throwsException(String exception_class_name)

  Description copied from interface: `XExecutableMember`
  Return true if the member throws the specified exception in its throws block.

  Specified by:
    `throwsException` in interface `XExecutableMember`
  Parameters:
    `exception_class_name` -
  Returns:
    true if the member throws the exception

### addParameterData

    public void addParameterData(String type,
                                 String name,
                                 int dimension)

  Adds a parameter

  Parameters:
    `type` - qualified nyme of parameter type
    `name` - parameter name
    `dimension` - parameter dimension

### addThrownException

    public void addThrownException(String thrownException)

### equals

    public boolean equals(Object o)

### hashCode

    public int hashCode()

### toString

    public String toString()

### getParameterType

    final String getParameterType(int index)

### getParameterName

    final String getParameterName(int index)

### getParameterDimension

    final int getParameterDimension(int index)

### getSuperInterfaceElements

    public List getSuperInterfaceElements()

  Specified by:
    `getSuperInterfaceElements` in interface `XProgramElement`

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2002-2004 XDoclet Team. All Rights Reserved.