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

Class BslDocumentationComment.Description

java.lang.Object

com._1c.g5.v8.dt.bsl.documentation.comment.BslDocumentationComment.Description

All Implemented Interfaces:

IDescriptionPart

Enclosing class:

BslDocumentationComment

public static class BslDocumentationComment.Description
extends Object
implements IDescriptionPart

Class represent description of the BslDocumentationComment.Section of the Bsl documentation comment. Description contains differents IDescriptionParts

Constructor Summary

Constructors

Constructor	Description
Description(IDescriptionPart parent)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	addPart(DescriptionPart part)	Adds new IDescriptionPart to the description
void	addParts(Collection<IDescriptionPart> parts)	Adds new IDescriptionParts to the description
int	getLineNumber()	Gets the line nubmer corresponding to part.
int	getOffset()	Gets offset of the begining part.
IDescriptionPart	getParent()	Gets the parent object.
List<IDescriptionPart>	getParts()	Gets IDescriptionParts contain in description
boolean	match(int lineNumber, int offset)	Checks that this description part corresponding to the concrete line number and offset

Methods inherited from class java.lang.Object

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

Constructor Detail

Description

public Description(IDescriptionPart parent)

Constructor. Empty description

Parameters:

parent - the parent object, cannot be null.

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

addPart

public void addPart(DescriptionPart part)

Adds new IDescriptionPart to the description

Parameters:

part - adding part, cannot be null

addParts

public void addParts(Collection<IDescriptionPart> parts)

Adds new IDescriptionParts to the description

Parameters:

parts - adding parts, cannot be null

getParts

public List<IDescriptionPart> getParts()

Gets IDescriptionParts contain in description

Returns:

parts in description, never null

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

match

public boolean match(int lineNumber,
                     int offset)

Description copied from interface: IDescriptionPart

Checks that this description part corresponding to the concrete line number and offset

Specified by:

match in interface IDescriptionPart

Parameters:

lineNumber - number of the documentation comment line

offset - local offset on the comment line

Returns:

true if this description part corresponding to the send line number and offset, false otherwise