Package org.eclipse.cdt.core.dom.ast.tag
Interface ITag
- All Known Subinterfaces:
IWritableTag
public interface ITag
Tags are used to annotate
ITagReader
's with extra information. They are created by
implementations of IBindingTagger
which are contributed using
the org.eclipse.cdt.core.tagger extension point. The base tag interface is read-only, it is
extended by the writable IWritableTag
.- Since:
- 5.5
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionstatic final int
A constant that is returned to indicate a read failure. -
Method Summary
Modifier and TypeMethodDescriptionint
getByte
(int offset) Returns the byte from the specified offset orFAIL
on failure.byte[]
getBytes
(int offset, int len) Returns the specified number of bytes from the specified offset.int
Returns the number of bytes in the tag's data payload.Returns the globally unique id of the tagger that created the receiver.
-
Field Details
-
FAIL
static final int FAILA constant that is returned to indicate a read failure.- See Also:
-
-
Method Details
-
getDataLen
int getDataLen()Returns the number of bytes in the tag's data payload. -
getTaggerId
String getTaggerId()Returns the globally unique id of the tagger that created the receiver. -
getByte
int getByte(int offset) Returns the byte from the specified offset orFAIL
on failure. -
getBytes
byte[] getBytes(int offset, int len) Returns the specified number of bytes from the specified offset. Specifylen
of -1 to read all bytes from the specified offset to the end of the payload. Returns null if the given range is not valid. This would be expected if the version of the contributor has changed in a way that changes the structure of the data that it stores. Contributors must be able to deal with that case.
-