Package com._1c.g5.v8.dt.bsl.ui

Class BslDocumentationProvider.DocumentContent.ParamContent

java.lang.Object

com._1c.g5.v8.dt.bsl.ui.BslDocumentationProvider.DocumentContent.ParamContent

Enclosing class:

BslDocumentationProvider.DocumentContent

public static class BslDocumentationProvider.DocumentContent.ParamContent
extends Object

Contains information about parameter of method or constructor

Constructor Summary

Constructors

Constructor	Description
ParamContent(String name, String paramDescr, List<BslDocumentationProvider.DocumentContent.GroupTypeDescription> type, boolean isRequired)	Initialize parameter of method or constructor

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Gets description of the parameter
String	getRequiredString()	Returns textual representation of whether the parameter is marked as required
String	getSignature(String returnTypeStr, String syntax)	Returns string which corresponds to return type concatenated with signature of a method
String	getTypePresentation()	Return type presentation of param
String	getTypeString()	Returns string with corresponding types
static BslDocumentationProvider.DocumentContent.ParamContent	parseParamContent(String content)	Parses parameter content
String	toFormatString(int count)	Creates format string for parameter of method or constructor
String	toFormatStringForContentAssist(String returnTypeStr, String syntax, boolean needTypeSection)	Creates format string for method in hover in BSL

Methods inherited from class java.lang.Object

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

Constructor Detail

ParamContent

public ParamContent(String name,
                    String paramDescr,
                    List<BslDocumentationProvider.DocumentContent.GroupTypeDescription> type,
                    boolean isRequired)

Initialize parameter of method or constructor

Parameters:

name - name of parameter, can be null

paramDescr - description of method, cant be null

type - name of type parameter, can be null

isRequired - required parameter or not

Method Detail

parseParamContent

public static BslDocumentationProvider.DocumentContent.ParamContent parseParamContent(String content)

Parses parameter content

Parameters:

content - parameters string representation content, can be null

Returns:

created parameter, can be null

toFormatString

public String toFormatString(int count)

Creates format string for parameter of method or constructor

Parameters:

count -

Returns:

format string for parameter of method or constructor, never null

toFormatStringForContentAssist

public String toFormatStringForContentAssist(String returnTypeStr,
                                             String syntax,
                                             boolean needTypeSection)

Creates format string for method in hover in BSL

Parameters:

returnTypeStr - name of return Type of method, can be null

syntax - syntax of method, can be null

needTypeSection - true if content should have parameter section, false otherwise

Returns:

format string for method in hover in BSL, never null

getSignature

public String getSignature(String returnTypeStr,
                           String syntax)

Returns string which corresponds to return type concatenated with signature of a method

Parameters:

returnTypeStr - string of return types corresponding to method, can be null

syntax - string of method's syntax, can be null

Returns:

composed string of return types and method's syntax, can be null

getTypeString

public String getTypeString()

Returns string with corresponding types

Returns:

string with corresponding types, can be null

getRequiredString

public String getRequiredString()

Returns textual representation of whether the parameter is marked as required

Returns:

string of whether the selected parameter is required, cannot be null

getTypePresentation

public String getTypePresentation()

Return type presentation of param

Returns:

type presentation

getDescription

public String getDescription()

Gets description of the parameter

Returns:

parameter description, cannot be null