Package org.fife.rsta.ac.java
Class FieldData
java.lang.Object
org.fife.rsta.ac.java.FieldData
- All Implemented Interfaces:
IconFactory.IconData,MemberCompletion.Data
Metadata about a field as read from a Java source file. This class is
used by instances of
FieldCompletion.- Version:
- 1.0
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptiongetEnclosingClassName(boolean fullyQualified) Returns the name of the enclosing class.getIcon()Returns the main icon to use when rendering this member's completion.Returns the signature of this member.Returns the summary description (should be HTML) for this member.getType()Returns the type of this member (the return type for methods).booleanReturns whether this icon represents an abstract class/method/etc.booleanAlways returnsfalse, fields cannot be constructors.booleanReturns whether this icon represents a deprecated class/method/etc.booleanisFinal()Returns whether this icon represents a final class/method/etc.booleanisStatic()Returns whether this icon represents a static class/method/etc.
-
Field Details
-
field
-
-
Constructor Details
-
FieldData
FieldData(Field field)
-
-
Method Details
-
getEnclosingClassName
Description copied from interface:MemberCompletion.DataReturns the name of the enclosing class.- Specified by:
getEnclosingClassNamein interfaceMemberCompletion.Data- Parameters:
fullyQualified- Whether the name returned should be fully qualified.- Returns:
- The class name.
-
getIcon
Description copied from interface:IconFactory.IconDataReturns the main icon to use when rendering this member's completion. This icon will be decorated appropriately based on whether it is abstract, deprecated, final, static, or any of the above.- Specified by:
getIconin interfaceIconFactory.IconData- Returns:
- The icon to use.
-
getSignature
Description copied from interface:MemberCompletion.DataReturns the signature of this member.- Specified by:
getSignaturein interfaceMemberCompletion.Data- Returns:
- The signature.
- See Also:
-
getSummary
Description copied from interface:MemberCompletion.DataReturns the summary description (should be HTML) for this member.- Specified by:
getSummaryin interfaceMemberCompletion.Data- Returns:
- The summary description, or
nullif there is none. - See Also:
-
getType
Description copied from interface:MemberCompletion.DataReturns the type of this member (the return type for methods).- Specified by:
getTypein interfaceMemberCompletion.Data- Returns:
- The type of this member.
- See Also:
-
isAbstract
public boolean isAbstract()Description copied from interface:IconFactory.IconDataReturns whether this icon represents an abstract class/method/etc.- Specified by:
isAbstractin interfaceIconFactory.IconData- Returns:
- Whether it represents something abstract.
-
isConstructor
public boolean isConstructor()Always returnsfalse, fields cannot be constructors.- Specified by:
isConstructorin interfaceMemberCompletion.Data- Returns:
falsealways.
-
isDeprecated
public boolean isDeprecated()Description copied from interface:IconFactory.IconDataReturns whether this icon represents a deprecated class/method/etc.- Specified by:
isDeprecatedin interfaceIconFactory.IconData- Returns:
- Whether it represents something deprecated.
-
isFinal
public boolean isFinal()Description copied from interface:IconFactory.IconDataReturns whether this icon represents a final class/method/etc.- Specified by:
isFinalin interfaceIconFactory.IconData- Returns:
- Whether it represents something final.
-
isStatic
public boolean isStatic()Description copied from interface:IconFactory.IconDataReturns whether this icon represents a static class/method/etc.- Specified by:
isStaticin interfaceIconFactory.IconData- Returns:
- Whether it represents something static.
-