Package com._1c.g5.v8.dt.bsl.documentation.comment

Class DescriptionPart

java.lang.Object

com._1c.g5.v8.dt.bsl.documentation.comment.DescriptionPart

All Implemented Interfaces:

IDescriptionPart

Direct Known Subclasses:

LinkPart, TextPart

public abstract class DescriptionPart
extends Object
implements IDescriptionPart

Abstract implementation of IDescriptionPart, provides logic for keeping offset and line number

Constructor Summary

Constructors

Constructor	Description
DescriptionPart(IDescriptionPart parent, int lineNumber, int offset)	Constructor.

Method Summary

Modifier and Type	Method	Description
int	getLineNumber()	Gets the line nubmer corresponding to part.
int	getOffset()	Gets offset of the begining part.
IDescriptionPart	getParent()	Gets the parent object.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com._1c.g5.v8.dt.bsl.documentation.comment.IDescriptionPart

match

Constructor Detail

DescriptionPart

public DescriptionPart(IDescriptionPart parent,
                       int lineNumber,
                       int offset)

Constructor.

Parameters:

parent - the parent object, cannot be null.

lineNumber - line nubmer corresponding to part

offset - offset of the begining part

Method Detail

getParent

public IDescriptionPart getParent()

Gets the parent object.

Specified by:

getParent in interface IDescriptionPart

Returns:

the parent object, can return null if it is created separetly form parsing

getOffset

public int getOffset()

Description copied from interface: IDescriptionPart

Gets offset of the begining part. Offset - local inline offset

Specified by:

getOffset in interface IDescriptionPart

Returns:

offset of the begining part.

getLineNumber

public int getLineNumber()

Description copied from interface: IDescriptionPart

Gets the line nubmer corresponding to part. Numeration starts from 0 Line number - line number corresponding to the begining of the documentation comment. Each comment starts with line with number 0

Specified by:

getLineNumber in interface IDescriptionPart

Returns:

the line nubmer corresponding to part