[Task]: Deprecate the diagnosticProperty API from the DiagBasedPositionDetails class

[nipunayf]

Description

As shown below, there are two APIs to obtain a diagnostic property from a diagnostic in a diagnostic-based code action. However, the first API has a risk of throwing an out-of-bound exception. Hence, the codebase should be refactored to remove the first API and only use the latter one.

ballerina-lang/language-server/modules/langserver-commons/src/main/java/org/ballerinalang/langserver/commons/codeaction/spi/DiagBasedPositionDetails.java

Lines 58 to 72 in f67afde

	/**
	* Returns optional value of the diagnostic property.
	*
	* @param propertyIndex property index
	* @return Value of the property at given index
	*/
	<T> Optional<T> diagnosticProperty(int propertyIndex);
	/**
	* Returns optional value of the diagnostic property.
	*
	* @param function Function to be invoked on the diagnostic properties.
	* @return Value of the property returned by the specified function.
	*/
	<T> Optional<T> diagnosticProperty(Function<List<DiagnosticProperty<?>>, Optional<T>> function);

Describe your task(s)

No response

Related area

-> Compilation

Related issue(s) (optional)

No response

Suggested label(s) (optional)

No response

Suggested assignee(s) (optional)

No response