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

Class TypeSection.FieldDefinition

java.lang.Object

com._1c.g5.v8.dt.bsl.documentation.comment.TypeSection.FieldDefinition

All Implemented Interfaces:

IDescriptionPart

Enclosing class:

TypeSection

public static class TypeSection.FieldDefinition
extends Object
implements IDescriptionPart

Class represents extra fields in TypeSection.TypeDefinition and parameter definition in BslDocumentationComment.ParametersSection

Constructor Summary

Constructors

Constructor	Description
FieldDefinition(IDescriptionPart parent)	Constructor.
FieldDefinition(IDescriptionPart parent, String name)	Constructor.

Method Summary

Modifier and Type	Method	Description
BslDocumentationComment.Description	getDescription()	Gets BslDocumentationComment.Description of the field, description is text writed before type section of the field
int	getLineNumber()	Gets line number of starting field definition
String	getName()	Gets name of the field
int	getNameOffset()	Gets offset on the line of begining field name
int	getOffset()	Gets offset of the begining part.
IDescriptionPart	getParent()	Gets the parent object.
List<TypeSection>	getTypeSections()	Gets TypeSections of the field
boolean	match(int lineNumber, int offset)	Checks that this description part corresponding to the concrete line number and offset
void	setLineNumber(int lineNumber)	Sets line number of starting field definition
void	setName(String name)	Sets name of the field
void	setNameOffset(int offset)	Sets offset on the line of begining field name

Methods inherited from class java.lang.Object

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

Constructor Detail

FieldDefinition

public FieldDefinition(IDescriptionPart parent)

Constructor.

Parameters:

parent - the parent object, cannot be null.

FieldDefinition

public FieldDefinition(IDescriptionPart parent,
                       String name)

Constructor. Creates field with concrete name

Parameters:

parent - the parent object, cannot be null.

name - name of the creating field, 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

getName

public String getName()

Gets name of the field

Returns:

name of the field, never null

setName

public void setName(String name)

Sets name of the field

Parameters:

name - name of the field, cannot be null

getDescription

public BslDocumentationComment.Description getDescription()

Gets BslDocumentationComment.Description of the field, description is text writed before type section of the field

Returns:

BslDocumentationComment.Description of the field, cannot be null

getTypeSections

public List<TypeSection> getTypeSections()

Gets TypeSections of the field

Returns:

TypeSections of the field, never null

setNameOffset

public void setNameOffset(int offset)

Sets offset on the line of begining field name

Parameters:

offset - on the line of begining field name

getNameOffset

public int getNameOffset()

Gets offset on the line of begining field name

Returns:

offset on the line of begining field name

setLineNumber

public void setLineNumber(int lineNumber)

Sets line number of starting field definition

Parameters:

lineNumber - line number of starting field definition, line number compute from the start comment section

getLineNumber

public int getLineNumber()

Gets line number of starting field definition

Specified by:

getLineNumber in interface IDescriptionPart

Returns:

lineNumber line number of starting field definition, line number compute from the start comment section

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.

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