Constructor Detail

• Yamls.YamlExtract

  public Yamls.YamlExtract()

Method Detail

• getEndOfPrevious

  public int getEndOfPrevious()

• getKey

  @Nullable
  public org.yaml.snakeyaml.nodes.Node getKey()

• getResult

  public org.yaml.snakeyaml.nodes.Node getResult()

• getStartOfThis

  public int getStartOfThis()

• getEndOfThis

  public int getEndOfThis()

• getStartOfNext

  public int getStartOfNext()

• getFullYamlTextOriginal

  public java.lang.String getFullYamlTextOriginal()

• getFullYamlTextWithExtractReplaced

  public java.lang.String getFullYamlTextWithExtractReplaced(java.lang.String replacement)

  Returns the original YAML with the found item replaced by the given replacement YAML.

  Parameters:

  replacement - YAML to put in for the found item; this YAML typically should not have any special indentation -- if required when replacing it will be inserted.

  if replacing an inline map entry, the supplied entry must follow the structure being replaced; for example, if replacing the value in key: value with a map, supplying a replacement subkey: value would result in invalid yaml; the replacement must be supplied with a newline, either before the subkey or after. (if unsure we believe it is always valid to include an initial newline or comment with newline.)

• withKeyIncluded

  public Yamls.YamlExtract withKeyIncluded(boolean includeKey)

  Specifies whether the key should be included in the found text, when calling getMatchedYamlText() or getFullYamlTextWithExtractReplaced(String), if the found item is a map entry. Defaults to false.

  Returns:

  this object, for use in a fluent constructions

• withPrecedingCommentsIncluded

  public Yamls.YamlExtract withPrecedingCommentsIncluded(boolean includePrecedingComments)

  Specifies whether comments preceding the found item should be included, when calling getMatchedYamlText() or getFullYamlTextWithExtractReplaced(String). This will not include comments which are indented further than the item, as those will typically be aligned with the previous item (whereas comments whose indentation is the same or less than the found item will typically be aligned with this item). Defaults to true.

  Returns:

  this object, for use in a fluent constructions

• withOriginalIndentation

  public Yamls.YamlExtract withOriginalIndentation(boolean includeOriginalIndentation)

  Specifies whether the original indentation should be preserved (and in the case of the first line, whether whitespace should be inserted so its start column is preserved), when calling getMatchedYamlText(). Defaults to false, the returned text will be outdented as far as possible.

  Returns:

  this object, for use in a fluent constructions

• getMatchedYamlTextOrWarn

  @Beta
  public java.lang.String getMatchedYamlTextOrWarn()

• getMatchedYamlText

  @Beta
  public java.lang.String getMatchedYamlText()

• getError

  public java.lang.Exception getError()

• toString

  public java.lang.String toString()

  Overrides:

  toString in class java.lang.Object