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 inTypeSection.TypeDefinition
and parameter definition inBslDocumentationComment.ParametersSection
-
-
Constructor Summary
Constructors Constructor Description FieldDefinition(IDescriptionPart parent)
Constructor.FieldDefinition(IDescriptionPart parent, String name)
Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description BslDocumentationComment.Description
getDescription()
GetsBslDocumentationComment.Description
of the field, description is text writed before type section of the fieldint
getLineNumber()
Gets line number of starting field definitionString
getName()
Gets name of the fieldint
getNameOffset()
Gets offset on the line of begining field nameint
getOffset()
Gets offset of the begining part.IDescriptionPart
getParent()
Gets the parent object.List<TypeSection>
getTypeSections()
GetsTypeSection
s of the fieldboolean
match(int lineNumber, int offset)
Checks that this description part corresponding to the concrete line number and offsetvoid
setLineNumber(int lineNumber)
Sets line number of starting field definitionvoid
setName(String name)
Sets name of the fieldvoid
setNameOffset(int offset)
Sets offset on the line of begining field name
-
-
-
Constructor Detail
-
FieldDefinition
public FieldDefinition(IDescriptionPart parent)
Constructor.- Parameters:
parent
- the parent object, cannot benull
.
-
FieldDefinition
public FieldDefinition(IDescriptionPart parent, String name)
Constructor. Creates field with concrete name- Parameters:
parent
- the parent object, cannot benull
.name
- name of the creating field, cannot benull
-
-
Method Detail
-
getParent
public IDescriptionPart getParent()
Gets the parent object.- Specified by:
getParent
in interfaceIDescriptionPart
- 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 benull
-
getDescription
public BslDocumentationComment.Description getDescription()
GetsBslDocumentationComment.Description
of the field, description is text writed before type section of the field- Returns:
BslDocumentationComment.Description
of the field, cannot benull
-
getTypeSections
public List<TypeSection> getTypeSections()
GetsTypeSection
s of the field- Returns:
TypeSection
s of the field, nevernull
-
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 interfaceIDescriptionPart
- 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 interfaceIDescriptionPart
- 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 interfaceIDescriptionPart
- Parameters:
lineNumber
- number of the documentation comment lineoffset
- local offset on the comment line- Returns:
true
if this description part corresponding to the send line number and offset,false
otherwise
-
-