org.apache.lucene.analysis.pt

## Class RSLPStemmerBase.Rule

- java.lang.Object
- - org.apache.lucene.analysis.pt.RSLPStemmerBase.Rule

- Direct Known Subclasses:
    RSLPStemmerBase.RuleWithSetExceptions, RSLPStemmerBase.RuleWithSuffixExceptions
  Enclosing class:
    RSLPStemmerBase

      protected static class RSLPStemmerBase.Rule
      extends Object

  A basic rule, with no exceptions.

- - ### Field Summary

    Fields
    Modifier and Type | Field and Description
    --- | ---
    `protected int` | `min`
    `protected char[]` | `replacement`
    `protected char[]` | `suffix`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `Rule(String suffix, int min, String replacement)` Create a rule.

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `boolean` | `matches(char[] s, int len)`
    `int` | `replace(char[] s, int len)`

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

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

- - ### Field Detail

    - #### suffix

          protected final char[] suffix

    - #### replacement

          protected final char[] replacement

    - #### min

          protected final int min

  - ### Constructor Detail

    - #### Rule

          public Rule(String suffix,
                      int min,
                      String replacement)

      Create a rule.
      Parameters:
        `suffix` - suffix to remove
        `min` - minimum stem length
        `replacement` - replacement string

  - ### Method Detail

    - #### matches

          public boolean matches(char[] s,
                                 int len)

      Returns:
        true if the word matches this rule.

    - #### replace

          public int replace(char[] s,
                             int len)

      Returns:
        new valid length of the string after firing this rule.

Copyright © 2000-2021 Apache Software Foundation. All Rights Reserved.