Class FieldInfoData

java.lang.Object

org.fife.rsta.ac.java.FieldInfoData

All Implemented Interfaces:

IconFactory.IconData, MemberCompletion.Data

class FieldInfoData
extends Object
implements MemberCompletion.Data

Metadata about a field as read from a class file. This class is used by instances of FieldCompletion.

Version:

1.0

Field Summary

Fields

Modifier and Type	Field	Description
private FieldInfo	info
private SourceCompletionProvider	provider

Constructor Summary

Constructors

Constructor	Description
FieldInfoData(FieldInfo info, SourceCompletionProvider provider)

Method Summary

Modifier and Type	Method	Description
String	getEnclosingClassName(boolean fullyQualified)	Returns the name of the enclosing class.
String	getIcon()	Returns the main icon to use when rendering this member's completion.
String	getSignature()	Returns the signature of this member.
String	getSummary()	Returns the summary description (should be HTML) for this member.
private String	getSummaryFromSourceLoc(SourceLocation loc, ClassFile cf)	Scours the source in a location (zip file, directory), looking for a particular class's source.
String	getType()	Returns the type of this member (the return type for methods).
boolean	isAbstract()	Always returns false since fields cannot be abstract.
boolean	isConstructor()	Always returns false, fields cannot be constructors.
boolean	isDeprecated()	Returns whether this icon represents a deprecated class/method/etc.
boolean	isFinal()	Returns whether this icon represents a final class/method/etc.
boolean	isStatic()	Returns whether this icon represents a static class/method/etc.

Methods inherited from class Object

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

Field Details

info

private FieldInfo info

provider

private SourceCompletionProvider provider

Constructor Details

FieldInfoData

FieldInfoData(FieldInfo info,
 SourceCompletionProvider provider)

Method Details

getEnclosingClassName

public String getEnclosingClassName(boolean fullyQualified)

Description copied from interface: MemberCompletion.Data

Returns the name of the enclosing class.

Specified by:

getEnclosingClassName in interface MemberCompletion.Data

Parameters:

fullyQualified - Whether the name returned should be fully qualified.

Returns:

The class name.

getIcon

public String getIcon()

Description copied from interface: IconFactory.IconData

Returns 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:

getIcon in interface IconFactory.IconData

Returns:

The icon to use.

getSignature

public String getSignature()

Description copied from interface: MemberCompletion.Data

Returns the signature of this member.

Specified by:

getSignature in interface MemberCompletion.Data

Returns:

The signature.

See Also:

• MemberCompletion.getSignature()

getSummary

public String getSummary()

Description copied from interface: MemberCompletion.Data

Returns the summary description (should be HTML) for this member.

Specified by:

getSummary in interface MemberCompletion.Data

Returns:

The summary description, or null if there is none.

See Also:

• Completion.getSummary()

getSummaryFromSourceLoc

private String getSummaryFromSourceLoc(SourceLocation loc,
 ClassFile cf)

Scours the source in a location (zip file, directory), looking for a particular class's source. If it is found, it is parsed, and the Javadoc for this field (if any) is returned.

Parameters:

loc - The zip file, jar file, or directory to look in.

cf - The ClassFile representing the class of this field.

Returns:

The summary, or null if the field has no javadoc, the class's source was not found, or an IO error occurred.

getType

public String getType()

Description copied from interface: MemberCompletion.Data

Returns the type of this member (the return type for methods).

Specified by:

getType in interface MemberCompletion.Data

Returns:

The type of this member.

See Also:

• MemberCompletion.getType()

isAbstract

public boolean isAbstract()

Always returns false since fields cannot be abstract.

Specified by:

isAbstract in interface IconFactory.IconData

Returns:

false always.

isConstructor

public boolean isConstructor()

Always returns false, fields cannot be constructors.

Specified by:

isConstructor in interface MemberCompletion.Data

Returns:

false always.

isDeprecated

public boolean isDeprecated()

Description copied from interface: IconFactory.IconData

Returns whether this icon represents a deprecated class/method/etc.

Specified by:

isDeprecated in interface IconFactory.IconData

Returns:

Whether it represents something deprecated.

isFinal

public boolean isFinal()

Description copied from interface: IconFactory.IconData

Returns whether this icon represents a final class/method/etc.

Specified by:

isFinal in interface IconFactory.IconData

Returns:

Whether it represents something final.

isStatic

public boolean isStatic()

Description copied from interface: IconFactory.IconData

Returns whether this icon represents a static class/method/etc.

Specified by:

isStatic in interface IconFactory.IconData

Returns:

Whether it represents something static.