Package net.sf.saxon.expr.number

## Class RegularGroupFormatter

- java.lang.Object
- - net.sf.saxon.expr.number.NumericGroupFormatter
  - - net.sf.saxon.expr.number.RegularGroupFormatter

-     public class RegularGroupFormatter
      extends NumericGroupFormatter

  A RegularGroupFormatter is a NumericGroupFormatter that inserts a separator at constant intervals through a number: for example, a comma after every three digits counting from the right.

- - ### Field Summary

    - ### Fields inherited from class net.sf.saxon.expr.number.NumericGroupFormatter

      `adjustedPicture`

  - ### Constructor Summary

    Constructors
    Constructor | Description
    --- | ---
    `RegularGroupFormatter​(int grpSize, java.lang.String grpSep, UnicodeString adjustedPicture)` | Create a RegularGroupFormatter

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method | Description
    --- | --- | ---
    `java.lang.String` | `format​(FastStringBuffer value)` | Reformat a number to add grouping separators
    `java.lang.String` | `getSeparator()` | Get the grouping separator to be used

    - ### Methods inherited from class net.sf.saxon.expr.number.NumericGroupFormatter

      `getAdjustedPicture`

    - ### Methods inherited from class java.lang.Object

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

- - ### Constructor Detail

    - #### RegularGroupFormatter

          public RegularGroupFormatter​(int grpSize,
                                       java.lang.String grpSep,
                                       UnicodeString adjustedPicture)

      Create a RegularGroupFormatter
      Parameters:
        `grpSize` - the grouping size. If zero, no grouping separators are inserted
        `grpSep` - the grouping separator (normally but not necessarily a single character)
        `adjustedPicture` - The picture, adjusted to conform to the rules of the xsl:number function, which means the picture supplied to format-integer minus any modifiers, and minus grouping separators and optional-digit signs

  - ### Method Detail

    - #### format

          public java.lang.String format​(FastStringBuffer value)

      Description copied from class: `NumericGroupFormatter`
      Reformat a number to add grouping separators
      Specified by:
        `format` in class `NumericGroupFormatter`
      Parameters:
        `value` - a buffer holding the number to be reformatted
      Returns:
        the reformatted number

    - #### getSeparator

          public java.lang.String getSeparator()

      Get the grouping separator to be used
      Specified by:
        `getSeparator` in class `NumericGroupFormatter`
      Returns:
        the grouping separator