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

Class TypeSection.LinkContainsTypeDefinition

java.lang.Object

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

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

All Implemented Interfaces:

IDescriptionPart

Enclosing class:

TypeSection

public static class TypeSection.LinkContainsTypeDefinition
extends TypeSection.TypeDefinition

Implementation of TypeSection.TypeDefinition which contains LinkPart to the element for getting types for element collection.

Constructor Summary

Constructors

Constructor	Description
LinkContainsTypeDefinition(IDescriptionPart parent, LinkPart link)	Constructor for link type definition.

Method Summary

Modifier and Type	Method	Description
void	addContainType(TypeSection.TypeDefinition containType)	Adds TypeSection.TypeDefinition of type that should be contains as element of collection for this type
List<TypeSection.TypeDefinition>	getContainTypes()
List<TypeSection.FieldDefinition>	getFieldDefinitionExtension()	Gets TypeSection.FieldDefinitions of extra fields of this type
int	getLineNumber()	Gets line number of starting type definition
LinkPart	getLink()	Gets containing LinkPart
int	getOffset()	Gets offset of the begining part.
boolean	match(int lineNumber, int offset)	Checks that this description part corresponding to the concrete line number and offset
void	setTypeName(String typeName)	Sets type name of the definition type

Methods inherited from class com._1c.g5.v8.dt.bsl.documentation.comment.TypeSection.TypeDefinition

getLinkToExtensionFields, getNameOffset, getParent, getTypeName, setLineNumber, setLinkToExtensionFields, setNameOffset

Methods inherited from class java.lang.Object

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

Constructor Detail

LinkContainsTypeDefinition

public LinkContainsTypeDefinition(IDescriptionPart parent,
                                  LinkPart link)

Constructor for link type definition.

Parameters:

parent - the parent object, cannot be null.

link - assosiation LinkPart, cannot be null

Method Detail

getLink

public LinkPart getLink()

Gets containing LinkPart

Returns:

containing LinkPart, never null

setTypeName

public void setTypeName(String typeName)

Description copied from class: TypeSection.TypeDefinition

Sets type name of the definition type

Overrides:

setTypeName in class TypeSection.TypeDefinition

Parameters:

typeName - type name of the definition type, cannot be null

addContainType

public void addContainType(TypeSection.TypeDefinition containType)

Description copied from class: TypeSection.TypeDefinition

Adds TypeSection.TypeDefinition of type that should be contains as element of collection for this type

Overrides:

addContainType in class TypeSection.TypeDefinition

Parameters:

containType - type that should be contains as element of collection for this type, cannot be null

getContainTypes

public List<TypeSection.TypeDefinition> getContainTypes()

Overrides:

getContainTypes in class TypeSection.TypeDefinition

getFieldDefinitionExtension

public List<TypeSection.FieldDefinition> getFieldDefinitionExtension()

Description copied from class: TypeSection.TypeDefinition

Gets TypeSection.FieldDefinitions of extra fields of this type

Overrides:

getFieldDefinitionExtension in class TypeSection.TypeDefinition

Returns:

TypeSection.FieldDefinitions of extra fields of this type, never null

getLineNumber

public int getLineNumber()

Description copied from class: TypeSection.TypeDefinition

Gets line number of starting type definition

Specified by:

getLineNumber in interface IDescriptionPart

Overrides:

getLineNumber in class TypeSection.TypeDefinition

Returns:

lineNumber line number of starting type 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

Overrides:

getOffset in class TypeSection.TypeDefinition

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

Overrides:

match in class TypeSection.TypeDefinition

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