Package com.siemens.polarion.rt.parsers.api

Interface RtParserDescriptor

public interface RtParserDescriptor
Implement this interface to add additional information related to the parser.
The implementation should then be contributed, together with RtParser using the extension point.
Since:
3.17.0

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    positionMessage(String positionValue)
    The "position" varies depending on the source file being parsed and the selected parser creating the resource traceability link.
    boolean
    providesTextFileLineNumber()
    Provides general information about the "position" generated by the selected parser.

  • Method Details

    • positionMessage

      @Nullable String positionMessage(@NotNull String positionValue)
      The "position" varies depending on the source file being parsed and the selected parser creating the resource traceability link.
      For example, for a custom parser for .ppt files, "position" could mean the slide number and would therefore require a different message label. This method provides such a message.
      Parameters:
      positionValue - the position value.
      Returns:
      the message for the position. The message will be rendered in html.

    • providesTextFileLineNumber

      boolean providesTextFileLineNumber()
      Provides general information about the "position" generated by the selected parser. (That by default, the position is parsed from a text file and represents the line number position within this file.)
      The method determines that "position" can be used as the URL's position parameter.
      Returns:
      true if the position provided by the given parser represents a line number in the text file. Otherwise false.