ErrorTextProvider.IFormattableItem (ph-commons 11.2.0 API)

All Known Implementing Classes:: ErrorTextProvider.FormattableItem

Enclosing class:: ErrorTextProvider

public static interface ErrorTextProvider.IFormattableItem

Base interface for objects that format a single field.

Author:: Philip Helger

Method Summary

Modifier and Type

Method

Description

ErrorTextProvider.EField

getField()

String

getFormattedText(String sReplacement)

Return a formatted version of getUnformattedText() by replacing all ErrorTextProvider.PLACEHOLDER chars with the provided replacement.

String

getUnformattedText()

Method Details
- getField
  
  @Nonnull ErrorTextProvider.EField getField()
  
  Returns:
  
  the error field this is about. Never null.
- getUnformattedText
  
  @Nonnull String getUnformattedText()
  
  Returns:
  
  The unformatted text. Never null.
- getFormattedText
  
  @Nonnull String getFormattedText(@Nonnull String sReplacement)
  
  Return a formatted version of getUnformattedText() by replacing all ErrorTextProvider.PLACEHOLDER chars with the provided replacement.
  
  Parameters:
  
  sReplacement - The replacement string. Must not be null.
  
  Returns:
  
  The formatted text with the replacement applied.