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

Class TypeSection

java.lang.Object

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

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

All Implemented Interfaces:

IDescriptionPart

public class TypeSection
extends BslDocumentationComment.Section

Class represents type section in Bsl documentation comment. Type section can contain some parts:

• Main part - set of the type names - should be write in one line, devided by IBslCommentToken.TYPE_SECTION_TYPE_DELIMETER
• Description of the extra fields - writes in new line, main part should be end with IBslCommentToken.TYPE_SECTION_EXTENSION_COLON
• Text description of the type section - always writes after main part and extra fields part in new format, or writes after main part and before extra fields in old format

 [TypeName1, TypeName2:
     extraFieldForType2 (TypeSection for field)? (description of the field)?
 ]
 

If user want that collection type contains special type for elements in collection - should used IBslCommentToken.CONTAINS Examle of Array that contains elements with String type

 [Array contains String]
 

Complicated case, when Array contains some types String and Structure, and Structure has extra fields

 [Array contains String, Structure:
      fieldForStructure1
     *fieldForStructure2
 ]
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TypeSection.FieldDefinition	Class represents extra fields in TypeSection.TypeDefinition and parameter definition in BslDocumentationComment.ParametersSection
static class	TypeSection.LinkContainsTypeDefinition	Implementation of TypeSection.TypeDefinition which contains LinkPart to the element for getting types for element collection.
static class	TypeSection.TypeDefinition	Special objects represents one type from TypeSection.

Constructor Summary

Constructors

Constructor	Description
TypeSection(IDescriptionPart parent, int lineNumber)	Constructor.
TypeSection(IDescriptionPart parent, int lineNumber, int offset, int headerKeywordLength)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	closeSection()	Sets that section was closed
void	fill(List<TypeItem> typeItems, String description, boolean isRu)	Fills type section with real TypeItem
void	fill(List<TypeItem> typeItems, String description, boolean isRu, org.eclipse.emf.ecore.EObject context)	Fills type section with real TypeItem
BslDocumentationComment.Description	getCurrentDescription()	Gets actual BslDocumentationComment.Description for adding new content.
IDescriptionPart	getDescriptionPart(int lineNumber, int offset)	Gets actual documentation comment IDescriptionPart by line number and local line offset
BslDocumentationComment.Description	getSourceDescription()	Gets BslDocumentationComment.Description which contains content of the main part of type section
BslDocumentationComment.Description	getSourceExtensionDescription()	Gets BslDocumentationComment.Description which contains content of the extra fields part of type section
List<TypeSection.TypeDefinition>	getTypeDefinitions()	Gets TypeSection.TypeDefinition described in type section
void	hasTypeExtensionPart(boolean isExtensionPart)	Sets that section has extra fields part
boolean	isClose()	Checks that section was closed or not
boolean	isExtensionPart()	Checks that section has extra fields part
boolean	match(int lineNumber, int offset)	Checks that this description part corresponding to the concrete line number and offset

Methods inherited from class com._1c.g5.v8.dt.bsl.documentation.comment.BslDocumentationComment.Section

getDescription, getHeaderKeywordLength, getLineNumber, getOffset, getParent

Methods inherited from class java.lang.Object

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

Constructor Detail

TypeSection

public TypeSection(IDescriptionPart parent,
                   int lineNumber,
                   int offset,
                   int headerKeywordLength)

Constructor.

Parameters:

parent - the parent object, cannot be null.

lineNumber - number of line from the comment begining corresponding to the start line of the section

offset - local line offset of the begining section on the line

headerKeywordLength - length of the keyword of the section

TypeSection

public TypeSection(IDescriptionPart parent,
                   int lineNumber)

Constructor. This constructor should be used if section description created programmatically

Parameters:

parent - the parent object, cannot be null.

lineNumber - number of line from the comment begining corresponding to the start line of the section

Method Detail

getTypeDefinitions

public List<TypeSection.TypeDefinition> getTypeDefinitions()

Gets TypeSection.TypeDefinition described in type section

Returns:

TypeSection.TypeDefinition described in type section, never null

getSourceDescription

public BslDocumentationComment.Description getSourceDescription()

Gets BslDocumentationComment.Description which contains content of the main part of type section

Returns:

BslDocumentationComment.Description which contains content of the main part of type section, never null

getSourceExtensionDescription

public BslDocumentationComment.Description getSourceExtensionDescription()

Gets BslDocumentationComment.Description which contains content of the extra fields part of type section

Returns:

BslDocumentationComment.Description which contains content of the the extra fields part of type section, never null

getCurrentDescription

public BslDocumentationComment.Description getCurrentDescription()

Gets actual BslDocumentationComment.Description for adding new content. If IBslCommentToken.TYPE_SECTION_EXTENSION_COLON was found earlier then getSourceExtensionDescription() will be returned, if type section was closed earlier then BslDocumentationComment.Section.getDescription() will be returned else main part getSourceDescription() will be returned

Returns:

actual BslDocumentationComment.Description for adding new content, never null

closeSection

public void closeSection()

Sets that section was closed

isClose

public boolean isClose()

Checks that section was closed or not

Returns:

true if section is closed, false otherwise

hasTypeExtensionPart

public void hasTypeExtensionPart(boolean isExtensionPart)

Sets that section has extra fields part

Parameters:

isExtensionPart - true if section has extra fields part, false otherwise

isExtensionPart

public boolean isExtensionPart()

Checks that section has extra fields part

Returns:

true if section has extra fields part, false otherwise

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

Overrides:

match in class BslDocumentationComment.Section

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

getDescriptionPart

public IDescriptionPart getDescriptionPart(int lineNumber,
                                           int offset)

Gets actual documentation comment IDescriptionPart by line number and local line offset

Parameters:

lineNumber - number of the comment line for getting IDescriptionPart

offset - local line offset for getting IDescriptionPart

Returns:

IDescriptionPart corresponding to the line number and local line offset, can be null if there is no description part on this line number and offset

fill

public void fill(List<TypeItem> typeItems,
                 String description,
                 boolean isRu)

Fills type section with real TypeItem

Parameters:

typeItems - collection of the real TypeItems, cannot be null

description - text description of the type section, cannot be null

isRu - true if should use Russian name of the type in creating type section, false if should use English names

fill

public void fill(List<TypeItem> typeItems,
                 String description,
                 boolean isRu,
                 org.eclipse.emf.ecore.EObject context)

Fills type section with real TypeItem

Parameters:

typeItems - collection of the real TypeItems, cannot be null

description - text description of the type section, cannot be null

isRu - true if should use Russian name of the type in creating type section, false if should use English names

context - context EObject for resolving TypeItem from collection, can be null if resolving not needed