Extension SDK 9.0.5

oracle.jdeveloper.jot
Interface JotMember

All Superinterfaces:
JotCodeElement, JotElement, JotHasModifiers
All Known Subinterfaces:
JotClassInitializer, JotConstructor, JotFieldDeclaration, JotInnerClass, JotMethod

public interface JotMember
extends JotHasModifiers, JotCodeElement

The JotMember interface represents elements that are members of a class. The types of members supported are fields, methods, constructors, and class or instance initializers.

Since:
5.0
See Also:
JotClass, JotField, JotMethod, JotConstructor, JotClassInitializer, "Sections 8 and 9 of the Java Language Specification"

Method Summary
 JotClass getDeclaringClass()
          Retrieves the class that contains this member declaration.
 boolean isDeprecated()
          In a source class, a constructor, method, or field is considered deprecated if the associated Javadoc has been marked '@deprecated'.
 boolean isHidden()
          In a source class, a constructor, method, or field is considered hidden if the associated Javadoc has been marked '@hidden'.
 
Methods inherited from interface oracle.jdeveloper.jot.JotHasModifiers
getModifiers, getModifierText, setModifiers, setModifierText
 
Methods inherited from interface oracle.jdeveloper.jot.JotCodeElement
addPrecedingComment, childrenContainErrors, delete, getContainingJotFile, getLeftWhitespace, getLength, getRightWhitespace, isInError, isSource, setLeftWhitespace, setRightWhitespace
 
Methods inherited from interface oracle.jdeveloper.jot.JotElement
getChildren, getContainedElements, getElementName, getElementType, getEndOffset, getID, getJotWorkArea, getParent, getStartOffset, isExistent, isReadOnly, isStructureKnown, setParent
 

Method Detail

getDeclaringClass

public JotClass getDeclaringClass()
                           throws JotInvalidElementException
Retrieves the class that contains this member declaration.

Returns:
a class or interface.
Throws:
JotInvalidElementException

isDeprecated

public boolean isDeprecated()
                     throws JotInvalidElementException
In a source class, a constructor, method, or field is considered deprecated if the associated Javadoc has been marked '@deprecated'. In a compiled class, a constructor, method, or field is considered deprecated if the deprecated attribute is set for that member. All other members are considered to be not deprecated.

Returns:
true if this JotMember is deprecated.
Throws:
JotInvalidElementException

isHidden

public boolean isHidden()
                 throws JotInvalidElementException
In a source class, a constructor, method, or field is considered hidden if the associated Javadoc has been marked '@hidden'. In a compiled class, a constructor, method, or field is considered hidden if the hidden attribute is set for that member. All other members are considered to be not hidden.

Returns:
true if this JotMember is hidden.
Throws:
JotInvalidElementException

Extension SDK

 

Copyright © 1997, 2004, Oracle. All rights reserved.