jeb.api

Class Comment

java.lang.Object

jeb.api.Comment

public class Comment
extends java.lang.Object

This class represents a code comment. Currently, only text (no audio) comments are supported.

Comments can be attached to an entire file (global, or 'notes'), a class, a field, a method, or an instruction within a method body.

Since:

1.2.201305230

Method Summary

Modifier and Type	Method and Description
java.lang.String	getItemSignature() Get the full name of the item onto which the comment is attached.
int	getMethodOffset() Retrieve the method offset for this comment, if the comment is on an instruction.
java.lang.String	getText() Get the comment text string.

Methods inherited from class java.lang.Object

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

Method Detail

getItemSignature

public java.lang.String getItemSignature()

Get the full name of the item onto which the comment is attached. It can be a class, field, or method. If null, this means this is the global comment.

Returns:

the item signature, or null if the comment is global

Since:

1.2.201305230

getMethodOffset

public int getMethodOffset()

Retrieve the method offset for this comment, if the comment is on an instruction.

Returns:

the offset, or -1 if the comment is not attached to an instruction

Since:

1.2.201305230

getText

public java.lang.String getText()

Get the comment text string.

Returns:

the text string

Since:

1.2.201305230