Class TypeSection.TypeDefinition
- java.lang.Object
-
- com._1c.g5.v8.dt.bsl.documentation.comment.TypeSection.TypeDefinition
-
- Direct Known Subclasses:
TypeSection.LinkContainsTypeDefinition
- Enclosing class:
- TypeSection
public static class TypeSection.TypeDefinition extends Object
Special objects represents one type fromTypeSection
.
-
-
Constructor Summary
Constructors Constructor Description TypeDefinition()
Constructor for empty definitionTypeDefinition(String typeName)
Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addContainType(TypeSection.TypeDefinition containType)
AddsTypeSection.TypeDefinition
of type that should be contains as element of collection for this typeList<TypeSection.TypeDefinition>
getContainTypes()
List<TypeSection.FieldDefinition>
getFieldDefinitionExtension()
GetsTypeSection.FieldDefinition
s of extra fields of this typeint
getLineNumber()
Gets line number of starting type definitionLinkPart
getLinkToExtensionFields()
Gets specialLinkPart
links to extension fields from another documentation commentint
getNameOffset()
Gets offset on the line of begining type nameString
getTypeName()
Gets type name of the definition typevoid
setLineNumber(int lineNumber)
Sets line number of starting type definitionvoid
setLinkToExtensionFields(LinkPart linkToExtensionFields)
Sets specialLinkPart
links to extension fields from another documentation commentvoid
setNameOffset(int offset)
Sets offset on the line of begining type namevoid
setTypeName(String typeName)
Sets type name of the definition type
-
-
-
Constructor Detail
-
TypeDefinition
public TypeDefinition()
Constructor for empty definition
-
TypeDefinition
public TypeDefinition(String typeName)
Constructor. Creates type definition for type with special name- Parameters:
typeName
- name of the type, cannot benull
-
-
Method Detail
-
getTypeName
public String getTypeName()
Gets type name of the definition type- Returns:
- type name of the definition type, never
null
-
setTypeName
public void setTypeName(String typeName)
Sets type name of the definition type- Parameters:
typeName
- type name of the definition type, cannot benull
-
addContainType
public void addContainType(TypeSection.TypeDefinition containType)
AddsTypeSection.TypeDefinition
of type that should be contains as element of collection for this type- Parameters:
containType
- type that should be contains as element of collection for this type, cannot benull
-
getContainTypes
public List<TypeSection.TypeDefinition> getContainTypes()
-
getFieldDefinitionExtension
public List<TypeSection.FieldDefinition> getFieldDefinitionExtension()
GetsTypeSection.FieldDefinition
s of extra fields of this type- Returns:
TypeSection.FieldDefinition
s of extra fields of this type, nevernull
-
setNameOffset
public void setNameOffset(int offset)
Sets offset on the line of begining type name- Parameters:
offset
- on the line of begining type name
-
getNameOffset
public int getNameOffset()
Gets offset on the line of begining type name- Returns:
- offset on the line of begining type name
-
setLineNumber
public void setLineNumber(int lineNumber)
Sets line number of starting type definition- Parameters:
lineNumber
- line number of starting type definition, line number compute from the start comment section
-
getLineNumber
public int getLineNumber()
Gets line number of starting type definition- Returns:
- lineNumber line number of starting type definition, line number compute from the start comment section
-
getLinkToExtensionFields
public LinkPart getLinkToExtensionFields()
Gets specialLinkPart
links to extension fields from another documentation comment- Returns:
LinkPart
links to extension fields from another documentation comment, can benull
if there is no link
-
setLinkToExtensionFields
public void setLinkToExtensionFields(LinkPart linkToExtensionFields)
Sets specialLinkPart
links to extension fields from another documentation comment- Parameters:
linkToExtensionFields
-LinkPart
links to extension fields from another documentation comment, can benull
if there is no link
-
-